Skip to content

bugzilla
bugzilla
Commit ffb9c300 authored by barnboy%trilobyte.net's avatar barnboy%trilobyte.net
Browse files
Options

Fix for confusing language regarding protection of data/ & shadow/ directories

and localconfig file.
parent ad69284c
Show whitespace changes
Inline Side-by-side
Showing with 1111 additions and 956 deletions
docs/en/xml/administration.xml
View file @ ffb9c300
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<chapter id="administration">
<title>Administering Bugzilla</title> <!-- TOC
Chapter: Administration
<section id="parameters"> Localconfig and Checksetup.pl customizations
<title>Bugzilla Configuration</title> The Email Gateway
Editing parameters
<para>Bugzilla is configured by changing various parameters, accessed Deciding your site policies
from the "Edit parameters" link in the page footer. Here are The Shadow Database
some of the key parameters on that page. You should run down this Customizing password mail & layout
list and set them appropriately after installing Bugzilla.</para> The Whining Cron
Why you shouldn't allow deletion
<indexterm> User administration
<primary>checklist</primary> Creating Users
</indexterm> Disabling Users
User Permissions
<procedure> Product Administration
<step> Creating products
<para> Creating components
<command>maintainer</command>: Assigning default owners and Q/A contacts to components
The maintainer parameter is the email address of the person Product Milestones
responsible for maintaining this Product Versions
Bugzilla installation. The address need not be that of a valid Bugzilla Voting
account.</para> -->
</step>
<CHAPTER id="administration">
<step> <TITLE>Administering Bugzilla</TITLE>
<para> <SUBTITLE>Or, I just got this cool thing installed. Now what the heck do I do with it?</SUBTITLE>
<command>urlbase</command>:
This parameter defines the fully qualified domain name and web <PARA>
server path to your Bugzilla installation.</para> So you followed the README isntructions to the letter, and
just logged into bugzilla with your super-duper god account and you are sitting at the query
<para>For example, if your Bugzilla query page is screen. Yet, you have nothing to query. Your first act of business needs to be to setup the
<filename>http://www.foo.com/bugzilla/query.cgi</filename>, operating parameters for bugzilla.</PARA>
set your <quote>urlbase</quote>
to <filename>http://www.foo.com/bugzilla/</filename>.</para> <SECTION id="postinstall-check">
</step> <TITLE>Post-Installation Checklist</TITLE>
<PARA>
<step> After installation, follow the checklist below to ensure that
<para> you have a successful installation.
<command>makeproductgroups</command>: If you do not see a recommended setting for a parameter,
This dictates whether or not to automatically create groups consider leaving it at the default
when new products are created. while you perform your initial tests on your Bugzilla setup.
</para> </PARA>
</step> <INDEXTERM>
<PRIMARY>checklist</PRIMARY>
<step> </INDEXTERM>
<para> <PROCEDURE>
<command>useentrygroupdefault</command>: <STEP>
Bugzilla products can have a group associated with them, so that <PARA>
certain users can only see bugs in certain products. When this Bring up "editparams.cgi" in your web browser. For instance, to edit parameters
parameter is set to <quote>on</quote>, this at mozilla.org, the URL would be <ULINK URL="http://bugzilla.mozilla.org/editparams.cgi">
causes the initial group controls on newly created products http://bugzilla.mozilla.org/editparams.cgi</ULINK>, also available under the "edit parameters"
to place all newly-created bugs in the group link on your query page.
having the same name as the product immediately. </PARA>
After a product is initially created, the group controls </STEP>
can be further adjusted without interference by <STEP>
this mechanism.</para> <PARA>
</step> Set "maintainer" to <EMPHASIS>your</EMPHASIS> email address.
This allows Bugzilla's error messages
<step> to display your email
<para> address and allow people to contact you for help.
<command>shadowdb</command>: </PARA>
You run into an interesting problem when Bugzilla reaches a </STEP>
high level of continuous activity. MySQL supports only table-level <STEP>
write locking. What this means is that if someone needs to make a <PARA>
change to a bug, they will lock the entire table until the operation Set "urlbase" to the URL reference for your Bugzilla installation.
is complete. Locking for write also blocks reads until the write is If your bugzilla query page is at http://www.foo.com/bugzilla/query.cgi,
complete. Note that more recent versions of mysql support row level your url base is http://www.foo.com/bugzilla/
locking using different table types. These types are slower than the </PARA>
standard type, and Bugzilla does not yet take advantage of features </STEP>
such as transactions which would justify this speed decrease. The <STEP>
Bugzilla team are, however, happy to hear about any experiences with <PARA>
row level locking and Bugzilla.</para> Set "usebuggroups" to "1" <EMPHASIS>only</EMPHASIS>
if you need to restrict access to products.
<para>The <quote>shadowdb</quote> I suggest leaving this parameter <EMPHASIS>off</EMPHASIS>
parameter was designed to get around this limitation. While only a while initially testing your Bugzilla.
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. </STEP>
Although your database size will double, a shadow database can cause <STEP>
an enormous performance improvement when implemented on extremely <PARA>
high-traffic Bugzilla databases.</para> Set "usebuggroupsentry" to "1" if you want to restrict access to products.
Once again, if you are simply testing your installation, I suggest against
<para> turning this parameter on; the strict security checking may stop you from
As a guide, on reasonably old hardware, mozilla.org began needing being able to modify your new entries.
<quote>shadowdb</quote> </PARA>
when they reached around 40,000 Bugzilla users with several hundred </STEP>
Bugzilla bug changes and comments per day.</para> <STEP>
<PARA>
<para>The value of the parameter defines the name of the Set "shadowdb" to "bug_shadowdb" if you will be
shadow bug database. You will need to set the host and port settings running a *very* large installation of Bugzilla.
from the params page, and set up replication in your database server The shadow database enables many simultaneous users
so that updates reach this readonly mirror. Consult your database to read and write to the database
documentation for more detail.</para> without interfering with one another.
</step> <NOTE>
<PARA>
<step> Enabling "shadowdb" can adversely affect the stability
<para> of your installation of Bugzilla.
<command>shutdownhtml</command>: You may frequently need to manually synchronize your databases,
or schedule nightly syncs
If you need to shut down Bugzilla to perform administration, enter via "cron"
some descriptive HTML here and anyone who tries to use Bugzilla will </PARA>
receive a page to that effect. Obviously, editparams.cgi will </NOTE>
still be accessible so you can remove the HTML and re-enable Bugzilla. Once again, in testing you should
:-) avoid this option -- use it if or when you <EMPHASIS>need</EMPHASIS> to use it, and have
</para> repeatedly run into the problem it was designed to solve -- very long wait times while
</step> attempting to commit a change to the database.
</PARA>
<step> <PARA>
<para> If you use the "shadowdb" option,
<command>passwordmail</command>: it is only natural that you should turn the "queryagainstshadowdb"
option "On" as well. Otherwise you are replicating data into a shadow database for no reason!
Every time a user creates an account, the text of </PARA>
this parameter (with substitutions) is sent to the new user along with </STEP>
their password message.</para> <STEP>
<PARA>
<para>Add any text you wish to the "passwordmail" parameter box. For If you have custom logos or HTML you must put in place to fit within your site design guidelines,
instance, many people choose to use this box to give a quick training place the code in the "headerhtml", "footerhtml", "errorhtml",
blurb about how to use Bugzilla at your site.</para> "bannerhtml", or "blurbhtml" text boxes.
</step> <NOTE>
<PARA>
The "headerhtml" text box is the HTML printed out
<step> <EMPHASIS>before</EMPHASIS> any other code on the page.
<para> If you have a special banner, put the code for it in "bannerhtml".
<command>movebugs</command>: You may want to leave these
settings at the defaults initially.
This option is an undocumented feature to allow moving bugs </PARA>
between separate Bugzilla installations. You will need to understand </NOTE>
the source code in order to use this feature. Please consult </PARA>
<filename>movebugs.pl</filename> in your Bugzilla source tree for </STEP>
further documentation, such as it is. <STEP>
</para> <PARA>
</step> Add any text you wish to the "passwordmail" parameter box. For instance,
many people choose to use this box to give a quick training blurb about how to
<step> use Bugzilla at your site.
<para> </PARA>
<command>useqacontact</command>: </STEP>
<STEP>
This allows you to define an email address for each component, in <PARA>
addition Ensure "newemailtech" is "on".
to that of the default owner, who will be sent carbon copies of Your users will thank you. This is the default in the post-2.12 world, and is
incoming bugs.</para> only an issue if you are upgrading.
</step> </PARA>
<step> </STEP>
<para> <STEP>
<command>usestatuswhiteboard</command>: <PARA>
This defines whether you wish to have a free-form, overwritable field Do you want to use the qa contact ("useqacontact")
associated with each bug. The advantage of the Status Whiteboard is and status whiteboard ("usestatuswhiteboard") fields?
that it can be deleted or modified with ease, and provides an These fields are useful because they allow for more flexibility,
easily-searchable field for indexing some bugs that have some trait particularly when you have an existing
in common. Quality Assurance and/or Release Engineering team,
</para> but they may not be needed for smaller installations.
</step> </PARA>
</STEP>
<step> <STEP>
<para> <PARA>
<command>whinedays</command>: Set "whinedays" to the amount of days you want to let bugs go
Set this to the number of days you want to let bugs go in the "New" or "Reopened" state before
in the NEW or REOPENED state before notifying people they have notifying people they have untouched new bugs. If you do not plan to use this feature, simply do
untouched new bugs. If you do not plan to use this feature, simply do not set up the whining cron job described in the README, or set this value to "0".
not set up the whining cron job described in the installation </PARA>
instructions, or set this value to "0" (never whine).</para> </STEP>
</step> <STEP>
<PARA>
<step> Set the "commenton" options according to your site policy.
<para> It is a wise idea to require comments when users
<command>commenton*</command>: resolve, reassign, or reopen bugs.
All these <NOTE>
fields allow you to dictate what changes can pass without comment, <PARA>
and which must have a comment from the person who changed them. It is generally far better to require a developer comment when resolving bugs than not.
Often, administrators will allow users to add themselves to the CC Few things are more annoying to bug database users than having a developer
list, accept bugs, or change the Status Whiteboard without adding a mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!)
comment as to their reasons for the change, yet require that most </PARA>
other changes come with an explanation.</para> </NOTE>
</PARA>
<para>Set the "commenton" options according to your site policy. It </STEP>
is a wise idea to require comments when users resolve, reassign, or <STEP>
reopen bugs at the very least. <PARA>
<note> Set "supportwatchers" to "On". This feature is helpful for team leads to monitor progress in their
<para>It is generally far better to require a developer comment respective areas, and can offer many other benefits, such as allowing a developer to pick up a
when resolving bugs than not. Few things are more annoying to bug former engineer's bugs without requiring her to change all the information in the bug.
database users than having a developer mark a bug "fixed" without </PARA>
any comment as to what the fix was (or even that it was truly </STEP>
fixed!)</para> </PROCEDURE>
</note> </SECTION>
</para>
</step> <SECTION id="useradmin">
<TITLE>User Administration</TITLE>
<step> <PARA>
<para> User administration is one of the easiest parts of Bugzilla.
<command>supportwatchers</command>: Keeping it from getting out of hand, however, can become a challenge.
</PARA>
Turning on this option allows users to ask to receive copies of
all a particular other user's bug email. This is, of <SECTION id="defaultuser">
course, subject to the groupset restrictions on the bug; if the <TITLE>Creating the Default User</TITLE>
<quote>watcher</quote>
would not normally be allowed to view a bug, the watcher cannot get <PARA>
around the system by setting herself up to watch the bugs of someone When you first run checksetup.pl after installing Bugzilla, it will prompt you
with bugs outside her privileges. They would still only receive email for the administrative username (email address) and password for this "super user".
updates for those bugs she could normally view.</para> If for some reason you were to delete the "super user" account, re-running
</step> checksetup.pl will again prompt you for this username and password.
</procedure> </PARA>
</section> <TIP>
<PARA>
<section id="useradmin"> If you wish to add more administrative users, you must use the MySQL interface.
<title>User Administration</title> Run "mysql" from the command line, and use these commands ("mysql>" denotes the
mysql prompt, not something you should type in):
<section id="defaultuser"> <COMMAND><PROMPT>mysql></PROMPT> use bugs;</COMMAND>
<title>Creating the Default User</title> <COMMAND><PROMPT>mysql></PROMPT> update profiles set groupset=0x7ffffffffffffff
where login_name = "(user's login name)"; </COMMAND>
<para>When you first run checksetup.pl after installing Bugzilla, it </PARA>
will prompt you for the administrative username (email address) and </TIP>
password for this "super user". If for some reason you delete </SECTION>
the "super user" account, re-running checksetup.pl will again prompt
you for this username and password.</para> <SECTION id="manageusers">
<TITLE>Managing Other Users</TITLE>
<tip>
<para>If you wish to add more administrative users, add them to <SECTION id="login">
the "admin" group and, optionally, add edit the tweakparams, editusers, <TITLE>Logging In</TITLE>
creategroups, editcomponents, and editkeywords groups to add the <ORDEREDLIST>
entire admin group to those groups. <LISTITEM>
</para> <PARA>
</tip> Open the index.html page for your Bugzilla installation in your browser window.
</section> </PARA>
</LISTITEM>
<section id="manageusers"> <LISTITEM>
<title>Managing Other Users</title> <PARA>
Click the "Query Existing Bug Reports" link.
<section id="createnewusers"> </PARA>
<title>Creating new users</title> </LISTITEM>
<LISTITEM>
<para>Your users can create their own user accounts by clicking the <PARA>
"New Account" link at the bottom of each page (assuming they Click the "Log In" link at the foot of the page.
aren't logged in as someone else already.) However, should you </PARA>
desire to create user accounts ahead of time, here is how you do </LISTITEM>
it.</para> <LISTITEM>
<PARA>
<orderedlist> Type your email address, and the password which was emailed to you when you
<listitem> created your Bugzilla account, into the spaces provided.
<para>After logging in, click the "Users" link at the footer of </PARA>
the query page, and then click "Add a new user".</para> </LISTITEM>
</listitem> </ORDEREDLIST>
<PARA>Congratulations, you are logged in!</PARA>
<listitem> </SECTION>
<para>Fill out the form presented. This page is self-explanatory.
When done, click "Submit".</para> <SECTION id="createnewusers">
<TITLE>Creating new users</TITLE>
<note> <PARA>
<para>Adding a user this way will Your users can create their own user accounts by clicking the "New Account"
<emphasis>not</emphasis> link at the bottom of each page.
However, should you desire to create user accounts ahead of time, here is how you do it.
send an email informing them of their username and password. </PARA>
While useful for creating dummy accounts (watchers which <ORDEREDLIST>
shuttle mail to another system, for instance, or email <LISTITEM>
addresses which are a mailing list), in general it is <PARA>
preferable to log out and use the After logging in, click the "Users" link at the footer of the query page.
<quote>New Account</quote> </PARA>
</LISTITEM>
button to create users, as it will pre-populate all the <LISTITEM>
required fields and also notify the user of her account name <PARA>
and password.</para> To see a specific user, type a portion of their login name
</note> in the box provided and click "submit".
</listitem> To see all users, simply click the "submit" button.
</orderedlist> You must click "submit" here to be able to add a new user.
</section> </PARA>
<TIP>
<section id="modifyusers"> <PARA>
<title>Modifying Users</title> More functionality is available via the list on the right-hand side
of the text entry box.
<para>To see a specific user, search for their login name You can match what you type as a case-insensitive substring (the default)
in the box provided on the "Edit Users" page. To see all users, of all users on your system, a case-sensitive regular expression
leave the box blank.</para> (please see the "man regexp" manual page for details on regular expression syntax),
or a <EMPHASIS>reverse</EMPHASIS> regular expression match,
<para>You can search in different ways the listbox to the right where every user name which does NOT match the regular expression
of the text entry box. You can match by is selected.
case-insensitive substring (the default), </PARA>
regular expression, or a </TIP>
<emphasis>reverse</emphasis> </LISTITEM>
regular expression match, which finds every user name which does NOT <LISTITEM>
match the regular expression. (Please see <PARA>
the <command>man regexp</command> Click the "Add New User" link at the bottom of the user list
manual page for details on regular expression syntax.) </PARA>
</para> </LISTITEM>
<LISTITEM>
<para>Once you have found your user, you can change the following <PARA>
fields:</para> Fill out the form presented. This page is self-explanatory. When done, click "submit".
</PARA>
<itemizedlist> <NOTE>
<listitem> <PARA>
<para> Adding a user this way will <EMPHASIS>not</EMPHASIS> send an email
<emphasis>Login Name</emphasis>: informing them of their username and password.
This is generally the user's full email address. However, if you In general, it is preferable to log out and use the "New Account"
have are using the emailsuffix Param, this may just be the user's button to create users, as it will pre-populate all the required fields and also notify
login name. Note that users can now change their login names the user of her account name and password.
themselves (to any valid email address.) </PARA>
</para> </NOTE>
</listitem> </LISTITEM>
</ORDEREDLIST>
<listitem> </SECTION>
<para>
<emphasis>Real Name</emphasis>: The user's real name. Note that <SECTION id="disableusers">
Bugzilla does not require this to create an account.</para> <TITLE>Disabling Users</TITLE>
</listitem> <PARA>
I bet you noticed that big "Disabled Text" entry box available from the "Add New User" screen,
<listitem> when you edit an account?
<para> By entering any text in this box and selecting "submit",
<emphasis>Password</emphasis>: you have prevented the user from using Bugzilla via the web interface.
You can change the user's password here. Users can automatically Your explanation, written in this text box, will be presented to the user
request a new password, so you shouldn't need to do this often. the next time she attempts to use the system.
If you want to disable an account, see Disable Text below. <WARNING>
</para> <PARA>
</listitem> Don't disable your own administrative account, or you will hate life!
</PARA>
<listitem> </WARNING>
<para> </PARA>
<emphasis>Disable Text</emphasis>: </SECTION>
If you type anything in this box, including just a space, the
user is prevented from logging in, or making any changes to <SECTION id="modifyusers">
bugs via the web interface. <TITLE>Modifying Users</TITLE>
The HTML you type in this box is presented to the user when <PARA>
they attempt to perform these actions, and should explain Here I will attempt to describe the function of each option on the user edit screen.
why the account was disabled. </PARA>
<warning> <ITEMIZEDLIST>
<para>Don't disable all the administrator accounts!</para> <LISTITEM>
</warning> <PARA>
<EMPHASIS>Login Name</EMPHASIS>: This is generally the user's email address.
<note> However, if you have edited your system parameters,
<para>The user can still submit bugs via this may just be the user's login name or some other identifier.
the e-mail gateway, if you set it up, even if the disabled text <TIP>
field is filled in. The e-mail gateway should <PARA>
<emphasis>not</emphasis> For compatability reasons, you should probably
be enabled for secure installations of Bugzilla.</para> stick with email addresses as user login names. It will make your life easier.
</note> </PARA>
</para> </TIP>
</listitem> </PARA>
</LISTITEM>
<listitem> <LISTITEM>
<para> <PARA>
<emphasis>&lt;groupname&gt;</emphasis>: <EMPHASIS>Real Name</EMPHASIS>: Duh!
If you have created some groups, e.g. "securitysensitive", then </PARA>
checkboxes will appear here to allow you to add users to, or </LISTITEM>
remove them from, these groups. <LISTITEM>
</para> <PARA>
</listitem> <EMPHASIS>Password</EMPHASIS>: You will only see asterisks in versions
of Bugzilla newer than 2.10 or early 2.11. You can change the user password here.
<listitem> </PARA>
<para> </LISTITEM>
<emphasis>canconfirm</emphasis>: <LISTITEM>
This field is only used if you have enabled the "unconfirmed" <PARA>
status. If you enable this for a user, <EMPHASIS>Email Notification</EMPHASIS>: You may choose from one of three options:
that user can then move bugs from "Unconfirmed" to a "Confirmed" <ORDEREDLIST>
status (e.g.: "New" status).</para> <LISTITEM>
</listitem> <PARA>
All qualifying bugs except those which I change:
<listitem> The user will be notified of any change to any bug
<para> for which she is the reporter, assignee, Q/A contact, CC recipient, or "watcher".
<emphasis>creategroups</emphasis>: </PARA>
This option will allow a user to create and destroy groups in </LISTITEM>
Bugzilla.</para> <LISTITEM>
</listitem> <PARA>
Only those bugs which I am listed on the CC line:
<listitem> The user will not be notified of changes to bugs where she is the assignee,
<para> reporter, or Q/A contact, but will receive them if she is on the CC list.
<emphasis>editbugs</emphasis>: <NOTE>
Unless a user has this bit set, they can only edit those bugs <PARA>
for which they are the assignee or the reporter. Even if this She will still receive whining cron emails if you set up the "whinemail" feature.
option is unchecked, users can still add comments to bugs. </PARA>
</para> </NOTE>
</listitem> </PARA>
</LISTITEM>
<listitem> <LISTITEM>
<para> <PARA>
<emphasis>editcomponents</emphasis>: <EMPHASIS>All Qualifying Bugs</EMPHASIS>: This user is a glutton for punishment.
This flag allows a user to create new products and components, If her name is in the reporter, Q/A contact, CC, assignee, or is a "watcher",
as well as modify and destroy those that have no bugs associated she will get email updates regarding the bug.
with them. If a product or component has bugs associated with it, </PARA>
those bugs must be moved to a different product or component </LISTITEM>
before Bugzilla will allow them to be destroyed. </ORDEREDLIST>
</para> </PARA>
</listitem> <PARA>
<EMPHASIS>Disable Text</EMPHASIS>: If you type anything in this box,
<listitem> including just a space, the user account is disabled from making any changes
<para> to bugs via the web interface, and what you type in this box is presented as the reason.
<emphasis>editkeywords</emphasis>: <WARNING>
If you use Bugzilla's keyword functionality, enabling this <PARA>Don't disable the administrator account!</PARA>
feature allows a user to create and destroy keywords. As always, </WARNING>
the keywords for existing bugs containing the keyword the user <NOTE>
wishes to destroy must be changed before Bugzilla will allow it <PARA>
to die.</para> As of this writing, the user can still submit bugs via the e-mail gateway,
</listitem> if you set it up, despite the disabled text field. The e-mail gateway should
<EMPHASIS>not</EMPHASIS> be enabled for secure installations of Bugzilla.
<listitem> </PARA>
<para> </NOTE>
<emphasis>editusers</emphasis>: </PARA>
This flag allows a user to do what you're doing right now: edit </LISTITEM>
other users. This will allow those with the right to do so to <LISTITEM>
remove administrator privileges from other users or grant them to <PARA>
themselves. Enable with care.</para> <EMPHASIS>CanConfirm</EMPHASIS>: This field is only used if you have enabled
</listitem> "unconfirmed" status in your parameters screen. If you enable this for a user,
that user can then move bugs from "Unconfirmed" to "Confirmed" status (ergo: "New" status).
Be judicious about allowing users to turn this bit on for other users.
<listitem> </PARA>
<para> </LISTITEM>
<emphasis>tweakparams</emphasis>: <LISTITEM>
This flag allows a user to change Bugzilla's Params <PARA>
(using <filename>editparams.cgi</filename>.)</para> <EMPHASIS>Creategroups</EMPHASIS>: This option will allow a user to create and
</listitem> destroy groups in Bugzilla. Unless you are using the Bugzilla GroupSentry security
option "usebuggroupsentry" in your parameters, this setting has no effect.
<listitem> </PARA>
<para> </LISTITEM>
<emphasis>&lt;productname&gt;</emphasis>: <LISTITEM>
This allows an administrator to specify the products in which <PARA>
a user can see bugs. The user must still have the <EMPHASIS>Editbugs</EMPHASIS>: Unless a user has this bit set, they can only edit
"editbugs" privilege to edit bugs in these products.</para> those bugs for which they are the assignee or the reporter.
</listitem> <NOTE>
</itemizedlist> <PARA>
</section> Leaving this option unchecked does not prevent users from adding
</section> comments to a bug! They simply cannot change a bug priority, severity,
</section> etc. unless they are the assignee or reporter.
</PARA>
<section id="products"> </NOTE>
<title>Products</title> </PARA>
</LISTITEM>
<para> <LISTITEM>
<glossterm linkend="gloss-product" baseform="product"> <PARA>
Products</glossterm> <EMPHASIS>Editcomponents</EMPHASIS>: This flag allows a user to create new
products and components, as well as modify and destroy those that have no bugs
are the broadest category in Bugzilla, and tend to represent real-world associated with them. If a product or component has bugs associated with it,
shipping products. E.g. if your company makes computer games, those bugs must be moved to a different product or component before Bugzilla
you should have one product per game, perhaps a "Common" product for will allow them to be destroyed. The name of a product or component can be
units of technology used in multiple games, and maybe a few special changed without affecting the associated bugs, but it tends to annoy
products (Website, Administration...)</para> the hell out of your users when these change a lot.
</PARA>
<para>Many of Bugzilla's settings are configurable on a per-product </LISTITEM>
basis. The number of "votes" available to users is set per-product, <LISTITEM>
as is the number of votes <PARA>
required to move a bug automatically from the UNCONFIRMED status to the <EMPHASIS>Editkeywords</EMPHASIS>: If you use Bugzilla's keyword functionality,
NEW status.</para> enabling this feature allows a user can create and destroy keywords.
As always, the keywords for existing bugs containing the keyword
<para>To create a new product:</para> the user wishes to destroy must be changed before Bugzilla will allow it to die.
You must be very careful about creating too many new keywords
<orderedlist> if you run a very large Bugzilla installation; keywords are global variables
<listitem> across products, and you can often run into a phenomenon called "keyword bloat".
<para>Select "products" from the footer</para> This confuses users, and then the feature goes unused.
</PARA>
</listitem> </LISTITEM>
<LISTITEM>
<listitem> <PARA>
<para>Select the "Add" link in the bottom right</para> <EMPHASIS>Editusers</EMPHASIS>: This flag allows a user do what you're doing
</listitem> right now: edit other users.
This will allow those with the right to do so to remove administrator
<listitem> priveleges from other users or grant them to themselves. Enable with care.
<para>Enter the name of the product and a description. The </PARA>
Description field may contain HTML.</para> </LISTITEM>
</listitem> <LISTITEM>
</orderedlist> <PARA>
<EMPHASIS>PRODUCT</EMPHASIS>: PRODUCT bugs access. This allows an administrator,
<para>Don't worry about the "Closed for bug entry", "Maximum Votes with product-level granularity, to specify in which products a user can edit bugs.
per person", "Maximum votes a person can put on a single bug", The user must still have the "editbugs" privelege to edit bugs in this area;
"Number of votes a bug in this Product needs to automatically get out this simply restricts them from even seeing bugs outside these boundaries if the administrator
of the UNCOMFIRMED state", and "Version" options yet. We'll cover has enabled the group sentry parameter "usebuggroupsentry". Unless you are using bug groups,
those in a few moments. this option has no effect.
</para> </PARA>
</section> </LISTITEM>
</ITEMIZEDLIST>
<section id="components"> </SECTION>
<title>Components</title> </SECTION>
</SECTION>
<para>Components are subsections of a Product. E.g. the computer game
you are designing may have a "UI" <SECTION id="programadmin">
component, an "API" component, a "Sound System" component, and a <TITLE>Product, Component, Milestone, and Version Administration</TITLE>
"Plugins" component, each overseen by a different programmer. It <EPIGRAPH>
often makes sense to divide Components in Bugzilla according to the <PARA>
natural divisions of responsibility within your Product or Dear Lord, we have to get our users to do WHAT?
company.</para> </PARA>
</EPIGRAPH>
<para>
Each component has a owner and (if you turned it on in the parameters), <SECTION id="products">
a QA Contact. The owner should be the primary person who fixes bugs in <TITLE>Products</TITLE>
that component. The QA Contact should be the person who will ensure <SUBTITLE>Formerly, and in some spots still, called "Programs"</SUBTITLE>
these bugs are completely fixed. The Owner, QA Contact, and Reporter <PARA>
will get email when new bugs are created in this Component and when <GLOSSTERM baseform="product" linkend="gloss_product">Products</GLOSSTERM> are the
these bugs change. Default Owner and Default QA Contact fields only broadest category in Bugzilla, and you should have the least of these.
dictate the If your company makes computer games, you should have one product per game,
<emphasis>default assignments</emphasis>; and possibly a few special products
these can be changed on bug submission, or at any later point in (website, meetings...)
a bug's life.</para> </PARA>
<PARA>
<para>To create a new Component:</para> A Product (formerly called "Program", and still referred to that way
in some portions of the source code) controls some very important functions.
<orderedlist> The number of "votes" available for users to vote for the most important bugs
<listitem> is set per-product, as is the number of votes required to move a bug automatically
<para>Select the "Edit components" link from the "Edit product" from the UNCONFIRMED status to the NEW status. One can close a Product for further
page</para> bug entry and define various Versions available from the Edit Product screen.
</listitem> </PARA>
<PARA>To create a new product:</PARA>
<listitem> <ORDEREDLIST>
<para>Select the "Add" link in the bottom right.</para> <LISTITEM>
</listitem> <PARA>
Select "components" from the yellow footer
<listitem> </PARA>
<para>Fill out the "Component" field, a short "Description", <TIP>
the "Initial Owner" and "Initial QA Contact" (if enabled.) <PARA>
The Component and Description fields may contain HTML; It may seem counterintuitive to click "components" when you want
the "Initial Owner" field must be a login name to edit the properties associated with Products. This is one of a long
already existing in the database. list of things we want in Bugzilla 3.0...
</para> </PARA>
</listitem> </TIP>
</orderedlist> </LISTITEM>
</section> <LISTITEM>
<PARA>
<section id="versions"> Select the "Add" link to the right of "Add a new product".
<title>Versions</title> </PARA>
</LISTITEM>
<para>Versions are the revisions of the product, such as "Flinders <LISTITEM>
3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select <PARA>
field; the usual practice is to select the earliest version known to have Enter the name of the product and a description.
the bug. The Description field is free-form.
</para> </PARA>
</LISTITEM>
<para>To create and edit Versions:</para> </ORDEREDLIST>
<TIP>
<orderedlist> <PARA>
<listitem> Don't worry about the "Closed for bug entry", "Maximum Votes per person",
<para>From the "Edit product" screen, select "Edit Versions"</para> "Maximum votes a person can put on a single bug", "Number of votes a bug in
</listitem> this Product needs to automatically get out of the UNCOMFIRMED state",
and "Version" options yet.
<listitem> We'll cover those in a few moments.
<para>You will notice that the product already has the default </PARA>
version "undefined". Click the "Add" link in the bottom right.</para> </TIP>
</listitem> </SECTION>
<listitem> <SECTION id="components">
<para>Enter the name of the Version. This field takes text only. <TITLE>Components</TITLE>
Then click the "Add" button.</para> <PARA>
</listitem> Components are subsections of a Product.
</orderedlist> <EXAMPLE>
</section> <TITLE>Creating some Components</TITLE>
<INFORMALEXAMPLE>
<section id="milestones"> <PARA>
<title>Milestones</title> The computer game you are designing may a "UI" component, an "API" component,
a "Sound System" component, and a "Plugins" component, each overseen by a different
<para>Milestones are "targets" that you plan to get a bug fixed by. For programmer. It often makes sense to divide Components in Bugzilla according to the
example, you have a bug that you plan to fix for your 3.0 release, it natural divisions of responsibility within your Product or company.
would be assigned the milestone of 3.0.</para> </PARA>
</INFORMALEXAMPLE>
<note> </EXAMPLE>
<para>Milestone options will only appear for a Product if you turned
on the "usetargetmilestone" Param in the "Edit Parameters" screen. Each component has a owner and (if you turned it on in the parameters), a qa
</para> contact. The owner should be the primary person who fixes bugs in that component. The QA
</note> Contact should be the person who will ensure these bugs are completely fixed. The Owner,
QA Contact, and Reporter will get email when new bugs are created in this Component and
<para>To create new Milestones, set Default Milestones, and set when these bugs change. Default Owner and Default QA Contact fields only dictate the
Milestone URL:</para> <EMPHASIS>default assignments</EMPHASIS>; the Owner and Q/A Contact fields in a bug
are otherwise unrelated to the Component.
<orderedlist> </PARA>
<listitem>
<para>Select "Edit milestones" from the "Edit product" page.</para> <PARA>
</listitem> To create a new Component:
</PARA>
<listitem> <ORDEREDLIST>
<para>Select "Add" in the bottom right corner. <LISTITEM>
text</para> <PARA>
</listitem> Select the "Edit components" link from the "Edit Product" page
</PARA>
<listitem> </LISTITEM>
<para>Enter the name of the Milestone in the "Milestone" field. You <LISTITEM>
can optionally set the "sortkey", which is a positive or negative <PARA>
number (-255 to 255) that defines where in the list this particular Select the "Add" link to the right of the "Add a new component" text
milestone appears. This is because milestones often do not on the "Select Component" page.
occur in alphanumeric order For example, "Future" might be </PARA>
after "Release 1.2". Select "Add".</para> </LISTITEM>
</listitem> <LISTITEM>
<PARA>
<listitem> Fill out the "Component" field, a short "Description", and the "Initial Owner".
<para>From the Edit product screen, you can enter the URL of a The "Component" field should not contain a space. The "Description" field is
page which gives information about your milestones and what free-form. The "Initial Owner" field must be that of a valid user already
they mean. </para> existing in the database. If the initial owner does not exist, Bugzilla
</listitem> will refuse to create the component.
</orderedlist> <TIP>
</section> <PARA>
Is your "Default Owner" a user who is not yet in the database?
<section id="voting"> No problem.
<title>Voting</title> <ORDEREDLIST>
<LISTITEM>
<para>Voting allows users to be given a pot of votes which they can allocate <PARA>
to bugs, to indicate that they'd like them fixed. Select the "Log out" link on the footer of the page.
This allows developers to gauge </PARA>
user need for a particular enhancement or bugfix. By allowing bugs with </LISTITEM>
a certain number of votes to automatically move from "UNCONFIRMED" to <LISTITEM>
"NEW", users of the bug system can help high-priority bugs garner <PARA>
attention so they don't sit for a long time awaiting triage.</para> Select the "New Account" link on the footer of the "Relogin" page
</PARA>
<para>To modify Voting settings:</para> </LISTITEM>
<LISTITEM>
<orderedlist> <PARA>
<listitem> Type in the email address of the default owner you want to create
<para>Navigate to the "Edit product" screen for the Product you in the "E-mail address" field, and her full name in the "Real name"
wish to modify</para> field, then select the "Submit Query" button.
</listitem> </PARA>
</LISTITEM>
<listitem> <LISTITEM>
<para><emphasis>Maximum Votes per person</emphasis>: <PARA>
Setting this field to "0" disables voting.</para> Now select "Log in" again, type in your login information, and you
</listitem> can modify the product to use the Default Owner information
you require.
<listitem> </PARA>
<para><emphasis>Maximum Votes a person can put on a single </LISTITEM>
bug</emphasis>: </ORDEREDLIST>
It should probably be some number lower than the </PARA>
"Maximum votes per person". Don't set this field to "0" if </TIP>
"Maximum votes per person" is non-zero; that doesn't make </PARA>
any sense.</para> </LISTITEM>
</listitem> <LISTITEM>
<PARA>
<listitem> Either "edit" more components or return to the "query" page on the ensuing
<para><emphasis>Number of votes a bug in this product needs to "Addming new component" page. To return to the Product you were editing, you
automatically get out of the UNCONFIRMED state</emphasis>: must select the "components" link as before.
Setting this field to "0" disables the automatic move of </PARA>
bugs from UNCONFIRMED to NEW. </LISTITEM>
</para> </ORDEREDLIST>
</listitem> </SECTION>
<listitem> <SECTION id="versions">
<para>Once you have adjusted the values to your preference, click <TITLE>Versions</TITLE>
"Update".</para> <PARA>
</listitem> Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95",
</orderedlist> and "Flinders 2000". Using Versions helps you isolate code changes and are an aid
</section> in reporting.
<section id="groups"> <EXAMPLE>
<title>Groups and Group Security</title> <TITLE>Common Use of Versions</TITLE>
<INFORMALEXAMPLE>
<para>Groups allow the administrator <PARA>
to isolate bugs or products that should only be seen by certain people. A user reports a bug
The association between products and groups is controlled from against Version "Beta 2.0" of your product. The current Version of your software
the product edit page under <quote>Edit Group Controls.</quote> is "Release Candidate 1", and no longer has the bug. This will
</para> help you triage and classify bugs according to their relevance. It is also
possible people may report bugs against bleeding-edge beta versions that are
<para> not evident in older versions of the software. This can help isolate code
If the makeproductgroups param is on, a new group will be automatically changes that caused the bug
created for every new product. </PARA>
</para> </INFORMALEXAMPLE>
</EXAMPLE>
<para> <EXAMPLE>
On the product edit page, there is a page to edit the <TITLE>A Different Use of Versions</TITLE>
<quote>Group Controls</quote> <INFORMALEXAMPLE>
for a product and determine which groups are applicable, default, <PARA>
and mandatory for each product as well as controlling entry This field has been used to good effect by an online service provider in a slightly
for each product and being able to set bugs in a product to be different way. They had three versions of the product: "Production", "QA",
totally read-only unless some group restrictions are met. and "Dev". Although it may be the same product, a bug in the development
</para> environment is not normally as critical as a Production bug, nor does it
need to be reported publicly. When used in conjunction with Target Milestones,
<para> one can easily specify the environment where a bug can be reproduced, and
For each group, it is possible to specify if membership in that the Milestone by which it will be fixed.
group is... </PARA>
</para> </INFORMALEXAMPLE>
<orderedlist> </EXAMPLE>
<listitem> </PARA>
<para> <PARA>
required for bug entry, To create and edit Versions:
</para> </PARA>
</listitem> <ORDEREDLIST>
<listitem> <LISTITEM>
<para> <PARA>
Not applicable to this product(NA), From the "Edit Product" screen, select "Edit Versions"
a possible restriction for a member of the </PARA>
group to place on a bug in this product(Shown), </LISTITEM>
a default restriction for a member of the <LISTITEM>
group to place on a bug in this product(Default), <PARA>
or a mandatory restriction to be placed on bugs You will notice that the product already has the default version "undefined".
in this product(Mandatory). If your product doesn't use version numbers, you may want to leave this as it is
</para> or edit it so that it is "---". You can then go back to the edit versions page
</listitem> and add new versions to your product.
<listitem> </PARA>
<para> <PARA>
Not applicable by non-members to this product(NA), Otherwise, click the "Add" button to the right of the "Add a new version" text.
a possible restriction for a non-member of the </PARA>
group to place on a bug in this product(Shown), </LISTITEM>
a default restriction for a non-member of the <LISTITEM>
group to place on a bug in this product(Default), <PARA>
or a mandatory restriction to be placed on bugs Enter the name of the Version. This can be free-form characters up to the limit of the
in this product when entered by a non-member(Mandatory). text box. Then select the "Add" button.
</para> </PARA>
</listitem> </LISTITEM>
<listitem> <LISTITEM>
<para> <PARA>
required in order to make <emphasis>any</emphasis> change At this point you can select "Edit" to edit more Versions, or return to the "Query"
to bugs in this product <emphasis>including comments.</emphasis> page, from which you can navigate back to the product through the "components" link
</para> at the foot of the Query page.
</listitem> </PARA>
</orderedlist> </LISTITEM>
</ORDEREDLIST>
<para>To create Groups:</para> </SECTION>
<orderedlist> <SECTION id="milestones">
<listitem> <TITLE>Milestones</TITLE>
<para>Select the <quote>groups</quote> <PARA>
link in the footer.</para> Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that
</listitem> you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Or, you have a
bug that you plan to fix for 2.8, this would have a milestone of 2.8.
<listitem> </PARA>
<para>Take a moment to understand the instructions on the <quote>Edit <NOTE>
Groups</quote> screen, then select the <quote>Add Group</quote> link.</para> <PARA>
</listitem> Milestone options will only appear for a Product if you turned the "usetargetmilestone" field
in the "Edit Parameters" screen "On".
<listitem> </PARA>
<para>Fill out the <quote>Group</quote>, <quote>Description</quote>, </NOTE>
and <quote>User RegExp</quote> fields. <PARA>
<quote>User RegExp</quote> allows you to automatically To create new Milestones, set Default Milestones, and set Milestone URL:
place all users who fulfill the Regular Expression into the new group. </PARA>
When you have finished, click <quote>Add</quote>.</para> <ORDEREDLIST>
<warning> <LISTITEM>
<para>If specifying a domain in the regexp, make sure you end <PARA>
the regexp with a $. Otherwise, when granting access to Select "edit milestones"
"@mycompany\.com", you will allow access to </PARA>
'badperson@mycompany.com.cracker.net'. You need to use </LISTITEM>
'@mycompany\.com$' as the regexp.</para> <LISTITEM>
</warning> <PARA>
</listitem> Select "Add" to the right of the "Add a new milestone" text
<listitem> </PARA>
<para>After you add your new group, edit the new group. On the </LISTITEM>
edit page, you can specify other groups that should be included <LISTITEM>
in this group and which groups should be permitted to add and delete <PARA>
users from this group.</para> Enter the name of the Milestone in the "Milestone" field.
</listitem> You can optionally set the "Sortkey", which is a positive or negative number (-255 to 255)
</orderedlist> that defines where in the list this particular milestone appears.
Select "Add".
<para> </PARA>
Note that group permissions are such that you need to be a member <EXAMPLE>
of <emphasis>all</emphasis> the groups a bug is in, for whatever <TITLE>Using SortKey with Target Milestone</TITLE>
reason, to see that bug. Similarly, you must be a member <INFORMALEXAMPLE>
of <emphasis>all</emphasis> of the entry groups for a product <PARA>
to add bugs to a product and you must be a member Let's say you create a target milestone called "Release 1.0", with Sortkey set to "0".
of <emphasis>all</emphasis> of the canedit groups for a product Later, you realize that you will have a public beta, called "Beta1".
in order to make <emphasis>any</emphasis> change to bugs in that You can create a Milestone called "Beta1", with a Sortkey of "-1" in order to ensure
product. people will see the Target Milestone of "Beta1" earlier on the list than "Release 1.0"
</para> </PARA>
</section> </INFORMALEXAMPLE>
</EXAMPLE>
<section id="upgrading"> </LISTITEM>
<title>Upgrading to New Releases</title> <LISTITEM>
<PARA>
<warning> If you want to add more milestones, select the "Edit" link.
<para>Upgrading is a one-way process. You should backup your database If you don't, well shoot, you have to go back to the "query" page and select "components"
and current Bugzilla directory before attempting the upgrade. If you wish again, and make your way back to the Product you were editing.
to revert to the old Bugzilla version for any reason, you will have to <NOTE>
restore from these backups. <PARA>
</para> This is another in the list of unusual user interface decisions that
</warning> we'd like to get cleaned up. Shouldn't there be a link to the effect of
"edit the Product I was editing when I ended up here"? In any case,
<para>Upgrading Bugzilla is something we all want to do from time to time, clicking "components" in the footer takes you back to the "Select product"
be it to get new features or pick up the latest security fix. How easy screen, from which you can begin editing your product again.
it is to update depends on a few factors. </PARA>
</para> </NOTE>
</PARA>
<itemizedlist> </LISTITEM>
<listitem> <LISTITEM>
<para>If the new version is a revision or a new point release</para> <PARA>
</listitem> From the Edit Product screen again (once you've made your way back), enter the URL
<listitem> for a description of what your milestones are for this product in the "Milestone URL" field.
<para>How many, if any, local changes have been made</para> It should be of the format "http://www.foo.com/bugzilla/product_milestones.html"
</listitem> </PARA>
</itemizedlist> <PARA>
Some common uses of this field include product descriptions, product roadmaps,
<para>There are also three different methods to upgrade your installation. and of course a simple description of the meaning of each milestone.
</para> </PARA>
</LISTITEM>
<orderedlist> <LISTITEM>
<listitem> <PARA>
<para>Using CVS (<xref linkend="upgrade-cvs"/>)</para> If you're using Target Milestones, the "Default Milestone" field must have some
</listitem> kind of entry. If you really don't care if people set coherent Target Milestones,
<listitem> simply leave this at the default, "---". However, controlling and regularly updating the Default
<para>Downloading a new tarball (<xref linkend="upgrade-tarball"/>)</para> Milestone field is a powerful tool when reporting the status of projects.
</listitem> </PARA>
<listitem> <PARA>Select the "Update" button when you are done.</PARA>
<para>Applying the relevant patches (<xref linkend="upgrade-patches"/>)</para> </LISTITEM>
</listitem> <LISTITEM>
</orderedlist> <PARA>
<para>Which options are available to you may depend on how large a jump </PARA>
you are making and/or your network configuration. </LISTITEM>
</para> </ORDEREDLIST>
</SECTION>
<para>Revisions are normally released to fix security vulnerabilities
and are distinguished by an increase in the third number. For example, <SECTION id="voting">
when 2.16.2 was released, it was a revision to 2.16.1. <TITLE>Voting</TITLE>
</para> <PARA>
The concept of "voting" is a poorly understood, yet powerful feature for the management
<para>Point releases are normally released when the Bugzilla team feels of open-source projects. Each user is assigned so many Votes per product, which they can
that there has been a significant amount of progress made between the freely reassign (or assign multiple votes to a single bug).
last point release and the current time. These are often proceeded by a This allows developers to gauge user need for a particular enhancement
stabilization period and release candidates, however the use of or bugfix. By allowing bugs with a certain number of votes to automatically move from
development versions or release candidates is beyond the scope of this "UNCONFIRMED" to "NEW", users of the bug system can help high-priority bugs garner
document. Point releases can be distinguished by an increase in the attention so they don't sit for a long time awaiting triage.
second number, or minor version. For example, 2.16.2 is a newer point </PARA>
release than 2.14.5. <PARA>
</para> The daunting challenge of Votes is deciding where you draw the line for a "vocal majority". If you
only have a user base of 100 users, setting a low threshold for bugs to move from UNCONFIRMED
<para>The examples in this section are written as if you were updating to NEW makes sense. As the Bugzilla user base expands, however, these thresholds must be
to version 2.16.2. The procedures are the same regardless if you are re-evaluated. You should gauge whether this feature is worth the time and close monitoring involved,
updating to a new point release or a new revision. However, the chance and perhaps forego implementation until you have a critical mass of users who demand it.
of running into trouble increases when upgrading to a new point release, </PARA>
escpecially if you've made local changes. <PARA>To modify Voting settings:</PARA>
</para> <ORDEREDLIST>
<LISTITEM>
<para>These examples also assume that your Bugzilla installation is at <PARA>
<filename>/var/www/html/bugzilla</filename>. If that is not the case, Navigate to the "Edit Product" screen for the Product you wish to modify
simply substitute the proper paths where appropriate. </PARA>
</para> </LISTITEM>
<LISTITEM>
<example id="upgrade-cvs"> <PARA>
<title>Upgrading using CVS</title> Set "Maximum Votes per person" to your calculated value. Setting this field
to "0" disables voting.
<para>Every release of Bugzilla, whether it is a revision or a point </PARA>
release, is tagged in CVS. Also, every tarball we have distributed </LISTITEM>
since version 2.12 has been primed for using CVS. This does, however, <LISTITEM>
require that you are able to access cvs-mirror.mozilla.org on port <PARA>
2401. Set "Maximum Votes a person can put on a single bug" to your calculated value. It
should probably be some number lower than the "Maximum votes per person".
<tip> Setting this field to "0" disables voting, but leaves the voting options open
<para>If you can do this, updating using CVS is probably the most to the user. This is confusing.
painless method, especially if you have a lot of local changes. </PARA>
</para> </LISTITEM>
</tip> <LISTITEM>
</para> <PARA>
Set "Number of votes a bug in this product needs to automatically get out of the
<programlisting> UNCONFIRMED state" to your calculated number. Setting this field to "0"
bash$ <command>cd /var/www/html/bugzilla</command> disables the automatic move of bugs from UNCONFIRMED to NEW. Some people
bash$ <command>cvs login</command> advocate leaving this at "0", but of what use are Votes if your Bugzilla
Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot user base is unable to affect which bugs appear on Development radar?
CVS password: <command>anonymous</command> <TIP>
bash$ <command>cvs -q update -r BUGZILLA-2_16_2 -dP</command> <PARA>
P checksetup.pl You should probably set this number to higher than a small coalition of
P collectstats.pl Bugzilla users can influence it. Most sites use this as a "referendum"
P globals.pl mechanism -- if users are able to vote a bug out of UNCONFIRMED, it
P docs/rel_notes.txt is a <EMPHASIS>really</EMPHASIS> bad bug!
P template/en/default/list/quips.html.tmpl </PARA>
</programlisting> </TIP>
</PARA>
<para> </LISTITEM>
<caution> <LISTITEM>
<para>If a line in the output from <command>cvs update</command> <PARA>
begins with a <computeroutput>C</computeroutput> that represents a Once you have adjusted the values to your preference, select the "Update" button.
file with local changes that CVS was unable to properly merge. You </PARA>
need to resolve these conflicts manually before Bugzilla (or at </LISTITEM>
least the portion using that file) will be usable. </ORDEREDLIST>
</para> </SECTION>
</caution>
<SECTION id="groups">
<note> <TITLE>Groups and Group Security</TITLE>
<para>You also need to run <command>./checksetup.pl</command> <PARA>
before your Bugzilla upgrade will be complete. Groups can be very useful in bugzilla, because they allow users to isolate
</para> bugs or products that should only be seen by certain people. Groups can also
</note> be a complicated minefield of interdependencies and weirdness if mismanaged.
</para>
</example> <EXAMPLE>
<TITLE>When to Use Group Security</TITLE>
<example id="upgrade-tarball"> <INFORMALEXAMPLE>
<title>Upgrading using the tarball</title> <PARA>
Many Bugzilla sites isolate "Security-related" bugs from all other bugs.
<para>If you are unable or unwilling to use CVS, another option that's This way, they can have a fix ready before the security vulnerability
always available is to download the latest tarball. This is the most is announced to the world. You can create a "Security" product which, by
difficult option to use, especially if you have local changes. default, has no members, and only add members to the group (in their individual
</para> User page, as described under User Administration) who should have
priveleged access to "Security" bugs. Alternately, you may create a Group
<programlisting> independently of any Product, and change the Group mask on individual bugs
bash$ <command>cd /var/www/html</command> to restrict access to members only of certain Groups.
bash$ <command>wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.2.tar.gz</command> </PARA>
<emphasis>Output omitted</emphasis> </INFORMALEXAMPLE>
bash$ <command>tar xzvf bugzilla-2.16.2.tar.gz</command> </EXAMPLE>
bugzilla-2.16.2/
bugzilla-2.16.2/.cvsignore Groups only work if you enable the "usebuggroups" paramater.
bugzilla-2.16.2/1x1.gif In addition, if the "usebuggroupsentry" parameter is "On", one can restrict access
<emphasis>Output truncated</emphasis> to products by groups, so that only members of a product group are able to view
bash$ <command>cd bugzilla-2.16.2</command> bugs within that product.
bash$ <command>cp ../bugzilla/localconfig* .</command> Group security in Bugzilla can be divided into two categories:
bash$ <command>cp -r ../bugzilla/data .</command> Generic and Product-Based.
bash$ <command>cd ..</command> </PARA>
bash$ <command>mv bugzilla bugzilla.old</command> <NOTE>
bash$ <command>mv bugzilla-2.16.2 bugzilla</command> <PARA>
bash$ <command>cd bugzilla</command> Groups in Bugzilla are a complicated beast that evolved out of very simple user
bash$ <command>./checksetup.pl</command> permission bitmasks, apparently itself derived from common concepts in UNIX access
<emphasis>Output omitted</emphasis> controls. A "bitmask" is a fixed-length number whose value can describe one, and
</programlisting> only one, set of states. For instance, UNIX file permissions are assigned bitmask
values: "execute" has a value of 1, "write" has a value of 2,
<para> and "read" has a value of 4. Add them together,
<warning> and a file can be read, written to, and executed if it has a bitmask of "7". (This
<para>The <command>cp</command> commands both end with periods which is a simplified example -- anybody who knows UNIX security knows there is much
is a very important detail, it tells the shell that the destination more to it than this. Please bear with me for the purpose of this note.) The only
directory is the current working directory. Also, the period at the way a bitmask scheme can work is by doubling the bit count for each value. Thus
beginning of the <command>./checksetup.pl</command> is important and if UNIX wanted to offer another file permission, the next would have to be a value of
can not be omitted. 8, then the next 16, the next 32, etc.
</para> </PARA>
</warning> <PARA>
Similarly, Bugzilla offers a bitmask to define group permissions, with an internal
<note> limit of 64. Several are already occupied
<para>You will now have to reapply any changes you have made to your by built-in permissions. The way around this limitation is
local installation manually. to avoid assigning groups to products if you have many products, avoid bloating
</para> of group lists, and religiously prune irrelevant groups. In reality, most installations
</note> of Bugzilla support far fewer than 64 groups, so this limitation has not hit
</para> for most sites, but it is on the table to be revised for Bugzilla 3.0
</example> because it interferes with the security schemes of some administrators.
</PARA>
<example id="upgrade-patches"> </NOTE>
<title>Upgrading using patches</title> <PARA>
To enable Generic Group Security ("usebuggroups"):
<para>The Bugzilla team will normally make a patch file available for </PARA>
revisions to go from the most recent revision to the new one. You could <ORDEREDLIST>
also read the release notes and grab the patches attached to the <LISTITEM>
mentioned bug, but it is safer to use the released patch file as <PARA>
sometimes patches get changed before they get checked in. Turn "On" "usebuggroups" in the "Edit Parameters" screen.
It is also theoretically possible to </PARA>
scour the fixed bug list and pick and choose which patches to apply </LISTITEM>
from a point release, but this is not recommended either as what you'll <LISTITEM>
end up with is a hodge podge Bugzilla that isn't really any version. <PARA>
This would also make it more difficult to upgrade in the future. You will generally have no groups set up. Select the "groups" link
</para> in the footer.
</PARA>
<programlisting> </LISTITEM>
bash$ <command>cd /var/www/html/bugzilla</command> <LISTITEM>
bash$ <command>wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.1-to-2.16.2.diff.gz</command> <PARA>
<emphasis>Output omitted</emphasis> Take a moment to understand the instructions on the "Edit Groups" screen.
bash$ <command>gunzip bugzilla-2.16.1-to-2.16.2.diff.gz</command> Once you feel confident you understand what is expected of you, select the
bash$ <command>patch -p1 &lt; bugzilla-2.16.1-to-2.16.2.diff</command> "Add Group" link.
patching file checksetup.pl </PARA>
patching file collectstats.pl </LISTITEM>
patching file globals.pl <LISTITEM>
</programlisting> <PARA>
Fill out the "New Name" (remember, no spaces!), "New Description", and "New
<para> User RegExp" fields. "New User RegExp" allows you to automatically place
<caution> all users who fulfill the Regular Expression into the new group.
<para>If you do this, beware that this doesn't change the entires in
your <filename id="dir">CVS</filename> directory so it may make <EXAMPLE>
updates using CVS (<xref linkend="upgrade-cvs"/>) more difficult in the <TITLE>Creating a New Group</TITLE>
future. <INFORMALEXAMPLE>
</para> <PARA>
</caution> I created a group called "DefaultGroup" with a description of "This is simply
</para> a group to play with", and a "New User RegExp" of "*@velio.com". This
</example> new group automatically includes all Bugzilla users with "@velio.com" at the
end of their user id. When I finished, my new group was assigned bit #128.
</section> </PARA>
</chapter> </INFORMALEXAMPLE>
</EXAMPLE>
When you have finished, select the "Add" button.
</PARA>
</LISTITEM>
</ORDEREDLIST>
<PARA>
To enable Product-Based Group Security ("usebuggroupsentry"):
</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">
<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>
First thing's first: 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 Privelege 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 "nobody". 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.</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 file.
The localconfig file stores your "bugs" user password,
which would be terrible to have in the hands
of a criminal. Also 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>
<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-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2 sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
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.xml" "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