diff --git a/webtools/bugzilla/docs/html/Bugzilla-Guide.html b/webtools/bugzilla/docs/html/Bugzilla-Guide.html
index 3b3283361bf..b95ae37bd32 100644
--- a/webtools/bugzilla/docs/html/Bugzilla-Guide.html
+++ b/webtools/bugzilla/docs/html/Bugzilla-Guide.html
@@ -1,10 +1,12 @@
The Bugzilla Guide - 2.17.5 Development ReleaseThe Bugzilla Guide - 2.17.5
+ Development ReleaseThe Bugzilla Guide - 2.17.5 Development Release
Matthew P. Barnson
Jacob Steenhagen
The Bugzilla Guide - 2.17.5
+ Development Release
The Bugzilla Team
2003-11-01
2004-01-15
This is the documentation for Bugzilla, the mozilla.org
- bug-tracking system.
+>
This is the documentation for Bugzilla, a
+ bug-tracking system from mozilla.org.
Bugzilla is an enterprise-class piece of software
- that powers issue-tracking for hundreds of
- organizations around the world, tracking millions of bugs.
+ that tracks millions of bugs and issues for hundreds of
+ organizations around the world.
- This documentation is maintained in DocBook 4.1.2 XML format.
- Changes are best submitted as plain text or XML diffs, attached
- to a bug filed in the Bugzilla Documentation component.
-
This is a development version of this guide. Information in it
- is subject to change before the 2.18 release of this guide
- (which will correspond with the 2.18 release of Bugzilla).
-
The most current version of this document can always be found on the
Bugzilla Documentation PageBugzilla
+ Documentation Page.
Appendix EAppendix C.
--Copyright (c) 2000-2003 Matthew P. Barnson and The Bugzilla TeamCopyright (c) 2000-2004 The Bugzilla Team
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
- please contact The Bugzilla Team.
+ please contact the Bugzilla Team.
1.2. Disclaimer
No liability for the contents of this document can be accepted.
- Use the concepts, examples, and other content at your own risk.
+ Follow the instructions herein at your own risk.
This document may contain errors
and inaccuracies that may damage your system, cause your partner
to leave you, your boss to fire you, your cats to
@@ -595,35 +564,20 @@ NAME="disclaimer"
war. Proceed with caution.
All copyrights are held by their respective owners, unless
- specifically noted otherwise. Use of a term in this document
- should not be regarded as affecting the validity of any
- trademark or service mark.
-
Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". We
- wholeheartedly endorse the use of GNU/Linux in every situation
- where it is appropriate. It is an extremely versatile, stable,
+ wholeheartedly endorse the use of GNU/Linux; it is an extremely
+ versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
You are strongly recommended to make a backup of your system
- before installing Bugzilla and at regular intervals thereafter.
- If you implement any suggestion in this Guide, implement this one!
-
Although the Bugzilla development team has taken great care to
- ensure that all easily-exploitable bugs or options are
- documented or fixed in the code, security holes surely exist.
- Great care should be taken both in the installation and usage of
- this software. Carefully consider the implications of installing
- other network services with Bugzilla. The Bugzilla development
- team members, Netscape Communications, America Online Inc., and
- any affiliated developers or sponsors assume no liability for
- your use of this product. You have the source code to this
- product, and are responsible for auditing it yourself to ensure
+ ensure that all exploitable bugs or options have been
+ fixed, security holes surely exist. Great care should be taken both in
+ the installation and usage of this software. The Bugzilla development
+ team members assume no liability for your use of this software. You have
+ the source code, and are responsible for auditing it yourself to ensure
your security needs are met.
This is the 2.17.5 version of The Bugzilla Guide. It is so named
to match the current version of Bugzilla.
- This version of the guide, like its associated Bugzilla version is a
- development version. Information is subject to change between now and
- when 2.18 is released.
+ This version of the guide, like its associated Bugzilla version, is a
+ development version.
- If you are
- reading this from any source other than those below, please
- check one of these mirrors to make sure you are reading an
- up-to-date version of the Guide.
The newest version of this guide can always be found at http://www.bugzilla.org; including
- documentation for past releases and the current development version.
-
The documentation for the most recent stable release of Bugzilla can also
- be found at
- The Linux Documentation Project.
+>; however, you should read the version
+ which came with the Bugzilla release you are using.
The latest version of this document can always be checked out via CVS.
@@ -703,116 +643,18 @@ NAME="credits"
contribution to the Bugzilla community:
for taking over documentation during the 2.17 development
- period.
-
Matthew P. Barnson, Kevin Brannen, Dawn Endico, Ben FrantzDale, Eric Hanson, Tara Hernandez, Dave Lawrence, Zach Lipton, Gervase Markham, Andrew Pearson, Joe Robins, Spencer Smith, Jacob Steenhagen, Ron Teitelbaum, Terry Weissman, Martin Wulffeld.
+
Last but not least, all the members of the
news://news.mozilla.org/netscape/public/mozilla/webtools
netscape.public.mozilla.webtools
newsgroup. Without your discussions, insight, suggestions, and patches,
this could never have happened.
Thanks also go to the following people for significant contributions
- to this documentation (in alphabetical order):
- Andrew Pearson, Ben FrantzDale, Eric Hanson, Gervase Markham, Joe Robins, Kevin Brannen, Martin Wulffeld, Ron Teitelbaum, Spencer Smith, Zach Liption
- .
-
File Names
File and directory names
Directory Names
directory
-
Commands to be typed
Applications Names
Applications names
Environment Variables
Environment variables
Emphasized word
word
-
Term found in the glossary
Code Example
Code example
+ This documentation is maintained in DocBook 4.1.2 XML format.
+ Changes are best submitted as plain text or XML diffs, attached
+ to a bug filed in the Bugzilla Documentation component.
+
2.1. What is Bugzilla?
Bugzilla is a bug- or issue-tracking system. Bug-tracking
systems allow individual or groups of developers effectively to keep track
- of outstanding problems with their product.
- Bugzilla was originally
- written by Terry Weissman in a programming language called TCL, to
- replace a rudimentary bug-tracking database used internally by Netscape
- Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl
- it remains to this day. Most commercial defect-tracking software vendors
- at the time charged enormous licensing fees, and Bugzilla quickly became
- a favorite of the open-source crowd (with its genesis in the open-source
- browser project, Mozilla). It is now the de-facto standard
- defect-tracking system against which all others are measured.
+ of outstanding problems with their products.
Do we need more here?
2.2. Why use a bug-tracking system?
For many years, defect-tracking software was principally
+ the domain of large software development houses. Most smaller shops
+ simply relied on
+ shared lists and email to monitor the status of defects. This procedure
+ was error-prone and tended to cause those bugs judged least significant by
+ developers to be dropped or ignored.
Integrated
+ defect-tracking systems reduce downtime, increase productivity, and raise
+ customer satisfaction with their systems. Along with full disclosure, an
+ open bug-tracker allows you to keep in touch with your clients
+ and resellers, to communicate about problems effectively throughout the
+ data management chain. Many corporations have also discovered that
+ defect-tracking helps reduce costs by providing IT support
+ accountability, telephone support knowledge bases, and a common,
+ well-understood method for accounting for unusual system or software
+ issues.
2.3. Why use Bugzilla?
Bugzilla boasts many advanced features. These include:
2.2. Why Should We Use Bugzilla?
For many years, defect-tracking software has remained principally
- the domain of large software development houses. Even then, most shops
- never bothered with bug-tracking software, and instead simply relied on
- shared lists and email to monitor the status of defects. This procedure
- is error-prone and tends to cause those bugs judged least significant by
- developers to be dropped or ignored.
These days, many companies are finding that integrated
- defect-tracking systems reduce downtime, increase productivity, and raise
- customer satisfaction with their systems. Along with full disclosure, an
- open bug-tracker allows manufacturers to keep in touch with their clients
- and resellers, to communicate about problems effectively throughout the
- data management chain. Many corporations have also discovered that
- defect-tracking helps reduce costs by providing IT support
- accountability, telephone support knowledge bases, and a common,
- well-understood system for accounting for unusual system or software
- issues.
But why should
- you
-
- use Bugzilla?
Bugzilla is very adaptable to various situations. Known uses
currently include IT support queues, Systems Administration deployment
@@ -1325,22 +1147,6 @@ TARGET="_top"
>, Bugzilla
provides a powerful, easy-to-use solution to configuration management and
replication problems.
Bugzilla can dramatically increase the productivity and
- accountability of individual employees by providing a documented workflow
- and positive feedback for good performance. How many times do you wake up
- in the morning, remembering that you were supposed to do
- something
- today, but you just can't quite remember? Put it in Bugzilla, and you
- have a record of it from which you can extrapolate milestones, predict
- product versions for integration, and follow the discussion trail
- that led to critical decisions.
Ultimately, Bugzilla puts the power in your hands to improve your
- value to your employer or business while providing a usable framework for
- your natural attention to detail and knowledge store to flourish.
Chapter 3. Using Bugzilla
3.1. How do I use Bugzilla?
This section contains information for end-users of Bugzilla.
- There is a Bugzilla test installation, called
- Landfill,
- which you are welcome to play with (if it's up.)
- However, it does not necessarily
- have all Bugzilla features enabled, and often runs cutting-edge versions
- of Bugzilla for testing, so some things may work slightly differently
- than mentioned here.
3.1.1. Create a Bugzilla Account
3.1. Create a Bugzilla Account
If you want to use Bugzilla, first you need to create an account.
- Consult with the administrator responsible for your installation of
- Bugzilla for the URL you should use to access it. If you're
- test-driving Bugzilla, use this URL:
- http://landfill.bugzilla.org/bugzilla-tip/.
-
Click the
- "Open a new Bugzilla account"
- link, enter your email address and, optionally, your name in the
- spaces provided, then click
- "Create Account"
- .
Within moments, you should receive an email to the address
- you provided above, which contains your login name (generally the
- same as the email address), and a password you can use to access
- your account. This password is randomly generated, and can be
- changed to something more memorable.
Click the
- "Log In"
- link in the yellow area at the bottom of the page in your browser,
- enter your email address and password into the spaces provided, and
- click
- "Login".
-
You are now logged in. Bugzilla uses cookies for authentication
- so, unless your IP address changes, you should not have to log in
- again.
You are now logged in. Bugzilla uses cookies to remember you are
+ logged in so, unless you have cookies disabled or your IP address changes,
+ you should not have to log in again.
3.1.2. Anatomy of a Bug
3.2. Anatomy of a Bug
The core of Bugzilla is the screen which displays a particular
- bug. It's a good place to explain some Bugzilla concepts.
-
Bug 1 on Landfill
Bug 1 on Landfill
- is a good example. Note that the labels for most fields are hyperlinks;
- clicking them will take you to context-sensitive help on that
- particular field. Fields marked * may not be present on every
- installation of Bugzilla.
Product and Component:
- Bugs are divided up by Product and Component, with a Product
- having one or more Components in it. For example,
- bugzilla.mozilla.org's "Bugzilla" Product is composed of several
- Components:
-
Administration:
- Administration of a Bugzilla installation.
Bugzilla-General:
- Anything that doesn't fit in the other components, or spans
- multiple components.
Creating/Changing Bugs:
- Creating, changing, and viewing bugs.
Documentation:
- The Bugzilla documentation, including The Bugzilla Guide.
Email:
- Anything to do with email sent by Bugzilla.
Installation:
- The installation process of Bugzilla.
Query/Buglist:
- Anything to do with searching for bugs and viewing the
- buglists.
Reporting/Charting:
- Getting reports from Bugzilla.
User Accounts:
- Anything about managing a user account from the user's perspective.
- Saved queries, creating accounts, changing passwords, logging in,
- etc.
User Interface:
- General issues having to do with the user interface cosmetics (not
- functionality) including cosmetic issues, HTML templates,
- etc.
-
Status and Resolution:
- These define exactly what state the bug is in - from not even
- being confirmed as a bug, through to being fixed and the fix
- confirmed by Quality Assurance. The different possible values for
- Status and Resolution on your installation should be documented in the
- context-sensitive help for those items.
Assigned To:
- The person responsible for fixing the bug.
*URL:
- A URL associated with the bug, if any.
Summary:
- A one-sentence summary of the problem.
*Status Whiteboard:
- (a.k.a. Whiteboard) A free-form text area for adding short notes
- and tags to a bug.
*Keywords:
- The administrator can define keywords which you can use to tag and
- categorise bugs - e.g. The Mozilla Project has keywords like crash
- and regression.
Platform and OS:
- These indicate the computing environment where the bug was
- found.
Version:
- The "Version" field is usually used for versions of a product which
- have been released, and is set to indicate which versions of a
- Component have the particular problem the bug report is
- about.
Priority:
- The bug assignee uses this field to prioritise his or her bugs.
- It's a good idea not to change this on other people's bugs.
Severity:
- This indicates how severe the problem is - from blocker
- ("application unusable") to trivial ("minor cosmetic issue"). You
- can also use this field to indicate whether a bug is an enhancement
- request.
*Target:
- (a.k.a. Target Milestone) A future version by which the bug is to
- be fixed. e.g. The Bugzilla Project's milestones for future
- Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
- restricted to numbers, thought - you can use any text strings, such
- as dates.
Reporter:
- The person who filed the bug.
CC list:
- A list of people who get mail when the bug changes.
Attachments:
- You can attach files (e.g. testcases or patches) to bugs. If there
- are any attachments, they are listed in this section.
*Dependencies:
- If this bug cannot be fixed unless other bugs are fixed (depends
- on), or this bug stops other bugs being fixed (blocks), their
- numbers are recorded here.
*Votes:
- Whether this bug has any votes.
Additional Comments:
- You can add your two cents to the bug discussion here, if you have
- something worthwhile to say.
3.1.3. Searching for Bugs
3.3. Searching for Bugs
The Bugzilla Search page is is the interface where you can find
- any bug report, comment, or patch currently in the Bugzilla system. You
- can play with it here:
- http://landfill.bugzilla.org/bugzilla-tip/query.cgi.
The Search page has controls for selecting different possible
- values for all of the fields in a bug, as described above. For some
- fields, multiple values can be selected. In those cases, Bugzilla
- returns bugs where the content of the field matches one of the selected
- values. If none is selected, then the field can take any value.
Once you've defined a search, you can either run it, or save it
- as a Remembered Query, which can optionally appear in the footer of
- your pages.
Once you've run a search, you can save it as a Saved Search, which
+ appears in the page footer.
Highly advanced querying is done using Boolean Charts.
Highly advanced querying is done using Boolean Charts. See the
+ Boolean Charts help link on the Search page for more information.
3.1.4. Bug Lists
3.4. Bug Lists
If you run a search, a list of matching bugs will be returned.
- The default search is to return all open bugs on the system - don't try
- running this search on a Bugzilla installation with a lot of
- bugs!
The format of the list is configurable. For example, it can be
- sorted by clicking the column headings. Other useful features can be
- accessed using the links at the bottom of the list:
-
Long Format:
- this gives you a large page with a non-editable summary of the fields
- of each bug.
Change Columns:
- change the bug attributes which appear in the list.
Change several bugs at once:
- If your account is sufficiently empowered, you can make the same
- change to all the bugs in the list - for example, changing their
- owner.
Send mail to bug owners:
- Sends mail to the owners of all bugs on the list.
Edit this query:
- If you didn't get exactly the results you were looking for, you can
- return to the Query page through this link and make small revisions
- to the query you just made so you get more accurate results.
-
3.1.5. Filing Bugs
3.5. Filing Bugs
Years of bug writing experience has been distilled for your
- reading pleasure into the
-
Bug Writing Guidelines
Bug Writing Guidelines.
- While some of the advice is Mozilla-specific, the basic principles of
- reporting Reproducible, Specific bugs, isolating the Product you are
- using, the Version of the Product, the Component which failed, the
- Hardware Platform, and Operating System you were using at the time of
- the failure go a long way toward ensuring accurate, responsible fixes
- for the bug that bit you.
The procedure for filing a test bug is as follows:
Fill in the fields. Bugzilla should have made reasonable
- guesses, based upon your browser, for the "Platform" and "OS"
- drop-down boxes. If they are wrong, change them.
3.1.6. Patch Viewer
3.6. Patch Viewer
Viewing and reviewing patches in Bugzilla is often difficult due to
- lack of context, improper format and the inherent readability issues that
- raw patches present. Patch Viewer is an enhancement to Bugzilla designed
- to fix that by offering increased context, linking to sections, and
- integrating with Bonsai, LXR and CVS.
Patch viewer allows you to:
View patches in color, with side-by-side view rather than trying
- to interpret the contents of the patch.
Collapse and expand sections of a patch for easy
- reading.
Link to a particular section of a patch for discussion or
- review
Go to Bonsai or LXR to see more context, blame, and
- cross-references for the part of the patch you are looking at
Create a rawtext unified format diff out of any patch, no
- matter what format it came from
3.1.6.1. Viewing Patches in Patch Viewer
3.6.1. Viewing Patches in Patch Viewer
The main way to view a patch in patch viewer is to click on the
- "Diff" link next to a patch in the Attachments list on a bug. You may
- also do this within the edit window by clicking the "View Attachment As
- Diff" button in the Edit Attachment screen.
3.1.6.2. Seeing the Difference Between Two Patches
3.6.2. Seeing the Difference Between Two Patches
To see the difference between two patches, you must first view the
- newer patch in Patch Viewer. Then select the older patch from the
- dropdown at the top of the page ("Differences between [dropdown] and
- this patch") and click the "Diff" button. This will show you what
- is new or changed in the newer patch.
3.1.6.3. Getting More Context in a Patch
3.6.3. Getting More Context in a Patch
To get more context in a patch, you put a number in the textbox at
- the top of Patch Viewer ("Patch / File / [textbox]") and hit enter.
- This will give you that many lines of context before and after each
- change. Alternatively, you can click on the "File" link there and it
- will show each change in the full context of the file. This feature only
- works against files that were diffed using "cvs diff".
3.1.6.4. Collapsing and Expanding Sections of a Patch
3.6.4. Collapsing and Expanding Sections of a Patch
To view only a certain set of files in a patch (for example, if a
- patch is absolutely huge and you want to only review part of it at a
- time), you can click the "(+)" and "(-)" links next to each file (to
- expand it or collapse it). If you want to collapse all files or expand
- all files, you can click the "Collapse All" and "Expand All" links at the
- top of the page.
3.1.6.5. Linking to a Section of a Patch
3.6.5. Linking to a Section of a Patch
To link to a section of a patch (for example, if you want to be
- able to give someone a URL to show them which part you are talking
- about) you simply click the "Link Here" link on the section header. The
- resulting URL can be copied and used in discussion. (Copy Link
- Location in Mozilla works as well.)
3.1.6.6. Going to Bonsai and LXR
3.6.6. Going to Bonsai and LXR
To go to Bonsai to get blame for the lines you are interested in,
- you can click the "Lines XX-YY" link on the section header you are
- interested in. This works even if the patch is against an old
- version of the file, since Bonsai stores all versions of the file.
To go to LXR, you click on the filename on the file header
- (unfortunately, since LXR only does the most recent version, line
- numbers are likely to rot).
3.1.6.7. Creating a Unified Diff
3.6.7. Creating a Unified Diff
If the patch is not in a format that you like, you can turn it
- into a unified diff format by clicking the "Raw Unified" link at the top
- of the page.
3.2. Hints and Tips3.7. Hints and Tips
This section distills some Bugzilla tips and best practices
that have been developed.
3.2.1. Autolinkification
3.7.1. Autolinkification
Bugzilla comments are plain text - so posting HTML will result
- in literal HTML tags rather than being interpreted by a browser.
+>Bugzilla comments are plain text - so typing <U> will
+ produce less-than, U, greater-than rather than underlined text.
However, Bugzilla will automatically make hyperlinks out of certain
sorts of text in comments. For example, the text
- http://www.bugzilla.org will be turned into
+ "http://www.bugzilla.org" will be turned into a link:
Quicksearch is a single-text-box query tool which uses
metacharacters to indicate what is to be searched. For example, typing
@@ -2155,7 +1953,7 @@ CLASS="section"
>3.2.3. Comments3.7.3. Comments
If you are changing the fields on a bug, only comment if
either you have something pertinent to say, or Bugzilla requires it.
@@ -2168,7 +1966,7 @@ NAME="commenting"
Don't use sigs in comments. Signing your name ("Bill") is acceptable,
- particularly if you do it out of habit, but full mail/news-style
+ if you do it out of habit, but full mail/news-style
four line ASCII art creations are not.
3.2.4. Attachments3.7.4. Attachments
Use attachments, rather than comments, for large chunks of ASCII data,
such as trace, debugging output files, or log files. That way, it doesn't
@@ -2203,9 +2001,9 @@ CLASS="section"
>
3.2.5. Filing Bugs
3.7.5. Filing Bugs
Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
@@ -2231,11 +2029,11 @@ CLASS="section"
>3.3. User Preferences3.8. User Preferences
Once you have logged in, you can customise various aspects of
Bugzilla via the "Edit prefs" link in the page footer.
- The preferences are split into four tabs:
3.3.1. Account Settings
3.8.1. Account Settings
On this tab, you can change your basic account information,
including your password, email address and real name. For security
@@ -2268,13 +2066,19 @@ CLASS="section"
>3.3.2. Email Settings3.8.2. Email Settings
On this tab you can reduce or increase the amount of email sent
you from Bugzilla, opting in our out depending on your relationship to
- the bug and the change that was made to it. (Note that you can also do
- client-side filtering using the X-Bugzilla-Reason header which Bugzilla
- adds to all bugmail.)
You can also do further filtering on the client side by
+ using the X-Bugzilla-Reason mail header which Bugzilla
+ adds to all bugmail. This tells you what relationship you have to the
+ bug in question,
+ and can be any of Owner, Reporter, QAcontact, CClist, Voter and
+ WatchingComponent.
By entering user email names, delineated by commas, into the
"Users to watch" text entry box you can receive a copy of all the
@@ -2315,23 +2119,9 @@ CLASS="section"
>
3.3.3. Page Footer
On the Search page, you can store queries in Bugzilla, so if you
- regularly run a particular query it is just a drop-down menu away.
- Once you have a stored query, you can come
- here to request that it also be displayed in your page footer.
3.3.4. Permissions
3.8.3. Permissions
This is a purely informative page which outlines your current
permissions on this installation of Bugzilla - what product groups you
@@ -2339,6 +2129,19 @@ NAME="permissionsettings"
functions.
3.9. Reports
To be written
Section 4.3Section 4.4, so be sure to check out that section before
you start your installation.
Section 4.3.1Section 4.4.1.
You are strongly recommended to make a backup of your system
+ before installing Bugzilla and at regular intervals thereafter.
+
The listing below is a basic step-by-step list. More information
can be found in the sections below. Minimum versions will be
included in parenthesis where appropriate.
@@ -2454,15 +2261,6 @@ TYPE="1"
>
Any machine that doesn't have Perl on it is a sad machine indeed.
+ Perl can be got in source form from http://www.perl.com.
+ There are also binary versions available for many platforms, most of which
+ are linked to from perl.com.
+ Although Bugzilla runs with perl 5.6,
+ it's a good idea to be up to the very latest version
+ if you can when running Bugzilla. As of this writing, that is Perl
+ version 5.8.
This first thing you'll want to do is make sure you've given the
+ "root" user a password as suggested in
+ Section 4.5.2. For clarity, these instructions will
+ assume that your MySQL user for Bugzilla will be "bugs_user",
+ the database will be called "bugs_db" and the password for
+ the "bugs_user" user is "bugs_password". You
+ should, of course, substitute the values you intend to use for your site.
+
Most people use "bugs" for both the user and
+ database name.
+
Next, we use an SQL GRANT command to create a
+ "bugs_user"
+ user, and grant sufficient permissions for checksetup.pl, which we'll
+ use later, to work its magic. This also restricts the
+ "bugs_user"
+ user to operations within a database called
+ "bugs_db", and only allows the account to connect from
+ "localhost".
+ Modify it to reflect your setup if you will be connecting from
+ another machine or as a different user.
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
+ DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost
+ IDENTIFIED BY 'bugs_password';
+ mysql> FLUSH PRIVILEGES;
+
If you are using MySQL 4, the bugs user also needs to be granted
+ the LOCK TABLES and
+ CREATE TEMPORARY TABLES permissions.
+
We strongly recommend Apache as the web server to use. The
+ Bugzilla Guide installation instructions, in general, assume you are
+ using Apache. If you have got Bugzilla working using another webserver,
+ please share your experiences with us by filing a bug in http://www.perl.comBugzilla Documentation.
- There are also binary versions available for many platforms, most of which
- are linked to from perl.com.
- Although Bugzilla runs with perl 5.6,
- it's a good idea to be up to the very latest version
- if you can when running Bugzilla. As of this writing, that is Perl
- version 5.8.
4.1.4. Bugzilla
You should untar the Bugzilla files into a directory that you're
+ willing to make writable by the default web server user (probably
+ "nobody").
+ You may decide to put the files in the main web space for your
+ web server or perhaps in
+ /usr/local
+ with a symbolic link in the web space that points to the Bugzilla
+ directory.
If you symlink the bugzilla directory into your Apache's HTML
+ hierarchy, you may receive
+ Forbidden
+ errors unless you add the
+ "FollowSymLinks"
+ directive to the <Directory> entry for the HTML root
+ in httpd.conf.
Once all the files are in a web accessible directory, make that
+ directory writable by your webserver's user. This is a temporary step
+ until you run the post-install
+ checksetup.pl
+ script, which locks down your installation.
The default Bugzilla distribution is not designed to be placed
+ in a cgi-bin directory (this
+ includes any directory which is configured using the
+ ScriptAlias directive of Apache).
+
The process of untaring the module as defined in
+>The process of untarring the module as defined in
4.1.3.1. Bundle::Bugzilla4.1.5.1. Bundle::Bugzilla
If you are running at least perl 5.6.1, you can save yourself a lot
of time by using Bundle::Bugzilla. This bundle contains every module
@@ -3132,7 +3257,7 @@ CLASS="section"
>4.1.3.2. AppConfig (1.52)4.1.5.2. AppConfig (1.52)
Dependency for Template Toolkit. We probably don't need to
specifically check for it anymore.
@@ -3145,7 +3270,7 @@ CLASS="section"
>4.1.3.3. CGI (2.88)4.1.5.3. CGI (2.88)
The CGI module parses form elements and cookies and does many
other usefule things. It come as a part of recent perl distributions, but
@@ -3178,7 +3303,7 @@ CLASS="section"
>4.1.3.4. Data::Dumper (any)4.1.5.4. Data::Dumper (any)
The Data::Dumper module provides data structure persistence for
Perl (similar to Java's serialization). It comes with later
@@ -3212,7 +3337,7 @@ CLASS="section"
>4.1.3.5. TimeDate modules (2.21)4.1.5.5. TimeDate modules (2.21)
Many of the more common date/time/calendar related Perl modules
have been grouped into a bundle similar to the MySQL modules bundle.
@@ -3247,7 +3372,7 @@ CLASS="section"
>4.1.3.6. DBI (1.32)4.1.5.6. DBI (1.32)
The DBI module is a generic Perl module used the
MySQL-related modules. As long as your Perl installation was done
@@ -3281,7 +3406,7 @@ CLASS="section"
>4.1.3.7. MySQL-related modules4.1.5.7. MySQL-related modules
The Perl/MySQL interface requires a few mutually-dependent Perl
modules. These modules are grouped together into the the
@@ -3326,7 +3451,7 @@ CLASS="section"
>4.1.3.8. File::Spec (0.82)4.1.5.8. File::Spec (0.82)
File::Spec is a perl module that allows file operations, such as
generating full path names, to work cross platform.
@@ -3358,7 +3483,7 @@ CLASS="section"
>4.1.3.9. File::Temp (any)4.1.5.9. File::Temp (any)
File::Temp is used to generate a temporary filename that is
guaranteed to be unique. It comes as a standard part of perl
@@ -3390,7 +3515,7 @@ CLASS="section"
>4.1.3.10. Template Toolkit (2.08)4.1.5.10. Template Toolkit (2.08)
When you install Template Toolkit, you'll get asked various
questions about features to enable. The defaults are fine, except
@@ -3424,7 +3549,7 @@ CLASS="section"
>4.1.3.11. Text::Wrap (2001.0131)4.1.5.11. Text::Wrap (2001.0131)
Text::Wrap is designed to proved intelligent text wrapping.
The GD library was written by Thomas Boutell a long while ago to
programmatically generate images in C. Since then it's become the
@@ -3560,7 +3685,7 @@ CLASS="section"
>4.1.3.13. Chart::Base (0.99c) [optional]4.1.5.13. Chart::Base (0.99c) [optional]
The Chart module provides Bugzilla with on-the-fly charting
abilities. It can be installed in the usual fashion after it has been
@@ -3589,7 +3714,7 @@ CLASS="section"
>4.1.3.14. XML::Parser (any) [Optional]4.1.5.14. XML::Parser (any) [Optional]
XML::Parser is used by the 4.1.3.15. GD::Graph (any) [Optional]4.1.5.15. GD::Graph (any) [Optional]
In addition to GD listed above, the reporting interface of Bugzilla
needs to have the GD::Graph module installed.
@@ -3656,7 +3781,7 @@ CLASS="section"
>4.1.3.16. GD::Text::Align (any) [Optional]4.1.5.16. GD::Text::Align (any) [Optional]
GD::Text::Align, as the name implies, is used to draw aligned
strings of text. It is needed by the reporting interface.
@@ -3688,7 +3813,7 @@ CLASS="section"
>4.1.3.17. MIME::Parser (any) [Optional]4.1.5.17. MIME::Parser (any) [Optional]
MIME::Parser is only needed if you want to use the e-mail interface
located in the 4.1.3.18. PatchReader (0.9.1) [Optional]4.1.5.18. PatchReader (0.9.1) [Optional]
PatchReader is only needed if you want to use Patch Viewer, a
Bugzilla feature to format patches in a pretty HTML fashion. There are a
@@ -3759,350 +3884,15 @@ CLASS="section"
>
4.1.4. HTTP Server
You have freedom of choice here, pretty much any web server that
- is capable of running CGI
- scripts will work. Section 4.4 has more information about
- configuring web servers to work with Bugzilla.
-
We strongly recommend Apache as the web server to use. The
- Bugzilla Guide installation instructions, in general, assume you are
- using Apache. If you have got Bugzilla working using another webserver,
- please share your experiences with us by filing a bug in Bugzilla Documentation.
-
4.1.5. Bugzilla
You should untar the Bugzilla files into a directory that you're
- willing to make writable by the default web server user (probably
- "nobody").
- You may decide to put the files in the main web space for your
- web server or perhaps in
- /usr/local
- with a symbolic link in the web space that points to the Bugzilla
- directory.
If you symlink the bugzilla directory into your Apache's HTML
- hierarchy, you may receive
- Forbidden
- errors unless you add the
- "FollowSymLinks"
- directive to the <Directory> entry for the HTML root
- in httpd.conf.
Once all the files are in a web accessible directory, make that
- directory writable by your webserver's user. This is a temporary step
- until you run the post-install
- checksetup.pl
- script, which locks down your installation.
The default Bugzilla distribution is not designed to be placed
- in a cgi-bin directory (this
- includes any directory which is configured using the
- ScriptAlias directive of Apache). This will probably
- change as part of
- bug
- 44659.
-
4.1.6. Setting Up the MySQL Database
After you've gotten all the software installed and working you're
- ready to start preparing the database for its life as the back end to
- a high quality bug tracker.
This first thing you'll want to do is make sure you've given the
- "root" user a password as suggested in
- Section 5.6.2. For clarity, these instructions will
- assume that your MySQL user for Bugzilla will be "bugs_user",
- the database will be called "bugs_db" and the password for
- the "bugs_user" user is "bugs_password". You
- should, of course, substitute the values you intend to use for your site.
-
Most people use "bugs" for both the user and
- database name.
-
Next, we use an SQL GRANT command to create a
- "bugs_user"
- user, and grant sufficient permissions for checksetup.pl, which we'll
- use later, to work its magic. This also restricts the
- "bugs_user"
- user to operations within a database called
- "bugs_db", and only allows the account to connect from
- "localhost".
- Modify it to reflect your setup if you will be connecting from
- another machine or as a different user.
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
- DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost
- IDENTIFIED BY 'bugs_password';
-mysql> FLUSH PRIVILEGES;
-
If you are using MySQL 4, the bugs user also needs to be granted
- the LOCK TABLES and
- CREATE TEMPORARY TABLES permissions.
-
4.1.7. 4.1.6. checksetup.pl
Next, run the magic checksetup.pl script. (Many thanks to
- Holger Schurig
- for writing this script!)
- This script is designed to make sure your perl modules are the correct
+>Next, run the magic checksetup.pl script.
+ This is designed to make sure your perl modules are the correct
version and your MySQL database and other
configuration options are consistent with the Bugzilla CGI files.
It will make sure Bugzilla files and directories have reasonable
@@ -4238,9 +4028,9 @@ CLASS="section"
>
4.1.8. Configuring Bugzilla
4.1.7. Configuring Bugzilla
You should run through the parameters on the Edit Parameters page
(link in the footer) and set them all to appropriate values.
@@ -4256,17 +4046,415 @@ CLASS="section"
>
4.2. HTTP Server Configuration
The Bugzilla Team recommends Apache when using Bugzilla, however, any web server
+ that can be configured to run CGI scripts
+ should be able to handle Bugzilla. No matter what web server you choose, but
+ especially if you choose something other than Apache, you should be sure to read
+ Section 4.5.4.
+
The plan for this section is to eventually document the specifics of how to lock
+ down permissions on individual web servers.
+
4.2.1. Apache httpd
You will have to make sure that Apache is properly
+ configured to run the Bugzilla CGI scripts. You also need to make sure
+ that the .htaccess files created by
+ ./checksetup.pl are allowed to override Apache's normal access
+ permissions or else important password information may be exposed to the
+ Internet.
+
You need to configure Apache to run .cgi files outside the
+ cgi-bin directory.
+ Open your
+ httpd.conf file and make sure the
+ following line exists and is uncommented:
AddHandler cgi-script .cgi
+
To allow .htaccess files to override
+ permissions and .cgi files to run in the Bugzilla directory, make sure
+ the following two lines are in a Directory
+ directive that applies to the Bugzilla directory on your system
+ (either the Bugzilla directory or one of its parents).
+
Options +ExecCGI
+AllowOverride Limit
+
You should modify the <DirectoryIndex> parameter for
+ the Apache virtual host running your Bugzilla installation to
+ allow index.cgi as the index page for a
+ directory, as well as the usual index.html,
+ index.htm, and so forth.
For more information on Apache and its directives, see the
+ glossary entry on Apache.
+
4.2.2. Microsoft Internet Information Services
If you need, or for some reason even want, to use Microsoft's
+ Internet Information Services or
+ Personal Web Server you should be able
+ to. You will need to configure them to know how to run CGI scripts,
+ however. This is described in Microsoft Knowledge Base article
+ Q245225
+ for Internet Information Services and
+ Q231998
+ for Personal Web Server.
+
Also, and this can't be stressed enough, make sure that files such as
+ localconfig and your data
+ directory are secured as described in Section 4.5.4.
+
4.2.3. AOL Server
Ben FrantzDale reported success using AOL Server with Bugzilla. He
+ reported his experience and what appears below is based on that.
+
AOL Server will have to be configured to run
+ CGI scripts, please consult
+ the documentation that came with your server for more information on
+ how to do this.
+
Because AOL Server doesn't support .htaccess
+ files, you'll have to create a TCL
+ script. You should create an aolserver/modules/tcl/filter.tcl
+ file (the filename shouldn't matter) with the following contents (change
+ /bugzilla/ to the web-based path to
+ your Bugzilla installation):
+
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
+ns_register_filter preauth GET /bugzilla/localconfig~ filter_deny
+ns_register_filter preauth GET /bugzilla/\#localconfig\# filter_deny
+ns_register_filter preauth GET /bugzilla/*.pl filter_deny
+ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny
+ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny
+ns_register_filter preauth GET /bugzilla/data/* filter_deny
+ns_register_filter preauth GET /bugzilla/template/* filter_deny
+
+proc filter_deny { why } {
+ ns_log Notice "filter_deny"
+ return "filter_return"
+}
+
This probably doesn't account for all possible editor backup
+ files so you may wish to add some additional variations of
+ localconfig. For more information, see
+
bug 186383 or Bugtraq ID 6501.
+
If you are using webdot from research.att.com (the default
+ configuration for the webdotbase paramater), you
+ will need to allow access to data/webdot/*.dot
+ for the reasearch.att.com machine.
+
If you are using a local installation of GraphViz, you will need to allow
+ everybody to access *.png,
+ *.gif, *.jpg, and
+ *.map in the
+ data/webdot directory.
+
4.2. Optional Additional Configuration
4.3. Optional Additional Configuration
4.2.1. Dependency Charts
4.3.1. Dependency Charts
As well as the text-based dependency graphs, Bugzilla also
supports dependency graphing, using a package called 'dot'.
@@ -4328,9 +4516,9 @@ CLASS="section"
>
4.2.2. Bug Graphs
4.3.2. Bug Graphs
As long as you installed the GD and Graph::Base Perl modules you
might as well turn on the nifty Bugzilla bug reporting graphs.
4.2.3. The Whining Cron
4.3.3. The Whining Cron
By now you have a fully functional Bugzilla, but what good are
bugs if they're not annoying? To help make those bugs more annoying you
@@ -4478,47 +4666,11 @@ CLASS="section"
>4.2.4. LDAP Authentication
4.3.4. LDAP Authentication
LDAP authentication has been rewritten for the 2.18 release of
- Bugzilla. It no longer requires the Mozilla::LDAP module and now uses
- Net::LDAP instead. This rewrite was part of a larger landing that
- allowed for additional authentication schemes to be easily added
- (bug
- 180642).
-
This patch originally landed in 21-Mar-2003 and was included
- in the 2.17.4 development release.
-
LDAP authentication is a module for Bugzilla's plugin
+ authentication architecture.
+
The existing authentication
scheme for Bugzilla uses email addresses as the primary user ID, and a
@@ -4728,26 +4880,26 @@ CLASS="section"
>4.2.5. Preventing untrusted Bugzilla content from executing malicious
+>4.3.5. Preventing untrusted Bugzilla content from executing malicious
Javascript code
It is possible for a Bugzilla to execute malicious Javascript
- code. Due to internationalization concerns, we are unable to
- incorporate the code changes necessary to fulfill the CERT advisory
- requirements mentioned in
+>It is possible for a Bugzilla attachment to contain malicious
+ Javascript
+ code, which would be executed in the domain of your Bugzilla, thereby
+ making it possible for the attacker to e.g. steal your login cookies.
+ Due to internationalization concerns, we are unable to
+ incorporate by default the code changes necessary to fulfill the CERT
+ advisory requirements mentioned in
http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3.
- Making the change below will fix the problem if your installation is for
- an English speaking audience.
+ If your installation is for an English speaking audience only, making the
+ change below will prevent this problem.
Telling Bugzilla to output a charset as part of the HTTP header is
- much easier in version 2.18 and higher (including any cvs
- pull after 4-May-2003 and development release after 2.17.5) than it was
- in previous versions. Simply locate the following line in
+>Simply locate the following line in
Bugzilla/CGI.pm
# Make sure that we don't send any charset headers
- $self->charset('');
+>
$self->charset('');
# Send all data using the ISO-8859-1 charset
- $self->charset('ISO-8859-1');
+>
$self->charset('ISO-8859-1');
Using <meta> tags to set the charset is not
- recommended, as there's a bug in Netscape 4.x which causes pages
- marked up in this way to load twice. See
- bug 126266
- for more information including progress toward making
- bugzilla charset aware by default.
-
4.2.6. directoryindex for the Bugzilla default page.
You should modify the <DirectoryIndex> parameter for
- the Apache virtual host running your Bugzilla installation to
- allow index.cgi as the index page for a
- directory, as well as the usual index.html,
- index.htm, and so forth.
4.2.7. Bugzilla and 4.3.6. Bugzilla and mod_perl4.2.8. 4.3.7. mod_throttle
@@ -4929,7 +5016,7 @@ CLASS="section"
>4.3. OS Specific Installation Notes4.4. OS Specific Installation Notes
Many aspects of the Bugzilla installation can be affected by the
the operating system you choose to install it on. Sometimes it can be made
@@ -4952,9 +5039,9 @@ CLASS="section"
>4.3.1. Microsoft Windows4.4.1. Microsoft Windows
Making Bugzilla work on windows is still a very painful processes.
+>Making Bugzilla work on windows is still a painful processes.
The Bugzilla Team is working to make it easier, but that goal is not
considered a top priority. If you wish to run Bugzilla, we still
recommend doing so on a Unix based system such as GNU/Linux. As of this
@@ -4978,7 +5065,7 @@ CLASS="section"
>4.3.1.1. Win32 Perl4.4.1.1. Win32 Perl
Perl for Windows can be obtained from 4.3.1.2. Perl Modules on Win324.4.1.2. Perl Modules on Win32
Bugzilla on Windows requires the same perl modules found in
Section 4.1.3Section 4.1.5. The main difference is that
windows uses 4.3.1.3. Code changes required to run on win324.4.1.3. Code changes required to run on win32
Unfortunately, Bugzilla still doesn't run "out of the box" on
- Windows. There is work in progress to make this easier, but until that
- happens code will have to be modified. This section is an attempt to
- list the required changes. It is an attempt to be all inclusive, but
- there may be other changes required. If you find something is missing,
- please file a bug in Bugzilla Documentation.
+>As Bugzilla still doesn't run "out of the box" on
+ Windows, code has to be modified. This section is an attempt to
+ list the required changes.
4.3.1.3.1. Changes to 4.4.1.3.1. Changes to checksetup.pl4.3.1.3.2. Changes to 4.4.1.3.2. Changes to BugMail.pmbug
84876 lands), the
- simplest way is to have Net::SMTP installed and change this (in
- Bugzilla/BugMail.pm):
4.3.1.4. Serving the web pages4.4.1.4. Serving the web pages
As is the case on Unix based systems, any web server should be
able to handle Bugzilla; however, the Bugzilla Team still recommends
Apache whenever asked. No matter what web server you choose, be sure
to pay attention to the security notes in Section 5.6.4Section 4.5.4.
More information on configuring specific web servers can be found in
Section 4.4Section 4.2.
4.3.2. 4.4.2. Mac OS X4.3.3. Linux-Mandrake 8.04.4.3. Linux-Mandrake 8.0
Linux-Mandrake 8.0 includes every required and optional library
for Bugzilla. The easiest way to install them is by using the
@@ -5652,459 +5729,9 @@ CLASS="section"
>
4.4. HTTP Server Configuration
The Bugzilla Team recommends Apache when using Bugzilla, however, any web server
- that can be configured to run CGI scripts
- should be able to handle Bugzilla. No matter what web server you choose, but
- especially if you choose something other than Apache, you should be sure to read
- Section 5.6.4.
-
The plan for this section is to eventually document the specifics of how to lock
- down permissions on individual web servers.
-
4.4.1. Apache httpd
As mentioned above, the Bugzilla Team recommends Apache for use
- with Bugzilla. You will have to make sure that Apache is properly
- configured to run the Bugzilla CGI scripts. You also need to make sure
- that the .htaccess files created by
- ./checksetup.pl (shown in Example 4-2
- for the curious) are allowed to override Apache's normal access
- permissions or else important password information may be exposed to the
- Internet.
-
Many Apache installations are not configured to run scripts
- anywhere but in the cgi-bin
- directory; however, we recommend that Bugzilla not be installed in the
- cgi-bin, otherwise the static
- files such as images and JavaScript
- will not work correctly. To allow scripts to run in the normal
- web space, the following changes should be made to your
- httpd.conf file.
-
To allow files with a .cgi extension to be run, make sure the
- following line exists and is uncommented:
AddHandler cgi-script .cgi
-
To allow .htaccess files to override
- permissions and .cgi files to run in the Bugzilla directory, make sure
- the following two lines are in a Directory
- directive that applies to the Bugzilla directory on your system
- (either the Bugzilla directory or one of its parents).
-
Options +ExecCGI
-AllowOverride Limit
-
For more information on Apache and its directives, see the
- glossary entry on Apache.
-
Example 4-2. .htaccess files for Apache
$BUGZILLA_HOME/.htaccess
-
# don't allow people to retrieve non-cgi executable files or our private data
-<FilesMatch ^(.*\.pl|.*localconfig.*|runtests.sh)$>
- deny from all
-</FilesMatch>
-<FilesMatch ^(localconfig.js|localconfig.rdf)$>
- allow from all
-</FilesMatch>
-
-
$BUGZILLA_HOME/data/.htaccess
-
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory; the only exception is duplicates.rdf, which is used by
-# duplicates.xul and must be loadable over the web
-deny from all
-<Files duplicates.rdf>
- allow from all
-</Files>
-
-
$BUGZILLA_HOME/data/webdot
-
# Restrict access to .dot files to the public webdot server at research.att.com
-# if research.att.com ever changed their IP, or if you use a different
-# webdot server, you'll need to edit this
-<FilesMatch ^[0-9]+\.dot$>
- Allow from 192.20.225.10
- Deny from all
-</FilesMatch>
-
-# Allow access by a local copy of 'dot' to .png, .gif, .jpg, and
-# .map files
-<FilesMatch ^[0-9]+\.(png|gif|jpg|map)$>
- Allow from all
-</FilesMatch>
-
-# And no directory listings, either.
-Deny from all
-
-
$BUGZILLA_HOME/Bugzilla/.htaccess
-
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
-
-
$BUGZILLA_HOME/template/.htaccess
-
# nothing in this directory is retrievable unless overriden by an .htaccess
-# in a subdirectory
-deny from all
-
-
4.4.2. Microsoft Internet Information Services
If you need, or for some reason even want, to use Microsoft's
- Internet Information Services or
- Personal Web Server you should be able
- to. You will need to configure them to know how to run CGI scripts,
- however. This is described in Microsoft Knowledge Base article
- Q245225
- for Internet Information Services and
- Q231998
- for Personal Web Server.
-
Also, and this can't be stressed enough, make sure that files such as
- localconfig and your data
- directory are secured as described in Section 5.6.4.
-
4.4.3. AOL Server
Ben FrantzDale reported success using AOL Server with Bugzilla. He
- reported his experience and what appears below is based on that.
-
AOL Server will have to be configured to run
- CGI scripts, please consult
- the documentation that came with your server for more information on
- how to do this.
-
Because AOL Server doesn't support .htaccess
- files, you'll have to create a TCL
- script. You should create an aolserver/modules/tcl/filter.tcl
- file (the filename shouldn't matter) with the following contents (change
- /bugzilla/ to the web-based path to
- your Bugzilla installation):
-
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
-ns_register_filter preauth GET /bugzilla/localconfig~ filter_deny
-ns_register_filter preauth GET /bugzilla/\#localconfig\# filter_deny
-ns_register_filter preauth GET /bugzilla/*.pl filter_deny
-ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny
-ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny
-ns_register_filter preauth GET /bugzilla/data/* filter_deny
-ns_register_filter preauth GET /bugzilla/template/* filter_deny
-
-proc filter_deny { why } {
- ns_log Notice "filter_deny"
- return "filter_return"
-}
-
4.5. Bugzilla Security
This probably doesn't account for all possible editor backup
- files so you may wish to add some additional variations of
- localconfig. For more information, see
-
bug 186383 or Bugtraq ID 6501.
-
Poorly-configured MySQL and Bugzilla installations have
+ given attackers full access to systems in the past. Please take these
+ guidelines seriously, even for Bugzilla machines hidden away behind
+ your firewall. 80% of all computer trespassers are insiders, not
+ anonymous crackers.
This is not meant to be a comprehensive list of every possible
+ security issue pertaining to the software mentioned in this section.
+ There is
+ no subsitute for reading the information written by the authors of any
+ software running on your system.
+
4.5.1. TCP/IP Ports
TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla
+ only needs 1, or 2 if you need to use features that require e-mail such
+ as bug moving or the e-mail interface from contrib. You should audit
+ your server and make sure that you aren't listening on any ports you
+ don't need to be. You may also wish to use some kind of firewall
+ software to be sure that trafic can only be recieved on ports you
+ specify.
+
4.5.2. MySQL
MySQL ships by default with many settings that should be changed.
+ By defaults it allows anybody to connect from localhost without a
+ password and have full administrative capabilities. It also defaults to
+ not have a root password (this is not the same as
+ the system root). Also, many installations default to running
+ mysqld as the system root.
+
Consult the documentation that came with your system for
+ information on making mysqld run as an
+ unprivleged user.
+
You should also be sure to disable the anonymous user account
+ and set a password for the root user. This is accomplished using the
+ following commands:
+
bash$ mysql mysql
+mysql> DELETE FROM user WHERE user = '';
+mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
+mysql> FLUSH PRIVILEGES;
+
From this point forward you will need to use
+ mysql -u root -p and enter
+ new_password when prompted when using the
+ mysql client.
+
If you run MySQL on the same machine as your httpd server, you
+ should consider disabling networking from within MySQL by adding
+ the following to your /etc/my.conf:
+
[myslqd]
+# Prevent network access to MySQL.
+skip-networking
+
You may also consider running MySQL, or even all of Bugzilla
+ in a chroot jail; however, instructions for doing that are beyond
+ the scope of this document.
+
4.5.3. Daemon Accounts
Many daemons, such as Apache's httpd and MySQL's mysqld default to
+ running as either "root" or "nobody". Running
+ as "root" introduces obvious security problems, but the
+ problems introduced by running everything as "nobody" may
+ not be so obvious. Basically, if you're running every daemon as
+ "nobody" and one of them gets compromised, they all get
+ compromised. For this reason it is recommended that you create a user
+ account for each daemon.
+
If you are using webdot from research.att.com (the default
- configuration for the webdotbase paramater), you
- will need to allow access to You will need to set the webservergroup to
+ the group you created for your webserver to run as in
+ data/webdot/*.dot
- for the reasearch.att.com machine.
+>localconfig. This will allow
+ ./checksetup.pl to better adjust the file
+ permissions on your Bugzilla install so as to not require making
+ anything world-writable.
4.5.4. Web Server Access Controls
If you are using a local installation of GraphViz, you will need to allow
- everybody to access There are many files that are placed in the Bugzilla directory
+ area that should not be accessable from the web. Because of the way
+ Bugzilla is currently laid out, the list of what should and should
+ not be accessible is rather complicated.
+
Users of Apache don't need to worry about this, however, because
+ Bugzilla ships with .htaccess files which restrict access to all the
+ sensitive files in this section. Users of other webservers, read on.
+
In the main Bugzilla directory, you should:
Block:
+ *.pl, *localconfig*, runtests.sh
+
But allow:
+ localconfig.js, localconfig.rdf
+
In data:
Block everything
But allow:
+ duplicates.rdf
+
In data/webdot:
If you use a remote webdot server:
Block everything
But allow
+ *.dot
+ only for the remote webdot server
Otherwise, if you use a local GraphViz:
Block everything
But allow:
+ *.png,
- , *.gif, *.jpg, and
- , *.map in the
-
+
And if you don't use any dot:
Block everything
In data/webdot directory.
+>Bugzilla:
Block everything
In template:
Block everything
You should test to make sure that the files mentioned above are
+ not accessible from the Internet, especially your
+ localconfig file which contains your database
+ password. To test, simply point your web browser at the file; for
+ example, to test mozilla.org's installation, we'd try to access
+ http://bugzilla.mozilla.org/localconfig. You should
+ get a 403Forbidden
+ error.
+
Not following the instructions in this section, including
+ testing, may result in sensitive information being globally
+ accessible.
+
You should check Section 4.2 to see if instructions
+ have been included for your web server. You should also compare those
+ instructions with this list to make sure everything is properly
+ accounted for.
4.5. Troubleshooting4.6. Troubleshooting
This section gives solutions to common Bugzilla installation
problems.
@@ -6227,9 +6290,9 @@ CLASS="section"
>
4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1
4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1
Try executing
4.5.2. DBD::Sponge::db prepare failed
4.6.2. DBD::Sponge::db prepare failed
The following error message may appear due to a bug in DBD::mysql
(over which the Bugzilla team have no control):
@@ -6340,7 +6403,7 @@ CLASS="section"
>4.5.3. cannot chdir(/var/spool/mqueue)4.6.3. cannot chdir(/var/spool/mqueue)
If you are installing Bugzilla on SuSE Linux, or some other
distributions with
@@ -6398,7 +6461,7 @@ CLASS="section"
>4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT4.6.4. Your vendor has not defined Fcntl macro O_NOINHERIT
This is caused by a bug in the version of
The
As a guide, mozilla.org began needing
+>
As a guide, on reasonably old hardware, mozilla.org began needing
"shadowdb"
Don't disable the administrator account!
Don't disable all the administrator accounts!
5.3. Product, Component, Milestone, and Version Administration
5.3.1. Products
5.3. Products
Products
Products
- are the broadest category in Bugzilla, and tend to represent real-world
- shipping products. E.g. if your company makes computer games,
- you should have one product per game, perhaps a "Common" product for
- units of technology used in multiple games, and maybe a few special
- products (Website, Administration...)
Many of Bugzilla's settings are configurable on a per-product
- basis. The number of "votes" available to users is set per-product,
- as is the number of votes
- required to move a bug automatically from the UNCONFIRMED status to the
- NEW status.
To create a new product:
Enter the name of the product and a description. The
- Description field may contain HTML.
Don't worry about the "Closed for bug entry", "Maximum Votes
- per person", "Maximum votes a person can put on a single bug",
- "Number of votes a bug in this Product needs to automatically get out
- of the UNCOMFIRMED state", and "Version" options yet. We'll cover
- those in a few moments.
-
5.3.2. Components
5.4. Components
Components are subsections of a Product. E.g. the computer game
- you are designing may have a "UI"
- component, an "API" component, a "Sound System" component, and a
- "Plugins" component, each overseen by a different programmer. It
- often makes sense to divide Components in Bugzilla according to the
- natural divisions of responsibility within your Product or
- company.
Each component has a owner and (if you turned it on in the parameters),
- a QA Contact. The owner should be the primary person who fixes bugs in
- that component. The QA Contact should be the person who will ensure
- these bugs are completely fixed. The Owner, QA Contact, and Reporter
- will get email when new bugs are created in this Component and when
- these bugs change. Default Owner and Default QA Contact fields only
- dictate the
-
Each component has a owner and (if you turned it on in the parameters),
+ a QA Contact. The owner should be the primary person who fixes bugs in
+ that component. The QA Contact should be the person who will ensure
+ these bugs are completely fixed. The Owner, QA Contact, and Reporter
+ will get email when new bugs are created in this Component and when
+ these bugs change. Default Owner and Default QA Contact fields only
+ dictate the
+ default assignments;
- these can be changed on bug submission, or at any later point in
- a bug's life.
To create a new Component:
Select the "Edit components" link from the "Edit product"
- page
Fill out the "Component" field, a short "Description",
- the "Initial Owner" and "Initial QA Contact" (if enabled.)
- The Component and Description fields may contain HTML;
- the "Initial Owner" field must be a login name
- already existing in the database.
-
5.3.3. Versions
5.5. Versions
Versions are the revisions of the product, such as "Flinders
- 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select
- field; the usual practice is to select the most recent version with
- the bug.
-
To create and edit Versions:
You will notice that the product already has the default
- version "undefined". Click the "Add" link in the bottom right.
Enter the name of the Version. This field takes text only.
- Then click the "Add" button.
5.3.4. Milestones
5.6. Milestones
Milestones are "targets" that you plan to get a bug fixed by. For
- example, you have a bug that you plan to fix for your 3.0 release, it
- would be assigned the milestone of 3.0.
Milestone options will only appear for a Product if you turned
- on the "usetargetmilestone" Param in the "Edit Parameters" screen.
-
To create new Milestones, set Default Milestones, and set
- Milestone URL:
Select "Add" in the bottom right corner.
- text
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) that defines where in the list this particular
- milestone appears. This is because milestones often do not
- occur in alphanumeric order For example, "Future" might be
- after "Release 1.2". Select "Add".
From the Edit product screen, you can enter the URL of a
- page which gives information about your milestones and what
- they mean.
If you want your milestone document to be restricted so
- that it can only be viewed by people in a particular Bugzilla
- group, the best way is to attach the document to a bug in that
- group, and make the URL the URL of that attachment.
5.4. Voting
5.7. Voting
Voting allows users to be given a pot of votes which they can allocate
to bugs, to indicate that they'd like them fixed.
@@ -7481,7 +7506,7 @@ CLASS="section"
>5.5. Groups and Group Security5.8. Groups and Group Security
Groups allow the administrator
to isolate bugs or products that should only be seen by certain people.
@@ -7620,9 +7645,10 @@ ALT="Warning">
The User Regexp is a perl regexp and, if not anchored, will match
- any part of an address. So, if you do not want to grant access
- into 'mycompany.com' to 'badperson@mycompany.com.hacker.net', use
+>If specifying a domain in the regexp, make sure you end
+ the regexp with a $. Otherwise, when granting access to
+ "@mycompany\.com", you will allow access to
+ 'badperson@mycompany.com.cracker.net'. You need to use
'@mycompany\.com$' as the regexp.
5.6. Bugzilla Security
Poorly-configured MySQL and Bugzilla installations have
- given attackers full access to systems in the past. Please take these
- guidelines seriously, even for Bugzilla machines hidden away behind
- your firewall. 80% of all computer trespassers are insiders, not
- anonymous crackers.
These instructions must, of necessity, be somewhat vague since
- Bugzilla runs on so many different platforms. If you have refinements
- of these directions, please submit a bug to Bugzilla Documentation.
-
This is not meant to be a comprehensive list of every possible
- security issue regarding the tools mentioned in this section. There is
- no subsitute for reading the information written by the authors of any
- software running on your system.
-
5.6.1. TCP/IP Ports
TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla
- only needs 1... 2 if you need to use features that require e-mail such
- as bug moving or the e-mail interface from contrib. You should audit
- your server and make sure that you aren't listening on any ports you
- don't need to be. You may also wish to use some kind of firewall
- software to be sure that trafic can only be recieved on ports you
- specify.
-
5.6.2. MySQL
MySQL ships by default with many settings that should be changed.
- By defaults it allows anybody to connect from localhost without a
- password and have full administrative capabilities. It also defaults to
- not have a root password (this is not the same as
- the system root). Also, many installations default to running
- mysqld as the system root.
-
Consult the documentation that came with your system for
- information on making mysqld run as an
- unprivleged user.
-
You should also be sure to disable the anonymous user account
- and set a password for the root user. This is accomplished using the
- following commands:
-
bash$ mysql mysql
-mysql> DELETE FROM user WHERE user = '';
-mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
-mysql> FLUSH PRIVILEGES;
-
From this point forward you will need to use
- mysql -u root -p and enter
- new_password when prompted when using the
- mysql client.
-
If you run MySQL on the same machine as your httpd server, you
- should consider disabling networking from within MySQL by adding
- the following to your /etc/my.conf:
-
[myslqd]
-# Prevent network access to MySQL.
-skip-networking
-
You may also consider running MySQL, or even all of Bugzilla
- in a chroot jail; however, instructions for doing that are beyond
- the scope of this document.
-
5.6.3. Daemon Accounts
Many daemons, such as Apache's httpd and MySQL's mysqld default to
- running as either "root" or "nobody". Running
- as "root" introduces obvious security problems, but the
- problems introduced by running everything as "nobody" may
- not be so obvious. Basically, if you're running every daemon as
- "nobody" and one of them gets comprimised, they all get
- comprimised. For this reason it is recommended that you create a user
- account for each daemon.
-
You will need to set the webservergroup to
- the group you created for your webserver to run as in
- localconfig. This will allow
- ./checksetup.pl to better adjust the file
- permissions on your Bugzilla install so as to not require making
- anything world-writable.
-
5.6.4. Web Server Access Controls
There are many files that are placed in the Bugzilla directory
- area that should not be accessable from the web. Because of the way
- Bugzilla is currently layed out, the list of what should and should
- not be accessible is rather complicated. A new installation method
- is currently in the works which should solve this by allowing files
- that shouldn't be accessible from the web to be placed in directory
- outside the webroot. See
-
bug 44659 for more information.
-
In the main Bugzilla directory, you should:
Block:
- *.pl, *localconfig*, runtests.sh
-
But allow:
- localconfig.js, localconfig.rdf
-
In data:
Block everything
But allow:
- duplicates.rdf
-
In data/webdot:
If you use a remote webdot server:
Block everything
But allow
- *.dot
- only for the remote webdot server
Otherwise, if you use a local GraphViz:
Block everything
But allow:
- *.png, *.gif, *.jpg, *.map
-
And if you don't use any dot:
Block everything
In Bugzilla:
Block everything
In template:
Block everything
Bugzilla ships with the ability to generate
- .htaccess files instructing
- Apache which files
- should and should not be accessible. For more information, see
- Section 4.4.1.
-
You should test to make sure that the files mentioned above are
- not accessible from the Internet, especially your
- localconfig file which contains your database
- password. To test, simply point your web browser at the file; for
- example, to test mozilla.org's installation, we'd try to access
- http://bugzilla.mozilla.org/localconfig. You should
- get a 403Forbidden
- error.
-
Not following the instructions in this section, including
- testing, may result in sensitive information being globally
- accessible.
-
You should check Section 4.4 to see if instructions
- have been included for your web server. You should also compare those
- instructions with this list to make sure everything is properly
- accounted for.
-
5.7. Template Customization
One of the large changes for 2.16 was the templatization of the
- entire user-facing UI, using the
- Template Toolkit.
- Administrators can now configure the look and feel of Bugzilla without
- having to edit Perl files or face the nightmare of massive merge
- conflicts when they upgrade to a newer version in the future.
-
Templatization also makes localized versions of Bugzilla possible,
- for the first time. As of version 2.17.4 which will soon
- become 2.18, it's possible to have Bugzilla's language determined by
- the user's browser. More information is available in
- Section 5.7.5.
-
5.7.1. What to Edit
There are two different ways of editing of Bugzilla's templates,
- and which you use depends mainly on how you upgrade Bugzilla. The
- template directory structure is that there's a top level directory,
- template, which contains a directory for
- each installed localization. The default English templates are
- therefore in en. Underneath that, there
- is the default directory and optionally the
- custom directory. The default
- directory contains all the templates shipped with Bugzilla, whereas
- the custom directory does not exist at first and
- must be created if you want to use it.
-
The first method of making customizations is to directly edit the
- templates in template/en/default. This is
- probably the best method for small changes if you are going to use
- the CVS method of upgrading, because if you then execute a
- cvs update, any template fixes will get
- automagically merged into your modified versions.
-
If you use this method, your installation will break if CVS conflicts
- occur.
-
The other method is to copy the templates into a mirrored directory
- structure under template/en/custom. The templates
- in this directory automatically override those in default.
- This is the technique you
- need to use if you use the overwriting method of upgrade, because
- otherwise your changes will be lost. This method is also better if
- you are using the CVS method of upgrading and are going to make major
- changes, because it is guaranteed that the contents of this directory
- will not be touched during an upgrade, and you can then decide whether
- to continue using your own templates, or make the effort to merge your
- changes into the new versions by hand.
-
If you use this method, your installation may break if incompatible
- changes are made to the template interface. If such changes are made
- they will be documented in the release notes, provided you are using a
- stable release of Bugzilla. If you use using unstable code, you will
- need to deal with this one yourself, although if possible the changes
- will be mentioned before they occur in the deprecations section of the
- previous stable release's release notes.
-
Don't directly edit the compiled templates in
- data/template/* - your
- changes will be lost when Template Toolkit recompiles them.
-
It is recommended that you run ./checksetup.pl
- after any template edits, especially if you've created a new file in
- the custom directory.
-
5.7.2. How To Edit Templates
The syntax of the Template Toolkit language is beyond the scope of
- this guide. It's reasonably easy to pick up by looking at the current
- templates; or, you can read the manual, available on the
- Template Toolkit home
- page. However, you should particularly remember (for security
- reasons) to always HTML filter things which come from the database or
- user input, to prevent cross-site scripting attacks.
-
However, one thing you should take particular care about is the need
- to properly HTML filter data that has been passed into the template.
- This means that if the data can possibly contain special HTML characters
- such as <, and the data was not intended to be HTML, they need to be
- converted to entity form, ie <. You use the 'html' filter in the
- Template Toolkit to do this. If you fail to do this, you may open up
- your installation to cross-site scripting attacks.
-
Also note that Bugzilla adds a few filters of its own, that are not
- in standard Template Toolkit. In particular, the 'url_quote' filter
- can convert characters that are illegal or have special meaning in URLs,
- such as &, to the encoded form, ie %26. This actually encodes most
- characters (but not the common ones such as letters and numbers and so
- on), including the HTML-special characters, so there's never a need to
- HTML filter afterwards.
-
Editing templates is a good way of doing a "poor man's custom fields".
- For example, if you don't use the Status Whiteboard, but want to have
- a free-form text entry box for "Build Identifier", then you can just
- edit the templates to change the field labels. It's still be called
- status_whiteboard internally, but your users don't need to know that.
-
If you are making template changes that you intend on submitting back
- for inclusion in standard Bugzilla, you should read the relevant
- sections of the
- Developers'
- Guide.
-
5.7.3. Template Formats
Some CGIs have the ability to use more than one template. For
- example, buglist.cgi can output bug lists as RDF or two
- different forms of HTML (complex and simple). (Try this out
- by appending &format=simple to a buglist.cgi
- URL on your Bugzilla installation.) This
- mechanism, called template 'formats', is extensible.
-
To see if a CGI supports multiple output formats, grep the
- CGI for "ValidateOutputFormat". If it's not present, adding
- multiple format support isn't too hard - see how it's done in
- other CGIs.
-
To make a new format template for a CGI which supports this,
- open a current template for
- that CGI and take note of the INTERFACE comment (if present.) This
- comment defines what variables are passed into this template. If
- there isn't one, I'm afraid you'll have to read the template and
- the code to find out what information you get.
-
Write your template in whatever markup or text style is appropriate.
-
You now need to decide what content type you want your template
- served as. Open up the localconfig file and find the
- $contenttypes
- variable. If your content type is not there, add it. Remember
- the three- or four-letter tag assigned to you content type.
- This tag will be part of the template filename.
-
Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl.
- Try out the template by calling the CGI as
- <cginame>.cgi?format=<formatname> .
-
5.7.4. Particular Templates
There are a few templates you may be particularly interested in
- customizing for your installation.
-
index.html.tmpl:
- This is the Bugzilla front page.
-
global/header.html.tmpl:
- This defines the header that goes on all Bugzilla pages.
- The header includes the banner, which is what appears to users
- and is probably what you want to edit instead. However the
- header also includes the HTML HEAD section, so you could for
- example add a stylesheet or META tag by editing the header.
-
global/banner.html.tmpl:
- This contains the "banner", the part of the header that appears
- at the top of all Bugzilla pages. The default banner is reasonably
- barren, so you'll probably want to customize this to give your
- installation a distinctive look and feel. It is recommended you
- preserve the Bugzilla version number in some form so the version
- you are running can be determined, and users know what docs to read.
-
global/footer.html.tmpl:
- This defines the footer that goes on all Bugzilla pages. Editing
- this is another way to quickly get a distinctive look and feel for
- your Bugzilla installation.
-
bug/create/user-message.html.tmpl:
- This is a message that appears near the top of the bug reporting page.
- By modifying this, you can tell your users how they should report
- bugs.
-
bug/process/midair.html.tmpl:
- This is the page used if two people submit simultaneous changes to the
- same bug. The second person to submit their changes will get this page
- to tell them what the first person did, and ask if they wish to
- overwrite those changes or go back and revisit the bug. The default
- title and header on this page read "Mid-air collision detected!" If
- you work in the aviation industry, or other environment where this
- might be found offensive (yes, we have true stories of this happening)
- you'll want to change this to something more appropriate for your
- environment.
-
bug/create/create.html.tmpl and
- bug/create/comment.txt.tmpl:
- You may wish to get bug submitters to give certain bits of structured
- information, each in a separate input widget, for which there is not a
- field in the database. The bug entry system has been designed in an
- extensible fashion to enable you to define arbitrary fields and widgets,
- and have their values appear formatted in the initial
- Description, rather than in database fields. An example of this
- is the mozilla.org
- guided
- bug submission form.
-
To make this work, create a custom template for
- enter_bug.cgi (the default template, on which you
- could base it, is create.html.tmpl),
- and either call it create.html.tmpl or use a format and
- call it create-<formatname>.html.tmpl.
- Put it in the custom/bug/create
- directory. In it, add widgets for each piece of information you'd like
- collected - such as a build number, or set of steps to reproduce.
-
Then, create a template like
- custom/bug/create/comment.txt.tmpl, also named
- after your format if you are using one, which
- references the form fields you have created. When a bug report is
- submitted, the initial comment attached to the bug report will be
- formatted according to the layout of this template.
-
For example, if your enter_bug template had a field
-
<input type="text" name="buildid" size="30">
- and then your comment.txt.tmpl had
-
BuildID: [% form.buildid %]
- then
-
BuildID: 20020303
- would appear in the initial checkin comment.
-
5.7.5. Configuring Bugzilla to Detect the User's Language
Begining in version 2.18 (first introduced in version
- 2.17.4), it's now possible to have the users web browser tell Bugzilla
- which language templates to use for each visitor (using the HTTP_ACCEPT
- header). For this to work, Bugzilla needs to have the correct language
- templates installed for the version of Bugzilla you are using. Many
- language templates can be obtained from http://www.bugzilla.org/download.html#localizations. Instructions
- for submitting new languages are also available from that location.
-
After untarring the localizations (or creating your own) in the
- [Bugzilla_Root]/template directory,
- you must update the languages parameter to contain any
- localizations you'd like to permit. You may also wish to set the
- defaultlanguage parameter to something other than
- "en" if you don't want Engish to be the default language.
-
5.8. Change Permission Customization
This feature should be considered experimental; the Bugzilla code you
- will be changing is not stable, and could change or move between
- versions. Be aware that if you make modifications to it, you may have
- to re-make them or port them if Bugzilla changes internally between
- versions.
-
Companies often have rules about which employees, or classes of employees,
- are allowed to change certain things in the bug system. For example,
- only the bug's designated QA Contact may be allowed to VERIFY the bug.
- Bugzilla has been
- designed to make it easy for you to write your own custom rules to define
- who is allowed to make what sorts of value transition.
-
For maximum flexibility, customizing this means editing Bugzilla's Perl
- code. This gives the administrator complete control over exactly who is
- allowed to do what. The relevant function is called
- CheckCanChangeField(),
- and is found in process_bug.cgi in your
- Bugzilla directory. If you open that file and grep for
- "sub CheckCanChangeField", you'll find it.
-
This function has been carefully commented to allow you to see exactly
- how it works, and give you an idea of how to make changes to it. Certain
- marked sections should not be changed - these are the "plumbing" which
- makes the rest of the function work. In between those sections, you'll
- find snippets of code like:
-
# Allow the owner to change anything.
- if ($ownerid eq $whoid) {
- return 1;
- }
- It's fairly obvious what this piece of code does.
-
So, how does one go about changing this function? Well, simple changes
- can be made just be removing pieces - for example, if you wanted to
- prevent any user adding a comment to a bug, just remove the lines marked
- "Allow anyone to change comments." And if you want the reporter to have
- no special rights on bugs they have filed, just remove the entire section
- which refers to him.
-
More complex customizations are not much harder. Basically, you add
- a check in the right place in the function, i.e. after all the variables
- you are using have been set up. So, don't look at $ownerid before
- $ownerid has been obtained from the database. You can either add a
- positive check, which returns 1 (allow) if certain conditions are true,
- or a negative check, which returns 0 (deny.) E.g.:
-
- This says that if the user is trying to change the priority field,
- and their email address is @example.com, they can only do so if the
- old value of the field was "P1". Not very useful, but illustrative.
-
For a list of possible field names, look in
- data/versioncache for the list called
- @::log_columns. If you need help writing custom
- rules for your organization, ask in the newsgroup.
-
5.9. Upgrading to New Releases
Chapter 6. Customising Bugzilla
6.1. Template Customization
Administrators can configure the look and feel of Bugzilla without
+ having to edit Perl files or face the nightmare of massive merge
+ conflicts when they upgrade to a newer version in the future.
+
Templatization also makes localized versions of Bugzilla possible,
+ for the first time. It's possible to have Bugzilla's UI language
+ determined by the user's browser. More information is available in
+ Section 6.1.5.
+
6.1.1. What to Edit
The template directory structure is that there's a top level directory,
+ template, which contains a directory for
+ each installed localization. The default English templates are
+ therefore in en. Underneath that, there
+ is the default directory and optionally the
+ custom directory. The default
+ directory contains all the templates shipped with Bugzilla, whereas
+ the custom directory does not exist at first and
+ must be created if you want to use it.
+
There are two different ways of editing Bugzilla's templates,
+ and which you use depends mainly on the method you plan to use to
+ upgrade Bugzilla.
+ The first method of making customizations is to directly edit the
+ templates in template/en/default. This is
+ probably the best method for small changes if you are going to use
+ the CVS method of upgrading, because if you then execute a
+ cvs update, any template fixes will get
+ automagically merged into your modified versions.
+
If you use this method, your installation will break if CVS conflicts
+ occur.
+
The other method is to copy the templates to be modified into a
+ mirrored directory
+ structure under template/en/custom. The templates
+ in this directory automatically override those in default.
+ This is the technique you
+ need to use if you use the overwriting method of upgrade, because
+ otherwise your changes will be lost. This method is also better if
+ you are using the CVS method of upgrading and are going to make major
+ changes, because it is guaranteed that the contents of this directory
+ will not be touched during an upgrade, and you can then decide whether
+ to continue using your own templates, or make the effort to merge your
+ changes into the new versions by hand.
+
If you use this method, your installation may break if incompatible
+ changes are made to the template interface. If such changes are made
+ they will be documented in the release notes, provided you are using a
+ stable release of Bugzilla. If you use using unstable code, you will
+ need to deal with this one yourself, although if possible the changes
+ will be mentioned before they occur in the deprecations section of the
+ previous stable release's release notes.
+
Don't directly edit the compiled templates in
+ data/template/* - your
+ changes will be lost when Template Toolkit recompiles them.
+
It is recommended that you run ./checksetup.pl
+ after any template edits, especially if you've created a new file in
+ the custom directory.
+
6.1.2. How To Edit Templates
If you are making template changes that you intend on submitting back
+ for inclusion in standard Bugzilla, you should read the relevant
+ sections of the
+ Developers'
+ Guide.
+
The syntax of the Template Toolkit language is beyond the scope of
+ this guide. It's reasonably easy to pick up by looking at the current
+ templates; or, you can read the manual, available on the
+ Template Toolkit home
+ page.
+
One thing you should take particular care about is the need
+ to properly HTML filter data that has been passed into the template.
+ This means that if the data can possibly contain special HTML characters
+ such as <, and the data was not intended to be HTML, they need to be
+ converted to entity form, ie <. You use the 'html' filter in the
+ Template Toolkit to do this. If you forget, you may open up
+ your installation to cross-site scripting attacks.
+
Also note that Bugzilla adds a few filters of its own, that are not
+ in standard Template Toolkit. In particular, the 'url_quote' filter
+ can convert characters that are illegal or have special meaning in URLs,
+ such as &, to the encoded form, ie %26. This actually encodes most
+ characters (but not the common ones such as letters and numbers and so
+ on), including the HTML-special characters, so there's never a need to
+ HTML filter afterwards.
+
Editing templates is a good way of doing a "poor man's custom fields".
+ For example, if you don't use the Status Whiteboard, but want to have
+ a free-form text entry box for "Build Identifier", then you can just
+ edit the templates to change the field labels. It's still be called
+ status_whiteboard internally, but your users don't need to know that.
+
6.1.3. Template Formats
Some CGIs have the ability to use more than one template. For
+ example, buglist.cgi can output bug lists as RDF or two
+ different forms of HTML (complex and simple). (Try this out
+ by appending &format=simple to a buglist.cgi
+ URL on your Bugzilla installation.) This
+ mechanism, called template 'formats', is extensible.
+
To see if a CGI supports multiple output formats, grep the
+ CGI for "GetFormat". If it's not present, adding
+ multiple format support isn't too hard - see how it's done in
+ other CGIs, e.g. config.cgi.
+
To make a new format template for a CGI which supports this,
+ open a current template for
+ that CGI and take note of the INTERFACE comment (if present.) This
+ comment defines what variables are passed into this template. If
+ there isn't one, I'm afraid you'll have to read the template and
+ the code to find out what information you get.
+
Write your template in whatever markup or text style is appropriate.
+
You now need to decide what content type you want your template
+ served as. Open up the localconfig file and find the
+ $contenttypes
+ variable. If your content type is not there, add it. Remember
+ the three- or four-letter tag assigned to you content type.
+ This tag will be part of the template filename.
+
Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl.
+ Try out the template by calling the CGI as
+ <cginame>.cgi?format=<formatname> .
+
6.1.4. Particular Templates
There are a few templates you may be particularly interested in
+ customizing for your installation.
+
index.html.tmpl:
+ This is the Bugzilla front page.
+
global/header.html.tmpl:
+ This defines the header that goes on all Bugzilla pages.
+ The header includes the banner, which is what appears to users
+ and is probably what you want to edit instead. However the
+ header also includes the HTML HEAD section, so you could for
+ example add a stylesheet or META tag by editing the header.
+
global/banner.html.tmpl:
+ This contains the "banner", the part of the header that appears
+ at the top of all Bugzilla pages. The default banner is reasonably
+ barren, so you'll probably want to customize this to give your
+ installation a distinctive look and feel. It is recommended you
+ preserve the Bugzilla version number in some form so the version
+ you are running can be determined, and users know what docs to read.
+
global/footer.html.tmpl:
+ This defines the footer that goes on all Bugzilla pages. Editing
+ this is another way to quickly get a distinctive look and feel for
+ your Bugzilla installation.
+
bug/create/user-message.html.tmpl:
+ This is a message that appears near the top of the bug reporting page.
+ By modifying this, you can tell your users how they should report
+ bugs.
+
bug/create/create.html.tmpl and
+ bug/create/comment.txt.tmpl:
+ You may wish to get bug submitters to give certain bits of structured
+ information, each in a separate input widget, for which there is not a
+ field in the database. The bug entry system has been designed in an
+ extensible fashion to enable you to define arbitrary fields and widgets,
+ and have their values appear formatted in the initial
+ Description, rather than in database fields. An example of this
+ is the mozilla.org
+ guided
+ bug submission form.
+
To make this work, create a custom template for
+ enter_bug.cgi (the default template, on which you
+ could base it, is create.html.tmpl),
+ and either call it create.html.tmpl or use a format and
+ call it create-<formatname>.html.tmpl.
+ Put it in the custom/bug/create
+ directory. In it, add widgets for each piece of information you'd like
+ collected - such as a build number, or set of steps to reproduce.
+
Then, create a template like
+ custom/bug/create/comment.txt.tmpl, also named
+ after your format if you are using one, which
+ references the form fields you have created. When a bug report is
+ submitted, the initial comment attached to the bug report will be
+ formatted according to the layout of this template.
+
For example, if your enter_bug template had a field
+
<input type="text" name="buildid" size="30">
+ and then your comment.txt.tmpl had
+
BuildID: [% form.buildid %]
+ then
+
BuildID: 20020303
+ would appear in the initial checkin comment.
+
6.1.5. Configuring Bugzilla to Detect the User's Language
Bugzilla honours the user's Accept: HTTP header. You can install
+ templates in other languages, and Bugzilla will pick the most appropriate
+ according to a priority order defined by you. Many
+ language templates can be obtained from http://www.bugzilla.org/download.html#localizations. Instructions
+ for submitting new languages are also available from that location.
+
After untarring the localizations (or creating your own) in the
+ $BUGZILLA_HOME/template directory,
+ you must update the languages parameter to contain any
+ localizations you'd like to permit. You may also wish to set the
+ defaultlanguage parameter to something other than
+ "en" if you don't want Engish to be the default language.
+
6.2. Customizing Who Can Change What
This feature should be considered experimental; the Bugzilla code you
+ will be changing is not stable, and could change or move between
+ versions. Be aware that if you make modifications as outlined here,
+ you may have
+ to re-make them or port them if Bugzilla changes internally between
+ versions, and you upgrade.
+
Companies often have rules about which employees, or classes of employees,
+ are allowed to change certain things in the bug system. For example,
+ only the bug's designated QA Contact may be allowed to VERIFY the bug.
+ Bugzilla has been
+ designed to make it easy for you to write your own custom rules to define
+ who is allowed to make what sorts of value transition.
+
For maximum flexibility, customizing this means editing Bugzilla's Perl
+ code. This gives the administrator complete control over exactly who is
+ allowed to do what. The relevant function is called
+ CheckCanChangeField(),
+ and is found in process_bug.cgi in your
+ Bugzilla directory. If you open that file and grep for
+ "sub CheckCanChangeField", you'll find it.
+
This function has been carefully commented to allow you to see exactly
+ how it works, and give you an idea of how to make changes to it. Certain
+ marked sections should not be changed - these are the "plumbing" which
+ makes the rest of the function work. In between those sections, you'll
+ find snippets of code like:
+
# Allow the owner to change anything.
+ if ($ownerid eq $whoid) {
+ return 1;
+ }
+ It's fairly obvious what this piece of code does.
+
So, how does one go about changing this function? Well, simple changes
+ can be made just be removing pieces - for example, if you wanted to
+ prevent any user adding a comment to a bug, just remove the lines marked
+ "Allow anyone to change comments." And if you want the reporter to have
+ no special rights on bugs they have filed, just remove the entire section
+ which refers to him.
+
More complex customizations are not much harder. Basically, you add
+ a check in the right place in the function, i.e. after all the variables
+ you are using have been set up. So, don't look at $ownerid before
+ $ownerid has been obtained from the database. You can either add a
+ positive check, which returns 1 (allow) if certain conditions are true,
+ or a negative check, which returns 0 (deny.) E.g.:
+
+ This says that if the user is trying to change the priority field,
+ and their email address is @example.com, they can only do so if the
+ old value of the field was "P1". Not very useful, but illustrative.
+
For a list of possible field names, look in
+ data/versioncache for the list called
+ @::log_columns. If you need help writing custom
+ rules for your organization, ask in the newsgroup.
+
6.3. Modifying Your Running System
Bugzilla optimizes database lookups by storing all relatively
+ static information in the
+ versioncache file, located in the
+ data/
+ subdirectory under your installation directory.
If you make a change to the structural data in your database (the
+ versions table for example), or to the
+ "constants"
+
+ encoded in defparams.pl, you will need to remove
+ the cached content from the data directory (by doing a
+ "rm data/versioncache"
+
+ ), or your changes won't show up.
versioncache
+ gets automatically regenerated whenever it's more than
+ an hour old, so Bugzilla will eventually notice your changes by itself,
+ but generally you want it to notice right away, so that you can test
+ things.
6.4. MySQL Bugzilla Database Introduction
This information comes straight from my life. I was forced to learn
+ how Bugzilla organizes database because of nitpicky requests from users
+ for tiny changes in wording, rather than having people re-educate
+ themselves or figure out how to work our procedures around the tool. It
+ sucks, but it can and will happen to you, so learn how the schema works
+ and deal with it when it comes.
So, here you are with your brand-new installation of Bugzilla.
+ You've got MySQL set up, Apache working right, Perl DBI and DBD talking
+ to the database flawlessly. Maybe you've even entered a few test bugs to
+ make sure email's working; people seem to be notified of new bugs and
+ changes, and you can enter and edit bugs to your heart's content. Perhaps
+ you've gone through the trouble of setting up a gateway for people to
+ submit bugs to your database via email, have had a few people test it,
+ and received rave reviews from your beta testers.
What's the next thing you do? Outline a training strategy for your
+ development team, of course, and bring them up to speed on the new tool
+ you've labored over for hours.
Your first training session starts off very well! You have a
+ captive audience which seems enraptured by the efficiency embodied in
+ this thing called "Bugzilla". You are caught up describing the nifty
+ features, how people can save favorite queries in the database, set them
+ up as headers and footers on their pages, customize their layouts,
+ generate reports, track status with greater efficiency than ever before,
+ leap tall buildings with a single bound and rescue Jane from the clutches
+ of Certain Death!
But Certain Death speaks up -- a tiny voice, from the dark corners
+ of the conference room. "I have a concern," the voice hisses from the
+ darkness, "about the use of the word 'verified'."
The room, previously filled with happy chatter, lapses into
+ reverential silence as Certain Death (better known as the Vice President
+ of Software Engineering) continues. "You see, for two years we've used
+ the word 'verified' to indicate that a developer or quality assurance
+ engineer has confirmed that, in fact, a bug is valid. I don't want to
+ lose two years of training to a new software product. You need to change
+ the bug status of 'verified' to 'approved' as soon as possible. To avoid
+ confusion, of course."
Oh no! Terror strikes your heart, as you find yourself mumbling
+ "yes, yes, I don't think that would be a problem," You review the changes
+ with Certain Death, and continue to jabber on, "no, it's not too big a
+ change. I mean, we have the source code, right? You know, 'Use the
+ Source, Luke' and all that... no problem," All the while you quiver
+ inside like a beached jellyfish bubbling, burbling, and boiling on a hot
+ Jamaican sand dune...
Thus begins your adventure into the heart of Bugzilla. You've been
+ forced to learn about non-portable enum() fields, varchar columns, and
+ tinyint definitions. The Adventure Awaits You!
6.4.1. Bugzilla Database Basics
If you were like me, at this point you're totally clueless about
+ the internals of MySQL, and if it weren't for this executive order from
+ the Vice President you couldn't care less about the difference between
+ a
+ "bigint"
+
+ and a
+ "tinyint"
+
+ entry in MySQL. I recommend you refer to the
+ MySQL documentation
+ . Below are the basics you need to know about the Bugzilla database.
+ Check the chart above for more details.
To connect to your database:
bash#
+
+ mysql
+
+ -u root
+
If this works without asking you for a password,
+ shame on you
+
+ ! You should have locked your security down like the installation
+ instructions told you to. You can find details on locking down
+ your database in the Bugzilla FAQ in this directory (under
+ "Security"), or more robust security generalities in the
+ MySQL
+ searchable documentation.
+
You should now be at a prompt that looks like this:
mysql>
+
At the prompt, if
+ "bugs"
+
+ is the name you chose in the
+ localconfig
+
+ file for your Bugzilla database, type:
mysql
+
+ use bugs;
+
+
6.4.1.1. Bugzilla Database Tables
Imagine your MySQL database as a series of spreadsheets, and
+ you won't be too far off. If you use this command:
mysql>
+ show tables from bugs;
+
you'll be able to see the names of all the
+ "spreadsheets"
+ (tables) in your database.
From the command issued above, ou should have some
+ output that looks like this:
+
+ Here's an overview of what each table does. Most columns in each table have
+descriptive names that make it fairly trivial to figure out their jobs.
+
+attachments: This table stores all attachments to bugs. It tends to be your
+largest table, yet also generally has the fewest entries because file
+attachments are so (relatively) large.
+
+bugs: This is the core of your system. The bugs table stores most of the
+current information about a bug, with the exception of the info stored in the
+other tables.
+
+bugs_activity: This stores information regarding what changes are made to bugs
+when -- a history file.
+
+cc: This tiny table simply stores all the CC information for any bug which has
+any entries in the CC field of the bug. Note that, like most other tables in
+Bugzilla, it does not refer to users by their user names, but by their unique
+userid, stored as a primary key in the profiles table.
+
+components: This stores the programs and components (or products and
+components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"
+(product) field is the full name of the product, rather than some other unique
+identifier, like bug_id and user_id are elsewhere in the database.
+
+dependencies: Stores data about those cool dependency trees.
+
+fielddefs: A nifty table that defines other tables. For instance, when you
+submit a form that changes the value of "AssignedTo" this table allows
+translation to the actual field name "assigned_to" for entry into MySQL.
+
+groups: defines bitmasks for groups. A bitmask is a number that can uniquely
+identify group memberships. For instance, say the group that is allowed to
+tweak parameters is assigned a value of "1", the group that is allowed to edit
+users is assigned a "2", and the group that is allowed to create new groups is
+assigned the bitmask of "4". By uniquely combining the group bitmasks (much
+like the chmod command in UNIX,) you can identify a user is allowed to tweak
+parameters and create groups, but not edit users, by giving him a bitmask of
+"5", or a user allowed to edit users and create groups, but not tweak
+parameters, by giving him a bitmask of "6" Simple, huh?
+ If this makes no sense to you, try this at the mysql prompt:
+mysql> select * from groups;
+ You'll see the list, it makes much more sense that way.
+
+keyworddefs: Definitions of keywords to be used
+
+keywords: Unlike what you'd think, this table holds which keywords are
+associated with which bug id's.
+
+logincookies: This stores every login cookie ever assigned to you for every
+machine you've ever logged into Bugzilla from. Curiously, it never does any
+housecleaning -- I see cookies in this file I've not used for months. However,
+since Bugzilla never expires your cookie (for convenience' sake), it makes
+sense.
+
+longdescs: The meat of bugzilla -- here is where all user comments are stored!
+You've only got 2^24 bytes per comment (it's a mediumtext field), so speak
+sparingly -- that's only the amount of space the Old Testament from the Bible
+would take (uncompressed, 16 megabytes). Each comment is keyed to the
+bug_id to which it's attached, so the order is necessarily chronological, for
+comments are played back in the order in which they are received.
+
+milestones: Interesting that milestones are associated with a specific product
+in this table, but Bugzilla does not yet support differing milestones by
+product through the standard configuration interfaces.
+
+namedqueries: This is where everybody stores their "custom queries". Very
+cool feature; it beats the tar out of having to bookmark each cool query you
+construct.
+
+products: What products you have, whether new bug entries are allowed for the
+product, what milestone you're working toward on that product, votes, etc. It
+will be nice when the components table supports these same features, so you
+could close a particular component for bug entry without having to close an
+entire product...
+
+profiles: Ahh, so you were wondering where your precious user information was
+stored? Here it is! With the passwords in plain text for all to see! (but
+sshh... don't tell your users!)
+
+profiles_activity: Need to know who did what when to who's profile? This'll
+tell you, it's a pretty complete history.
+
+versions: Version information for every product
+
+votes: Who voted for what when
+
+watch: Who (according to userid) is watching who's bugs (according to their
+userid).
+
+
+===
+THE DETAILS
+===
+
+ Ahh, so you're wondering just what to do with the information above? At the
+mysql prompt, you can view any information about the columns in a table with
+this command (where "table" is the name of the table you wish to view):
+
+mysql> show columns from table;
+
+ You can also view all the data in a table with this command:
+
+mysql> select * from table;
+
+ -- note: this is a very bad idea to do on, for instance, the "bugs" table if
+you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or
+50,000 bugs play across your screen.
+
+ You can limit the display from above a little with the command, where
+"column" is the name of the column for which you wish to restrict information:
+
+mysql> select * from table where (column = "some info");
+
+ -- or the reverse of this
+
+mysql> select * from table where (column != "some info");
+
+ Let's take our example from the introduction, and assume you need to change
+the word "verified" to "approved" in the resolution field. We know from the
+above information that the resolution is likely to be stored in the "bugs"
+table. Note we'll need to change a little perl code as well as this database
+change, but I won't plunge into that in this document. Let's verify the
+information is stored in the "bugs" table:
+
+mysql> show columns from bugs
+
+ (exceedingly long output truncated here)
+| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||
+
+ Sorry about that long line. We see from this that the "bug status" column is
+an "enum field", which is a MySQL peculiarity where a string type field can
+only have certain types of entries. While I think this is very cool, it's not
+standard SQL. Anyway, we need to add the possible enum field entry
+'APPROVED' by altering the "bugs" table.
+
+mysql> ALTER table bugs CHANGE bug_status bug_status
+ -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
+ -> "VERIFIED", "APPROVED", "CLOSED") not null;
+
+ (note we can take three lines or more -- whatever you put in before the
+semicolon is evaluated as a single expression)
+
+Now if you do this:
+
+mysql> show columns from bugs;
+
+ you'll see that the bug_status field has an extra "APPROVED" enum that's
+available! Cool thing, too, is that this is reflected on your query page as
+well -- you can query by the new status. But how's it fit into the existing
+scheme of things?
+ Looks like you need to go back and look for instances of the word "verified"
+in the perl code for Bugzilla -- wherever you find "verified", change it to
+"approved" and you're in business (make sure that's a case-insensitive search).
+Although you can query by the enum field, you can't give something a status
+of "APPROVED" until you make the perl changes. Note that this change I
+mentioned can also be done by editing checksetup.pl, which automates a lot of
+this. But you need to know this stuff anyway, right?
+
5.10. Integrating Bugzilla with Third-Party Tools
6.5. Integrating Bugzilla with Third-Party Tools
5.10.1. Bonsai
6.5.1. Bonsai
Bonsai is a web-based tool for managing
5.10.2. CVS6.5.2. CVS
CVS integration is best accomplished, at this point, using the
Bugzilla Email Gateway.
5.10.3. Perforce SCM6.5.3. Perforce SCM
You can find the project page for Bugzilla and Teamtrack Perforce
integration (p4dti) at:
@@ -9681,9 +9502,22 @@ CLASS="section"
>5.10.4. Tinderbox/Tinderbox26.5.4. Tinderbox/Tinderbox2
A.1.2. A.1.1.
What license is Bugzilla distributed under?
A.1.3. A.1.2.
How do I get commercial support for Bugzilla?
http://www.collab.net/ offers
- Bugzilla as part of their standard offering to large projects.
- They do have some minimum fees that are pretty hefty, and generally
- aren't interested in small projects.
-
There are several experienced
Bugzilla hackers on the mailing list/newsgroup who are willing
to make themselves available for generous compensation.
@@ -10304,7 +10039,7 @@ CLASS="question"
NAME="faq-general-companies"
>A.1.4. A.1.3.
What major companies or projects are currently using Bugzilla
for bug-tracking?
@@ -10322,9 +10057,9 @@ CLASS="answer"
Bugzilla sites to track bugs in their products. We have a fairly
complete list available on our website at
http://bugzilla.org/installation_list.htmlhttp://bugzilla.org/installation-list/. If you
have an installation of Bugzilla and would like to be added to the
list, whether it's a public install or not, simply e-mail
@@ -10334,11 +10069,7 @@ CLASS="email"
HREF="mailto:gerv@mozilla.org"
>gerv@mozilla.org>. Keep in mind that it's kinda
- difficult to get onto the "high-profile" list ;).
+>.
A.1.5. A.1.4.
Who maintains Bugzilla?
A.1.6. A.1.5.
How does Bugzilla stack up against other bug-tracking databases?
A.1.7. A.1.6.
Why doesn't Bugzilla offer this or that feature or compatibility
with this other tracking software?
@@ -10459,7 +10190,7 @@ CLASS="question"
NAME="faq-general-mysql"
>A.1.8. A.1.7.
Why MySQL? I'm interested in seeing Bugzilla run on
Oracle/Sybase/Msql/PostgreSQL/MSSQL.
@@ -10504,7 +10235,7 @@ CLASS="question"
NAME="faq-general-bonsaitools"
>A.1.9. A.1.8.
What is A.1.10. A.1.9.
My perl is not located at A.1.11. A.1.10.
Is there an easy way to change the Bugzilla cookie name?
2. Managerial Questions
Questions likely to be asked by managers. :-)
-
-
- It is web and e-mail based. You can edit bugs by sending specially
- formatted email to a properly configured Bugzilla, or control via the web.
-
A.2.2.
- Can Bugzilla integrate with
- Perforce (SCM software)?
-
- Yes! You can find more information elsewhere in "The Bugzilla
- Guide" in the "Integration with Third-Party Products" section.
-
A.2.3.
- Does Bugzilla allow the user to track multiple projects?
-
- Absolutely! You can track any number of Products that can each be
- composed of any number of Components.
-
A.2.4.
- If I am on many projects, and search for all bugs assigned to me, will
- Bugzilla list them for me and allow me to sort by project, severity etc?
-
- Yes.
-
A.2.5.
- Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes,
- are there any that are NOT allowed?
-
- Yes - any sort of attachment is allowed, although administrators can
- configure a maximum size.
- Bugzilla gives the user the option of either using the MIME-type
- supplied by the browser, choosing from a pre-defined list or
- manually typing any arbitrary MIME-type.
+ It is web and e-mail based.
A.2.6. A.2.2.
Does Bugzilla allow us to define our own priorities and levels? Do we
have complete freedom to change the labels of fields and format of them, and
@@ -10825,7 +10420,7 @@ CLASS="question"
NAME="faq-phb-reporting"
>A.2.7. A.2.3.
Does Bugzilla provide any reporting features, metrics, graphs, etc? You
know, the type of stuff that management likes to see. :)
@@ -10863,7 +10458,7 @@ CLASS="question"
NAME="faq-phb-email"
>A.2.8. A.2.4.
Is there email notification and if so, what do you see when you get an
email?
@@ -10876,7 +10471,7 @@ CLASS="answer"
>
Email notification is user-configurable. By default, the bug id and
- Summary of the bug report accompany each email notification, along with
+ summary of the bug report accompany each email notification, along with
a list of the changes made.
A.2.9.
- Can email notification be set up to send to multiple
- people, some on the To List, CC List, BCC List etc?
-
- Yes.
-
A.2.10. A.2.5.
Do users have to have any particular
type of email application?
@@ -10974,7 +10544,7 @@ CLASS="question"
NAME="faq-phb-data"
>A.2.11. A.2.6.
Does Bugzilla allow data to be imported and exported? If I had outsiders
write up a bug report using a MS Word bug template, could that template be
@@ -10991,7 +10561,7 @@ CLASS="answer"
Bugzilla can output buglists as HTML (the default), CSV or RDF.
The link for CSV can be found at the bottom of the buglist in HTML
format. This CSV format can easily be imported into MS Excel or
- other spread-sheet applications.
+ other spreadsheet applications.
To use the RDF format of the buglist it is necessary to append a
@@ -11000,7 +10570,7 @@ CLASS="computeroutput"
>&ctype=rdf to the URL. RDF
is meant to be machine readable and thus it is assumed that the
- URL would be generated progmatically so there is no user visible
+ URL would be generated programatically so there is no user visible
link to this format.
A.2.12. A.2.7.
Has anyone converted Bugzilla to another language to be used in other
countries? Is it localizable?
@@ -11074,7 +10644,7 @@ CLASS="question"
NAME="faq-phb-reports"
>A.2.13. A.2.8.
Can a user create and save reports? Can they do this in Word format?
Excel format?
@@ -11096,36 +10666,10 @@ CLASS="qandaentry"
CLASS="question"
>
A.2.14.
- Does Bugzilla have the ability to search by word, phrase, compound
- search?
-
- You have no idea. Bugzilla's query interface, particularly with the
- advanced Boolean operators, is incredibly versatile.
-
A.2.15. A.2.9.
Does Bugzilla provide record locking when there is simultaneous access
to the same bug? Does the second person get a notice that the bug is in use
@@ -11152,7 +10696,7 @@ CLASS="question"
NAME="faq-phb-backup"
>A.2.16. A.2.10.
Are there any backup features provided?
A.2.17. A.2.11.
Can users be on the system while a backup is in progress?
A.2.18. A.2.12.
What type of human resources are needed to be on staff to install and
maintain Bugzilla? Specifically, what type of skills does the person need to
have? I need to find out if we were to go with Bugzilla, what types of
individuals would we need to hire and how much would that cost vs buying an
- "Out-of-the-Box" solution.
+ "out-of-the-box" solution?
A.2.19. A.2.13.
What time frame are we looking at if we decide to hire people to install
and maintain the Bugzilla? Is this something that takes hours or weeks to
@@ -11276,7 +10820,7 @@ CLASS="question"
NAME="faq-phb-cost"
>A.2.20. A.2.14.
Is there any licensing fee or other fees for using Bugzilla? Any
out-of-pocket cost other than the bodies needed as identified above?
@@ -11358,34 +10902,6 @@ CLASS="answer"
A.3.3.
- I've implemented the security fixes mentioned in Chris Yeh's security
- advisory of 5/10/2000 advising not to run MySQL as root, and am running into
- problems with MySQL no longer working correctly.
-
- This is a common problem, related to running out of file descriptors.
- Simply add "ulimit -n unlimited" to the script which starts
- mysqld.
-
A.4.3.
- I want whineatnews.pl to whine at something more, or other than, only new
+ I want whineatnews.pl to whine at something different to only new
bugs. How do I do it?
A.4.4.
- I don't like/want to use Procmail to hand mail off to bug_email.pl.
- What alternatives do I have?
-
- You can call bug_email.pl directly from your aliases file, with
- an entry like this:
-
- However, this is fairly nasty and subject to problems; you also
- need to set up your smrsh (sendmail restricted shell) to allow
- it. In a pinch, though, it can work.
-
A.4.5. A.4.4.
How do I set up the email interface to submit/change bugs via email?
If you are using sendmail, try enabling
- sendmailnow in editparams.cgi.
-
A.4.7. A.4.6.
How come email from Bugzilla changes never reaches me?
If you never receive mail from Bugzilla, chances you do not have
+>
If you never receive mail from Bugzilla, chances are you do not have
sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked
to, "/usr/lib/sendmail".
- Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle.
+ Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle,
+ but it is now so old as to be obsolete, and is totally unsupported.
Red Hat's newer version (based on 2.17.1 and soon to be merged into
the main distribution) runs on PostgreSQL. At this time we know of
- no recent ports of Bugzilla to Oracle but do intend to support it
- in the future (possibly the 2.20 time-frame).
+ no recent ports of Bugzilla to Oracle; to be honest, Bugzilla
+ doesn't need what Oracle offers.
utility
(./sanitycheck.cgi in the
- Bugzilla_home directory) from your web browser to see! If
- it finishes without errors, you're
+>sanitycheck.cgi) from your web browser to see!
+ If it finishes without errors, you're
probably OK. If it doesn't come back
@@ -11951,7 +11428,7 @@ CLASS="answer"
>
Microsoft has some advice on this matter, as well:
Appendix B. The Bugzilla Database
This document really needs to be updated with more fleshed out
- information about primary keys, interrelationships, and maybe some nifty
- tables to document dependencies. Any takers?
B.1. Modifying Your Running System
Bugzilla optimizes database lookups by storing all relatively
- static information in the
- versioncache file, located in the
- data/
- subdirectory under your installation directory.
If you make a change to the structural data in your database (the
- versions table for example), or to the
- "constants"
-
- encoded in defparams.pl, you will need to remove
- the cached content from the data directory (by doing a
- "rm data/versioncache"
-
- ), or your changes won't show up.
versioncache
- gets automatically regenerated whenever it's more than
- an hour old, so Bugzilla will eventually notice your changes by itself,
- but generally you want it to notice right away, so that you can test
- things.
B.2. MySQL Bugzilla Database Introduction
This information comes straight from my life. I was forced to learn
- how Bugzilla organizes database because of nitpicky requests from users
- for tiny changes in wording, rather than having people re-educate
- themselves or figure out how to work our procedures around the tool. It
- sucks, but it can and will happen to you, so learn how the schema works
- and deal with it when it comes.
So, here you are with your brand-new installation of Bugzilla.
- You've got MySQL set up, Apache working right, Perl DBI and DBD talking
- to the database flawlessly. Maybe you've even entered a few test bugs to
- make sure email's working; people seem to be notified of new bugs and
- changes, and you can enter and edit bugs to your heart's content. Perhaps
- you've gone through the trouble of setting up a gateway for people to
- submit bugs to your database via email, have had a few people test it,
- and received rave reviews from your beta testers.
What's the next thing you do? Outline a training strategy for your
- development team, of course, and bring them up to speed on the new tool
- you've labored over for hours.
Your first training session starts off very well! You have a
- captive audience which seems enraptured by the efficiency embodied in
- this thing called "Bugzilla". You are caught up describing the nifty
- features, how people can save favorite queries in the database, set them
- up as headers and footers on their pages, customize their layouts,
- generate reports, track status with greater efficiency than ever before,
- leap tall buildings with a single bound and rescue Jane from the clutches
- of Certain Death!
But Certain Death speaks up -- a tiny voice, from the dark corners
- of the conference room. "I have a concern," the voice hisses from the
- darkness, "about the use of the word 'verified'."
The room, previously filled with happy chatter, lapses into
- reverential silence as Certain Death (better known as the Vice President
- of Software Engineering) continues. "You see, for two years we've used
- the word 'verified' to indicate that a developer or quality assurance
- engineer has confirmed that, in fact, a bug is valid. I don't want to
- lose two years of training to a new software product. You need to change
- the bug status of 'verified' to 'approved' as soon as possible. To avoid
- confusion, of course."
Oh no! Terror strikes your heart, as you find yourself mumbling
- "yes, yes, I don't think that would be a problem," You review the changes
- with Certain Death, and continue to jabber on, "no, it's not too big a
- change. I mean, we have the source code, right? You know, 'Use the
- Source, Luke' and all that... no problem," All the while you quiver
- inside like a beached jellyfish bubbling, burbling, and boiling on a hot
- Jamaican sand dune...
Thus begins your adventure into the heart of Bugzilla. You've been
- forced to learn about non-portable enum() fields, varchar columns, and
- tinyint definitions. The Adventure Awaits You!
B.2.1. Bugzilla Database Basics
If you were like me, at this point you're totally clueless about
- the internals of MySQL, and if it weren't for this executive order from
- the Vice President you couldn't care less about the difference between
- a
- "bigint"
-
- and a
- "tinyint"
-
- entry in MySQL. I recommend you refer to the
- MySQL documentation
- . Below are the basics you need to know about the Bugzilla database.
- Check the chart above for more details.
To connect to your database:
bash#
-
- mysql
-
- -u root
-
If this works without asking you for a password,
- shame on you
-
- ! You should have locked your security down like the installation
- instructions told you to. You can find details on locking down
- your database in the Bugzilla FAQ in this directory (under
- "Security"), or more robust security generalities in the
- MySQL
- searchable documentation.
-
You should now be at a prompt that looks like this:
mysql>
-
At the prompt, if
- "bugs"
-
- is the name you chose in the
- localconfig
-
- file for your Bugzilla database, type:
mysql
-
- use bugs;
-
-
B.2.1.1. Bugzilla Database Tables
Imagine your MySQL database as a series of spreadsheets, and
- you won't be too far off. If you use this command:
mysql>
- show tables from bugs;
-
you'll be able to see the names of all the
- "spreadsheets"
- (tables) in your database.
From the command issued above, ou should have some
- output that looks like this:
-
- Here's an overview of what each table does. Most columns in each table have
-descriptive names that make it fairly trivial to figure out their jobs.
-
-attachments: This table stores all attachments to bugs. It tends to be your
-largest table, yet also generally has the fewest entries because file
-attachments are so (relatively) large.
-
-bugs: This is the core of your system. The bugs table stores most of the
-current information about a bug, with the exception of the info stored in the
-other tables.
-
-bugs_activity: This stores information regarding what changes are made to bugs
-when -- a history file.
-
-cc: This tiny table simply stores all the CC information for any bug which has
-any entries in the CC field of the bug. Note that, like most other tables in
-Bugzilla, it does not refer to users by their user names, but by their unique
-userid, stored as a primary key in the profiles table.
-
-components: This stores the programs and components (or products and
-components, in newer Bugzilla parlance) for Bugzilla. Curiously, the "program"
-(product) field is the full name of the product, rather than some other unique
-identifier, like bug_id and user_id are elsewhere in the database.
-
-dependencies: Stores data about those cool dependency trees.
-
-fielddefs: A nifty table that defines other tables. For instance, when you
-submit a form that changes the value of "AssignedTo" this table allows
-translation to the actual field name "assigned_to" for entry into MySQL.
-
-groups: defines bitmasks for groups. A bitmask is a number that can uniquely
-identify group memberships. For instance, say the group that is allowed to
-tweak parameters is assigned a value of "1", the group that is allowed to edit
-users is assigned a "2", and the group that is allowed to create new groups is
-assigned the bitmask of "4". By uniquely combining the group bitmasks (much
-like the chmod command in UNIX,) you can identify a user is allowed to tweak
-parameters and create groups, but not edit users, by giving him a bitmask of
-"5", or a user allowed to edit users and create groups, but not tweak
-parameters, by giving him a bitmask of "6" Simple, huh?
- If this makes no sense to you, try this at the mysql prompt:
-mysql> select * from groups;
- You'll see the list, it makes much more sense that way.
-
-keyworddefs: Definitions of keywords to be used
-
-keywords: Unlike what you'd think, this table holds which keywords are
-associated with which bug id's.
-
-logincookies: This stores every login cookie ever assigned to you for every
-machine you've ever logged into Bugzilla from. Curiously, it never does any
-housecleaning -- I see cookies in this file I've not used for months. However,
-since Bugzilla never expires your cookie (for convenience' sake), it makes
-sense.
-
-longdescs: The meat of bugzilla -- here is where all user comments are stored!
-You've only got 2^24 bytes per comment (it's a mediumtext field), so speak
-sparingly -- that's only the amount of space the Old Testament from the Bible
-would take (uncompressed, 16 megabytes). Each comment is keyed to the
-bug_id to which it's attached, so the order is necessarily chronological, for
-comments are played back in the order in which they are received.
-
-milestones: Interesting that milestones are associated with a specific product
-in this table, but Bugzilla does not yet support differing milestones by
-product through the standard configuration interfaces.
-
-namedqueries: This is where everybody stores their "custom queries". Very
-cool feature; it beats the tar out of having to bookmark each cool query you
-construct.
-
-products: What products you have, whether new bug entries are allowed for the
-product, what milestone you're working toward on that product, votes, etc. It
-will be nice when the components table supports these same features, so you
-could close a particular component for bug entry without having to close an
-entire product...
-
-profiles: Ahh, so you were wondering where your precious user information was
-stored? Here it is! With the passwords in plain text for all to see! (but
-sshh... don't tell your users!)
-
-profiles_activity: Need to know who did what when to who's profile? This'll
-tell you, it's a pretty complete history.
-
-versions: Version information for every product
-
-votes: Who voted for what when
-
-watch: Who (according to userid) is watching who's bugs (according to their
-userid).
-
-
-===
-THE DETAILS
-===
-
- Ahh, so you're wondering just what to do with the information above? At the
-mysql prompt, you can view any information about the columns in a table with
-this command (where "table" is the name of the table you wish to view):
-
-mysql> show columns from table;
-
- You can also view all the data in a table with this command:
-
-mysql> select * from table;
-
- -- note: this is a very bad idea to do on, for instance, the "bugs" table if
-you have 50,000 bugs. You'll be sitting there a while until you ctrl-c or
-50,000 bugs play across your screen.
-
- You can limit the display from above a little with the command, where
-"column" is the name of the column for which you wish to restrict information:
-
-mysql> select * from table where (column = "some info");
-
- -- or the reverse of this
-
-mysql> select * from table where (column != "some info");
-
- Let's take our example from the introduction, and assume you need to change
-the word "verified" to "approved" in the resolution field. We know from the
-above information that the resolution is likely to be stored in the "bugs"
-table. Note we'll need to change a little perl code as well as this database
-change, but I won't plunge into that in this document. Let's verify the
-information is stored in the "bugs" table:
-
-mysql> show columns from bugs
-
- (exceedingly long output truncated here)
-| bug_status| enum('UNCONFIRMED','NEW','ASSIGNED','REOPENED','RESOLVED','VERIFIED','CLOSED')||MUL | UNCONFIRMED||
-
- Sorry about that long line. We see from this that the "bug status" column is
-an "enum field", which is a MySQL peculiarity where a string type field can
-only have certain types of entries. While I think this is very cool, it's not
-standard SQL. Anyway, we need to add the possible enum field entry
-'APPROVED' by altering the "bugs" table.
-
-mysql> ALTER table bugs CHANGE bug_status bug_status
- -> enum("UNCONFIRMED", "NEW", "ASSIGNED", "REOPENED", "RESOLVED",
- -> "VERIFIED", "APPROVED", "CLOSED") not null;
-
- (note we can take three lines or more -- whatever you put in before the
-semicolon is evaluated as a single expression)
-
-Now if you do this:
-
-mysql> show columns from bugs;
-
- you'll see that the bug_status field has an extra "APPROVED" enum that's
-available! Cool thing, too, is that this is reflected on your query page as
-well -- you can query by the new status. But how's it fit into the existing
-scheme of things?
- Looks like you need to go back and look for instances of the word "verified"
-in the perl code for Bugzilla -- wherever you find "verified", change it to
-"approved" and you're in business (make sure that's a case-insensitive search).
-Although you can query by the enum field, you can't give something a status
-of "APPROVED" until you make the perl changes. Note that this change I
-mentioned can also be done by editing checksetup.pl, which automates a lot of
-this. But you need to know this stuff anyway, right?
-
Appendix C. Useful Patches and Utilities for Bugzilla
Appendix B. Contrib
Are you looking for a way to put your Bugzilla into overdrive? Catch
- some of the niftiest tricks here in this section.
C.1. Apache
- There are a number of unofficial Bugzilla add-ons in the
+ mod_rewrite$BUGZILLA_ROOT/contrib/
-
- magic
Apache's
- mod_rewrite
-
- module lets you do some truly amazing things with URL rewriting. Here are
- a couple of examples of what you can do.
Make it so if someone types
- http://www.foo.com/12345
-
- , Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try
- setting up your VirtualHost section for Bugzilla with a rule like
- this:
<VirtualHost 12.34.56.78>
-RewriteEngine On
-RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
-</VirtualHost>
-
There are many, many more things you can do with mod_rewrite.
- Please refer to the mod_rewrite documentation at
- http://www.apache.org.
-
C.2. Command-line Bugzilla Queries
B.1. Command-line Search Interface
There are a suite of Unix utilities for querying Bugzilla from the
+>There are a suite of Unix utilities for searching Bugzilla from the
command line. They live in the
Appendix D. Bugzilla Variants and Competitors
I created this section to answer questions about Bugzilla competitors
- and variants, then found a wonderful site which covers an awful lot of what
- I wanted to discuss. Rather than quote it in its entirety, I'll simply
- refer you here:
- http://linas.org/linux/pm.html.
-
D.1. Red Hat Bugzilla
Red Hat's old fork of Bugzilla which was based on version 2.8 is now
- obsolete. The newest version in use is based on version 2.17.1 and is in
- the process of being integrated into the main Bugzilla source tree. The
- back-end is modified to work with PostgreSQL instead of MySQL and they have
- custom templates to get their desired look and feel, but other than that it
- is Bugzilla 2.17.1. Dave Lawrence of Red Hat put forth a great deal of
- effort to make sure that the changes he made could be integrated back into
- the main tree.
- Bug 98304
- exists to track this integration.
-
Fenris was a fork from Bugzilla made by Loki Games; when
- Loki went into receivership, it died. While Loki's other code lives on,
- its custodians recommend Bugzilla for future bug-tracker deployments.
-
This section last updated 27 Jul 2002
D.3. Issuezilla
Issuezilla was another fork from Bugzilla, made by collab.net and
- hosted at tigris.org. It is also dead; the primary focus of bug-tracking
- at tigris.org is their Java-based bug-tracker,
- Section D.4.
This section last updated 27 Jul 2002
D.4. Scarab
Scarab is a new open source bug-tracking system built using Java
- Servlet technology. It is currently at version 1.0 beta 13.
SourceForge is a way of coordinating geographically
- distributed free software and open source projects over the Internet.
- It has a built-in bug tracker, but it's not highly thought of.
For more information about how to configure Apache for Bugzilla,
see Section 4.4.1Section 4.2.1.
Much more detailed information about the suggestions in
Section 5.6.2Section 4.5.2.
The core of Bugzilla is the screen which displays a particular
+ bug. It's a good place to explain some Bugzilla concepts.
+
Bug 1 on Landfill
+
+ is a good example. Note that the labels for most fields are hyperlinks;
+ clicking them will take you to context-sensitive help on that
+ particular field. Fields marked * may not be present on every
+ installation of Bugzilla.
Product and Component:
+ Bugs are divided up by Product and Component, with a Product
+ having one or more Components in it. For example,
+ bugzilla.mozilla.org's "Bugzilla" Product is composed of several
+ Components:
+
Administration:
+ Administration of a Bugzilla installation.
Bugzilla-General:
+ Anything that doesn't fit in the other components, or spans
+ multiple components.
Creating/Changing Bugs:
+ Creating, changing, and viewing bugs.
Documentation:
+ The Bugzilla documentation, including The Bugzilla Guide.
Email:
+ Anything to do with email sent by Bugzilla.
Installation:
+ The installation process of Bugzilla.
Query/Buglist:
+ Anything to do with searching for bugs and viewing the
+ buglists.
Reporting/Charting:
+ Getting reports from Bugzilla.
User Accounts:
+ Anything about managing a user account from the user's perspective.
+ Saved queries, creating accounts, changing passwords, logging in,
+ etc.
User Interface:
+ General issues having to do with the user interface cosmetics (not
+ functionality) including cosmetic issues, HTML templates,
+ etc.
+
Status and Resolution:
+
+ These define exactly what state the bug is in - from not even
+ being confirmed as a bug, through to being fixed and the fix
+ confirmed by Quality Assurance. The different possible values for
+ Status and Resolution on your installation should be documented in the
+ context-sensitive help for those items.
Assigned To:
+ The person responsible for fixing the bug.
*URL:
+ A URL associated with the bug, if any.
Summary:
+ A one-sentence summary of the problem.
*Status Whiteboard:
+ (a.k.a. Whiteboard) A free-form text area for adding short notes
+ and tags to a bug.
*Keywords:
+ The administrator can define keywords which you can use to tag and
+ categorise bugs - e.g. The Mozilla Project has keywords like crash
+ and regression.
Platform and OS:
+ These indicate the computing environment where the bug was
+ found.
Version:
+ The "Version" field is usually used for versions of a product which
+ have been released, and is set to indicate which versions of a
+ Component have the particular problem the bug report is
+ about.
Priority:
+ The bug assignee uses this field to prioritise his or her bugs.
+ It's a good idea not to change this on other people's bugs.
Severity:
+ This indicates how severe the problem is - from blocker
+ ("application unusable") to trivial ("minor cosmetic issue"). You
+ can also use this field to indicate whether a bug is an enhancement
+ request.
*Target:
+ (a.k.a. Target Milestone) A future version by which the bug is to
+ be fixed. e.g. The Bugzilla Project's milestones for future
+ Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
+ restricted to numbers, thought - you can use any text strings, such
+ as dates.
Reporter:
+ The person who filed the bug.
CC list:
+ A list of people who get mail when the bug changes.
Attachments:
+ You can attach files (e.g. testcases or patches) to bugs. If there
+ are any attachments, they are listed in this section.
*Dependencies:
+ If this bug cannot be fixed unless other bugs are fixed (depends
+ on), or this bug stops other bugs being fixed (blocks), their
+ numbers are recorded here.
*Votes:
+ Whether this bug has any votes.
Additional Comments:
+ You can add your two cents to the bug discussion here, if you have
+ something worthwhile to say.
\ No newline at end of file
diff --git a/webtools/bugzilla/docs/html/bugreports.html b/webtools/bugzilla/docs/html/bugreports.html
new file mode 100644
index 00000000000..91df7f3ba34
--- /dev/null
+++ b/webtools/bugzilla/docs/html/bugreports.html
@@ -0,0 +1,197 @@
+Filing Bugs
Years of bug writing experience has been distilled for your
+ reading pleasure into the
+
Bug Writing Guidelines.
+ While some of the advice is Mozilla-specific, the basic principles of
+ reporting Reproducible, Specific bugs, isolating the Product you are
+ using, the Version of the Product, the Component which failed, the
+ Hardware Platform, and Operating System you were using at the time of
+ the failure go a long way toward ensuring accurate, responsible fixes
+ for the bug that bit you.
The procedure for filing a test bug is as follows:
Fill in the fields. Bugzilla should have made reasonable
+ guesses, based upon your browser, for the "Platform" and "OS"
+ drop-down boxes. If they are wrong, change them.
There are a suite of Unix utilities for querying Bugzilla from the
+>There are a suite of Unix utilities for searching Bugzilla from the
command line. They live in the
PrevNextApache
- mod_rewrite
-
- magicContrib
Components are subsections of a Product. E.g. the computer game
+ you are designing may have a "UI"
+ component, an "API" component, a "Sound System" component, and a
+ "Plugins" component, each overseen by a different programmer. It
+ often makes sense to divide Components in Bugzilla according to the
+ natural divisions of responsibility within your Product or
+ company.
Each component has a owner and (if you turned it on in the parameters),
+ a QA Contact. The owner should be the primary person who fixes bugs in
+ that component. The QA Contact should be the person who will ensure
+ these bugs are completely fixed. The Owner, QA Contact, and Reporter
+ will get email when new bugs are created in this Component and when
+ these bugs change. Default Owner and Default QA Contact fields only
+ dictate the
+ default assignments;
+ these can be changed on bug submission, or at any later point in
+ a bug's life.
To create a new Component:
Select the "Edit components" link from the "Edit product"
+ page
Select the "Add" link in the bottom right.
Fill out the "Component" field, a short "Description",
+ the "Initial Owner" and "Initial QA Contact" (if enabled.)
+ The Component and Description fields may contain HTML;
+ the "Initial Owner" field must be a login name
+ already existing in the database.
+
\ No newline at end of file
diff --git a/webtools/bugzilla/docs/html/conventions.html b/webtools/bugzilla/docs/html/conventions.html
index 5ba3317d3db..d646b30ef60 100644
--- a/webtools/bugzilla/docs/html/conventions.html
+++ b/webtools/bugzilla/docs/html/conventions.html
@@ -4,9 +4,11 @@
>Document Conventions
The Bugzilla Guide - 2.17.5 Development Release
The Bugzilla Guide - 2.17.5
+ Development Release
File Names
File and directory names
Directory Names
directory
-
Commands to be typed
Applications Names
Applications names
Environment Variables
Environment variables
Emphasized word
word
-
Term found in the glossary
Code Example
Code example
+ This documentation is maintained in DocBook 4.1.2 XML format.
+ Changes are best submitted as plain text or XML diffs, attached
+ to a bug filed in the Bugzilla Documentation component.
+
Copyright Information
The Bugzilla Guide - 2.17.5 Development Release
The Bugzilla Guide - 2.17.5
+ Development Release
1.1. Copyright Information
Appendix EAppendix C.
--Copyright (c) 2000-2003 Matthew P. Barnson and The Bugzilla TeamCopyright (c) 2000-2004 The Bugzilla Team
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
- please contact The Bugzilla Team.
+ please contact the Bugzilla Team.
for taking over documentation during the 2.17 development
- period.
-
Matthew P. Barnson, Kevin Brannen, Dawn Endico, Ben FrantzDale, Eric Hanson, Tara Hernandez, Dave Lawrence, Zach Lipton, Gervase Markham, Andrew Pearson, Joe Robins, Spencer Smith, Jacob Steenhagen, Ron Teitelbaum, Terry Weissman, Martin Wulffeld.
+
Last but not least, all the members of the
news://news.mozilla.org/netscape/public/mozilla/webtools
netscape.public.mozilla.webtools
newsgroup. Without your discussions, insight, suggestions, and patches,
this could never have happened.
Thanks also go to the following people for significant contributions
- to this documentation (in alphabetical order):
- Andrew Pearson, Ben FrantzDale, Eric Hanson, Gervase Markham, Joe Robins, Kevin Brannen, Martin Wulffeld, Ron Teitelbaum, Spencer Smith, Zach Liption
- .
-
Change Permission CustomizationCustomizing Who Can Change What
5.8. Change Permission Customization6.2. Customizing Who Can Change What
This feature should be considered experimental; the Bugzilla code you
will be changing is not stable, and could change or move between
- versions. Be aware that if you make modifications to it, you may have
+ versions. Be aware that if you make modifications as outlined here,
+ you may have
to re-make them or port them if Bugzilla changes internally between
- versions.
+ versions, and you upgrade.
One of the large changes for 2.16 was the templatization of the
- entire user-facing UI, using the
- Template Toolkit.
- Administrators can now configure the look and feel of Bugzilla without
+>
Administrators can configure the look and feel of Bugzilla without
having to edit Perl files or face the nightmare of massive merge
conflicts when they upgrade to a newer version in the future.
Templatization also makes localized versions of Bugzilla possible,
- for the first time. As of version 2.17.4 which will soon
- become 2.18, it's possible to have Bugzilla's language determined by
- the user's browser. More information is available in
+ for the first time. It's possible to have Bugzilla's UI language
+ determined by the user's browser. More information is available in
Section 5.7.5Section 6.1.5.
5.7.1. What to Edit
6.1.1. What to Edit
There are two different ways of editing of Bugzilla's templates,
- and which you use depends mainly on how you upgrade Bugzilla. The
- template directory structure is that there's a top level directory,
+>
The template directory structure is that there's a top level directory,
template
The first method of making customizations is to directly edit the
+>
There are two different ways of editing Bugzilla's templates,
+ and which you use depends mainly on the method you plan to use to
+ upgrade Bugzilla.
+ The first method of making customizations is to directly edit the
templates in template/en/default
The other method is to copy the templates into a mirrored directory
+>
The other method is to copy the templates to be modified into a
+ mirrored directory
structure under template/en/custom
5.7.2. How To Edit Templates
The syntax of the Template Toolkit language is beyond the scope of
- this guide. It's reasonably easy to pick up by looking at the current
- templates; or, you can read the manual, available on the
- Template Toolkit home
- page. However, you should particularly remember (for security
- reasons) to always HTML filter things which come from the database or
- user input, to prevent cross-site scripting attacks.
-
However, one thing you should take particular care about is the need
- to properly HTML filter data that has been passed into the template.
- This means that if the data can possibly contain special HTML characters
- such as <, and the data was not intended to be HTML, they need to be
- converted to entity form, ie <. You use the 'html' filter in the
- Template Toolkit to do this. If you fail to do this, you may open up
- your installation to cross-site scripting attacks.
-
Also note that Bugzilla adds a few filters of its own, that are not
- in standard Template Toolkit. In particular, the 'url_quote' filter
- can convert characters that are illegal or have special meaning in URLs,
- such as &, to the encoded form, ie %26. This actually encodes most
- characters (but not the common ones such as letters and numbers and so
- on), including the HTML-special characters, so there's never a need to
- HTML filter afterwards.
-
Editing templates is a good way of doing a "poor man's custom fields".
- For example, if you don't use the Status Whiteboard, but want to have
- a free-form text entry box for "Build Identifier", then you can just
- edit the templates to change the field labels. It's still be called
- status_whiteboard internally, but your users don't need to know that.
-
6.1.2. How To Edit Templates
The syntax of the Template Toolkit language is beyond the scope of
+ this guide. It's reasonably easy to pick up by looking at the current
+ templates; or, you can read the manual, available on the
+ Template Toolkit home
+ page.
+
One thing you should take particular care about is the need
+ to properly HTML filter data that has been passed into the template.
+ This means that if the data can possibly contain special HTML characters
+ such as <, and the data was not intended to be HTML, they need to be
+ converted to entity form, ie <. You use the 'html' filter in the
+ Template Toolkit to do this. If you forget, you may open up
+ your installation to cross-site scripting attacks.
+
Also note that Bugzilla adds a few filters of its own, that are not
+ in standard Template Toolkit. In particular, the 'url_quote' filter
+ can convert characters that are illegal or have special meaning in URLs,
+ such as &, to the encoded form, ie %26. This actually encodes most
+ characters (but not the common ones such as letters and numbers and so
+ on), including the HTML-special characters, so there's never a need to
+ HTML filter afterwards.
+
Editing templates is a good way of doing a "poor man's custom fields".
+ For example, if you don't use the Status Whiteboard, but want to have
+ a free-form text entry box for "Build Identifier", then you can just
+ edit the templates to change the field labels. It's still be called
+ status_whiteboard internally, but your users don't need to know that.
+
5.7.3. Template Formats
6.1.3. Template Formats
Some CGIs have the ability to use more than one template. For
example, buglist.cgi can output bug lists as RDF or two
@@ -350,9 +345,9 @@ CLASS="filename"
To see if a CGI supports multiple output formats, grep the
- CGI for "ValidateOutputFormat". If it's not present, adding
+ CGI for "GetFormat". If it's not present, adding
multiple format support isn't too hard - see how it's done in
- other CGIs.
+ other CGIs, e.g. config.cgi.
To make a new format template for a CGI which supports this,
@@ -396,9 +391,9 @@ CLASS="section"
>
5.7.4. Particular Templates
6.1.4. Particular Templates
There are a few templates you may be particularly interested in
customizing for your installation.
@@ -454,21 +449,6 @@ CLASS="command"
>
bug/process/midair.html.tmpl:
- This is the page used if two people submit simultaneous changes to the
- same bug. The second person to submit their changes will get this page
- to tell them what the first person did, and ask if they wish to
- overwrite those changes or go back and revisit the bug. The default
- title and header on this page read "Mid-air collision detected!" If
- you work in the aviation industry, or other environment where this
- might be found offensive (yes, we have true stories of this happening)
- you'll want to change this to something more appropriate for your
- environment.
-
bug/create/create.html.tmpl and
5.7.5. Configuring Bugzilla to Detect the User's Language6.1.5. Configuring Bugzilla to Detect the User's Language
Begining in version 2.18 (first introduced in version
- 2.17.4), it's now possible to have the users web browser tell Bugzilla
- which language templates to use for each visitor (using the HTTP_ACCEPT
- header). For this to work, Bugzilla needs to have the correct language
- templates installed for the version of Bugzilla you are using. Many
+>Bugzilla honours the user's Accept: HTTP header. You can install
+ templates in other languages, and Bugzilla will pick the most appropriate
+ according to a priority order defined by you. Many
language templates can be obtained from After untarring the localizations (or creating your own) in the
[Bugzilla_Root]/template$BUGZILLA_HOME/template directory,
you must update the PrevBugzilla SecurityCustomising Bugzilla
\ No newline at end of file
diff --git a/webtools/bugzilla/docs/html/database.html b/webtools/bugzilla/docs/html/database.html
index d9bc26c2cad..e69de29bb2d 100644
--- a/webtools/bugzilla/docs/html/database.html
+++ b/webtools/bugzilla/docs/html/database.html
@@ -1,182 +0,0 @@
-The Bugzilla Database
This document really needs to be updated with more fleshed out
- information about primary keys, interrelationships, and maybe some nifty
- tables to document dependencies. Any takers?
B.2. MySQL Bugzilla Database Introduction6.4. MySQL Bugzilla Database Introduction
This information comes straight from my life. I was forced to learn
how Bugzilla organizes database because of nitpicky requests from users
@@ -134,9 +137,9 @@ CLASS="section"
>
B.2.1. Bugzilla Database Basics
6.4.1. Bugzilla Database Basics
If you were like me, at this point you're totally clueless about
the internals of MySQL, and if it weren't for this executive order from
@@ -248,9 +251,9 @@ CLASS="section"
>
B.2.1.1. Bugzilla Database Tables
6.4.1.1. Bugzilla Database Tables
Imagine your MySQL database as a series of spreadsheets, and
you won't be too far off. If you use this command:
NextUpUseful Patches and Utilities for BugzillaIntegrating Bugzilla with Third-Party Tools
Appendix B. The Bugzilla DatabaseChapter 6. Customising Bugzilla
B.1. Modifying Your Running System6.3. Modifying Your Running System
Bugzilla optimizes database lookups by storing all relatively
static information in the
@@ -132,7 +135,7 @@ WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Prev
The Bugzilla DatabaseCustomizing Who Can Change What
No liability for the contents of this document can be accepted.
- Use the concepts, examples, and other content at your own risk.
+ Follow the instructions herein at your own risk.
This document may contain errors
and inaccuracies that may damage your system, cause your partner
to leave you, your boss to fire you, your cats to
@@ -85,35 +88,20 @@ NAME="disclaimer"
war. Proceed with caution.
All copyrights are held by their respective owners, unless
- specifically noted otherwise. Use of a term in this document
- should not be regarded as affecting the validity of any
- trademark or service mark.
-
Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". We
- wholeheartedly endorse the use of GNU/Linux in every situation
- where it is appropriate. It is an extremely versatile, stable,
+ wholeheartedly endorse the use of GNU/Linux; it is an extremely
+ versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
You are strongly recommended to make a backup of your system
- before installing Bugzilla and at regular intervals thereafter.
- If you implement any suggestion in this Guide, implement this one!
-
Although the Bugzilla development team has taken great care to
- ensure that all easily-exploitable bugs or options are
- documented or fixed in the code, security holes surely exist.
- Great care should be taken both in the installation and usage of
- this software. Carefully consider the implications of installing
- other network services with Bugzilla. The Bugzilla development
- team members, Netscape Communications, America Online Inc., and
- any affiliated developers or sponsors assume no liability for
- your use of this product. You have the source code to this
- product, and are responsible for auditing it yourself to ensure
+ ensure that all exploitable bugs or options have been
+ fixed, security holes surely exist. Great care should be taken both in
+ the installation and usage of this software. The Bugzilla development
+ team members assume no liability for your use of this software. You have
+ the source code, and are responsible for auditing it yourself to ensure
your security needs are met.
As well as the text-based dependency graphs, Bugzilla also
supports dependency graphing, using a package called 'dot'.
@@ -144,9 +147,9 @@ CLASS="section"
>
4.2.2. Bug Graphs
4.3.2. Bug Graphs
As long as you installed the GD and Graph::Base Perl modules you
might as well turn on the nifty Bugzilla bug reporting graphs.
4.2.3. The Whining Cron
4.3.3. The Whining Cron
By now you have a fully functional Bugzilla, but what good are
bugs if they're not annoying? To help make those bugs more annoying you
@@ -294,47 +297,11 @@ CLASS="section"
>4.2.4. LDAP Authentication
4.3.4. LDAP Authentication
LDAP authentication has been rewritten for the 2.18 release of
- Bugzilla. It no longer requires the Mozilla::LDAP module and now uses
- Net::LDAP instead. This rewrite was part of a larger landing that
- allowed for additional authentication schemes to be easily added
- (bug
- 180642).
-
This patch originally landed in 21-Mar-2003 and was included
- in the 2.17.4 development release.
-
LDAP authentication is a module for Bugzilla's plugin
+ authentication architecture.
+
The existing authentication
scheme for Bugzilla uses email addresses as the primary user ID, and a
@@ -544,26 +511,26 @@ CLASS="section"
>4.2.5. Preventing untrusted Bugzilla content from executing malicious
+>4.3.5. Preventing untrusted Bugzilla content from executing malicious
Javascript code
It is possible for a Bugzilla to execute malicious Javascript
- code. Due to internationalization concerns, we are unable to
- incorporate the code changes necessary to fulfill the CERT advisory
- requirements mentioned in
+>It is possible for a Bugzilla attachment to contain malicious
+ Javascript
+ code, which would be executed in the domain of your Bugzilla, thereby
+ making it possible for the attacker to e.g. steal your login cookies.
+ Due to internationalization concerns, we are unable to
+ incorporate by default the code changes necessary to fulfill the CERT
+ advisory requirements mentioned in
http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3.
- Making the change below will fix the problem if your installation is for
- an English speaking audience.
+ If your installation is for an English speaking audience only, making the
+ change below will prevent this problem.
Telling Bugzilla to output a charset as part of the HTTP header is
- much easier in version 2.18 and higher (including any cvs
- pull after 4-May-2003 and development release after 2.17.5) than it was
- in previous versions. Simply locate the following line in
+>Simply locate the following line in
Bugzilla/CGI.pm
# Make sure that we don't send any charset headers
- $self->charset('');
+>
$self->charset('');
# Send all data using the ISO-8859-1 charset
- $self->charset('ISO-8859-1');
+>
$self->charset('ISO-8859-1');
Using <meta> tags to set the charset is not
- recommended, as there's a bug in Netscape 4.x which causes pages
- marked up in this way to load twice. See
- bug 126266
- for more information including progress toward making
- bugzilla charset aware by default.
-
4.2.6. directoryindex for the Bugzilla default page.
You should modify the <DirectoryIndex> parameter for
- the Apache virtual host running your Bugzilla installation to
- allow index.cgi as the index page for a
- directory, as well as the usual index.html,
- index.htm, and so forth.
4.2.7. Bugzilla and 4.3.6. Bugzilla and mod_perl4.2.8. 4.3.7. mod_throttle
@@ -754,7 +656,7 @@ WIDTH="33%"
ALIGN="left"
VALIGN="top"
>PrevStep-by-step InstallHTTP Server Configuration
A.1.2. A.1.1.
What license is Bugzilla distributed under?
A.1.3. A.1.2.
How do I get commercial support for Bugzilla?
http://www.collab.net/ offers
- Bugzilla as part of their standard offering to large projects.
- They do have some minimum fees that are pretty hefty, and generally
- aren't interested in small projects.
-
There are several experienced
Bugzilla hackers on the mailing list/newsgroup who are willing
to make themselves available for generous compensation.
@@ -681,7 +585,7 @@ CLASS="question"
NAME="faq-general-companies"
>A.1.4. A.1.3.
What major companies or projects are currently using Bugzilla
for bug-tracking?
@@ -699,9 +603,9 @@ CLASS="answer"
Bugzilla sites to track bugs in their products. We have a fairly
complete list available on our website at
http://bugzilla.org/installation_list.htmlhttp://bugzilla.org/installation-list/. If you
have an installation of Bugzilla and would like to be added to the
list, whether it's a public install or not, simply e-mail
@@ -711,11 +615,7 @@ CLASS="email"
HREF="mailto:gerv@mozilla.org"
>gerv@mozilla.org>. Keep in mind that it's kinda
- difficult to get onto the "high-profile" list ;).
+>.
A.1.5. A.1.4.
Who maintains Bugzilla?
A.1.6. A.1.5.
How does Bugzilla stack up against other bug-tracking databases?
A.1.7. A.1.6.
Why doesn't Bugzilla offer this or that feature or compatibility
with this other tracking software?
@@ -836,7 +736,7 @@ CLASS="question"
NAME="faq-general-mysql"
>A.1.8. A.1.7.
Why MySQL? I'm interested in seeing Bugzilla run on
Oracle/Sybase/Msql/PostgreSQL/MSSQL.
@@ -881,7 +781,7 @@ CLASS="question"
NAME="faq-general-bonsaitools"
>A.1.9. A.1.8.
What is A.1.10. A.1.9.
My perl is not located at A.1.11. A.1.10.
Is there an easy way to change the Bugzilla cookie name?
2. Managerial Questions
Questions likely to be asked by managers. :-)
-
-
- It is web and e-mail based. You can edit bugs by sending specially
- formatted email to a properly configured Bugzilla, or control via the web.
-
A.2.2.
- Can Bugzilla integrate with
- Perforce (SCM software)?
-
- Yes! You can find more information elsewhere in "The Bugzilla
- Guide" in the "Integration with Third-Party Products" section.
-
A.2.3.
- Does Bugzilla allow the user to track multiple projects?
-
- Absolutely! You can track any number of Products that can each be
- composed of any number of Components.
-
A.2.4.
- If I am on many projects, and search for all bugs assigned to me, will
- Bugzilla list them for me and allow me to sort by project, severity etc?
-
- Yes.
-
A.2.5.
- Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes,
- are there any that are NOT allowed?
-
- Yes - any sort of attachment is allowed, although administrators can
- configure a maximum size.
- Bugzilla gives the user the option of either using the MIME-type
- supplied by the browser, choosing from a pre-defined list or
- manually typing any arbitrary MIME-type.
+ It is web and e-mail based.
A.2.6. A.2.2.
Does Bugzilla allow us to define our own priorities and levels? Do we
have complete freedom to change the labels of fields and format of them, and
@@ -1202,7 +966,7 @@ CLASS="question"
NAME="faq-phb-reporting"
>A.2.7. A.2.3.
Does Bugzilla provide any reporting features, metrics, graphs, etc? You
know, the type of stuff that management likes to see. :)
@@ -1240,7 +1004,7 @@ CLASS="question"
NAME="faq-phb-email"
>A.2.8. A.2.4.
Is there email notification and if so, what do you see when you get an
email?
@@ -1253,7 +1017,7 @@ CLASS="answer"
>
Email notification is user-configurable. By default, the bug id and
- Summary of the bug report accompany each email notification, along with
+ summary of the bug report accompany each email notification, along with
a list of the changes made.
A.2.9.
- Can email notification be set up to send to multiple
- people, some on the To List, CC List, BCC List etc?
-
- Yes.
-
A.2.10. A.2.5.
Do users have to have any particular
type of email application?
@@ -1351,7 +1090,7 @@ CLASS="question"
NAME="faq-phb-data"
>A.2.11. A.2.6.
Does Bugzilla allow data to be imported and exported? If I had outsiders
write up a bug report using a MS Word bug template, could that template be
@@ -1368,7 +1107,7 @@ CLASS="answer"
Bugzilla can output buglists as HTML (the default), CSV or RDF.
The link for CSV can be found at the bottom of the buglist in HTML
format. This CSV format can easily be imported into MS Excel or
- other spread-sheet applications.
+ other spreadsheet applications.
To use the RDF format of the buglist it is necessary to append a
@@ -1377,7 +1116,7 @@ CLASS="computeroutput"
>&ctype=rdf to the URL. RDF
is meant to be machine readable and thus it is assumed that the
- URL would be generated progmatically so there is no user visible
+ URL would be generated programatically so there is no user visible
link to this format.
A.2.12. A.2.7.
Has anyone converted Bugzilla to another language to be used in other
countries? Is it localizable?
@@ -1451,7 +1190,7 @@ CLASS="question"
NAME="faq-phb-reports"
>A.2.13. A.2.8.
Can a user create and save reports? Can they do this in Word format?
Excel format?
@@ -1473,36 +1212,10 @@ CLASS="qandaentry"
CLASS="question"
>
A.2.14.
- Does Bugzilla have the ability to search by word, phrase, compound
- search?
-
- You have no idea. Bugzilla's query interface, particularly with the
- advanced Boolean operators, is incredibly versatile.
-
A.2.15. A.2.9.
Does Bugzilla provide record locking when there is simultaneous access
to the same bug? Does the second person get a notice that the bug is in use
@@ -1529,7 +1242,7 @@ CLASS="question"
NAME="faq-phb-backup"
>A.2.16. A.2.10.
Are there any backup features provided?
A.2.17. A.2.11.
Can users be on the system while a backup is in progress?
A.2.18. A.2.12.
What type of human resources are needed to be on staff to install and
maintain Bugzilla? Specifically, what type of skills does the person need to
have? I need to find out if we were to go with Bugzilla, what types of
individuals would we need to hire and how much would that cost vs buying an
- "Out-of-the-Box" solution.
+ "out-of-the-box" solution?
A.2.19. A.2.13.
What time frame are we looking at if we decide to hire people to install
and maintain the Bugzilla? Is this something that takes hours or weeks to
@@ -1653,7 +1366,7 @@ CLASS="question"
NAME="faq-phb-cost"
>A.2.20. A.2.14.
Is there any licensing fee or other fees for using Bugzilla? Any
out-of-pocket cost other than the bodies needed as identified above?
@@ -1735,34 +1448,6 @@ CLASS="answer"
A.3.3.
- I've implemented the security fixes mentioned in Chris Yeh's security
- advisory of 5/10/2000 advising not to run MySQL as root, and am running into
- problems with MySQL no longer working correctly.
-
- This is a common problem, related to running out of file descriptors.
- Simply add "ulimit -n unlimited" to the script which starts
- mysqld.
-
A.4.3.
- I want whineatnews.pl to whine at something more, or other than, only new
+ I want whineatnews.pl to whine at something different to only new
bugs. How do I do it?
A.4.4.
- I don't like/want to use Procmail to hand mail off to bug_email.pl.
- What alternatives do I have?
-
- You can call bug_email.pl directly from your aliases file, with
- an entry like this:
-
- However, this is fairly nasty and subject to problems; you also
- need to set up your smrsh (sendmail restricted shell) to allow
- it. In a pinch, though, it can work.
-
A.4.5. A.4.4.
How do I set up the email interface to submit/change bugs via email?
If you are using sendmail, try enabling
- sendmailnow in editparams.cgi.
-
A.4.7. A.4.6.
How come email from Bugzilla changes never reaches me?
If you never receive mail from Bugzilla, chances you do not have
+>
If you never receive mail from Bugzilla, chances are you do not have
sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked
to, "/usr/lib/sendmail".
- Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle.
+ Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle,
+ but it is now so old as to be obsolete, and is totally unsupported.
Red Hat's newer version (based on 2.17.1 and soon to be merged into
the main distribution) runs on PostgreSQL. At this time we know of
- no recent ports of Bugzilla to Oracle but do intend to support it
- in the future (possibly the 2.20 time-frame).
+ no recent ports of Bugzilla to Oracle; to be honest, Bugzilla
+ doesn't need what Oracle offers.
utility
(./sanitycheck.cgi in the
- Bugzilla_home directory) from your web browser to see! If
- it finishes without errors, you're
+>sanitycheck.cgi) from your web browser to see!
+ If it finishes without errors, you're
probably OK. If it doesn't come back
@@ -2328,7 +1974,7 @@ CLASS="answer"
>
Microsoft has some advice on this matter, as well:
For more information about how to configure Apache for Bugzilla,
see Section 4.4.1Section 4.2.1.
Much more detailed information about the suggestions in
Section 5.6.2Section 4.5.2.
5.5. Groups and Group Security5.8. Groups and Group Security
Groups allow the administrator
to isolate bugs or products that should only be seen by certain people.
@@ -213,9 +216,10 @@ ALT="Warning">
The User Regexp is a perl regexp and, if not anchored, will match
- any part of an address. So, if you do not want to grant access
- into 'mycompany.com' to 'badperson@mycompany.com.hacker.net', use
+>If specifying a domain in the regexp, make sure you end
+ the regexp with a $. Otherwise, when granting access to
+ "@mycompany\.com", you will allow access to
+ 'badperson@mycompany.com.cracker.net'. You need to use
'@mycompany\.com$' as the regexp.
This section distills some Bugzilla tips and best practices
that have been developed.
3.2.1. Autolinkification
3.7.1. Autolinkification
Bugzilla comments are plain text - so posting HTML will result
- in literal HTML tags rather than being interpreted by a browser.
+>Bugzilla comments are plain text - so typing <U> will
+ produce less-than, U, greater-than rather than underlined text.
However, Bugzilla will automatically make hyperlinks out of certain
sorts of text in comments. For example, the text
- http://www.bugzilla.org will be turned into
+ "http://www.bugzilla.org" will be turned into a link:
comment 7
bug 23456, comment 53
3.2.2. Quicksearch3.7.2. Quicksearch
Quicksearch is a single-text-box query tool which uses
metacharacters to indicate what is to be searched. For example, typing
@@ -183,7 +190,7 @@ CLASS="section"
>3.2.3. Comments3.7.3. Comments
If you are changing the fields on a bug, only comment if
either you have something pertinent to say, or Bugzilla requires it.
@@ -196,7 +203,7 @@ NAME="commenting"
Don't use sigs in comments. Signing your name ("Bill") is acceptable,
- particularly if you do it out of habit, but full mail/news-style
+ if you do it out of habit, but full mail/news-style
four line ASCII art creations are not.
3.2.4. Attachments3.7.4. Attachments
Use attachments, rather than comments, for large chunks of ASCII data,
such as trace, debugging output files, or log files. That way, it doesn't
@@ -231,9 +238,9 @@ CLASS="section"
>
3.2.5. Filing Bugs
3.7.5. Filing Bugs
Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
@@ -268,7 +275,7 @@ WIDTH="33%"
ALIGN="left"
VALIGN="top"
>PrevHow do I use Bugzilla?Patch Viewer
This section contains information for end-users of Bugzilla.
- There is a Bugzilla test installation, called
- Landfill,
- which you are welcome to play with (if it's up.)
- However, it does not necessarily
- have all Bugzilla features enabled, and often runs cutting-edge versions
- of Bugzilla for testing, so some things may work slightly differently
- than mentioned here.
3.1.1. Create a Bugzilla Account
If you want to use Bugzilla, first you need to create an account.
- Consult with the administrator responsible for your installation of
- Bugzilla for the URL you should use to access it. If you're
- test-driving Bugzilla, use this URL:
- http://landfill.bugzilla.org/bugzilla-tip/.
-
Click the
- "Open a new Bugzilla account"
-
- link, enter your email address and, optionally, your name in the
- spaces provided, then click
- "Create Account"
-
- .
Within moments, you should receive an email to the address
- you provided above, which contains your login name (generally the
- same as the email address), and a password you can use to access
- your account. This password is randomly generated, and can be
- changed to something more memorable.
Click the
- "Log In"
- link in the yellow area at the bottom of the page in your browser,
- enter your email address and password into the spaces provided, and
- click
- "Login".
-
You are now logged in. Bugzilla uses cookies for authentication
- so, unless your IP address changes, you should not have to log in
- again.
3.1.2. Anatomy of a Bug
The core of Bugzilla is the screen which displays a particular
- bug. It's a good place to explain some Bugzilla concepts.
-
Bug 1 on Landfill
-
- is a good example. Note that the labels for most fields are hyperlinks;
- clicking them will take you to context-sensitive help on that
- particular field. Fields marked * may not be present on every
- installation of Bugzilla.
Product and Component:
- Bugs are divided up by Product and Component, with a Product
- having one or more Components in it. For example,
- bugzilla.mozilla.org's "Bugzilla" Product is composed of several
- Components:
-
Administration:
- Administration of a Bugzilla installation.
Bugzilla-General:
- Anything that doesn't fit in the other components, or spans
- multiple components.
Creating/Changing Bugs:
- Creating, changing, and viewing bugs.
Documentation:
- The Bugzilla documentation, including The Bugzilla Guide.
Email:
- Anything to do with email sent by Bugzilla.
Installation:
- The installation process of Bugzilla.
Query/Buglist:
- Anything to do with searching for bugs and viewing the
- buglists.
Reporting/Charting:
- Getting reports from Bugzilla.
User Accounts:
- Anything about managing a user account from the user's perspective.
- Saved queries, creating accounts, changing passwords, logging in,
- etc.
User Interface:
- General issues having to do with the user interface cosmetics (not
- functionality) including cosmetic issues, HTML templates,
- etc.
-
Status and Resolution:
-
- These define exactly what state the bug is in - from not even
- being confirmed as a bug, through to being fixed and the fix
- confirmed by Quality Assurance. The different possible values for
- Status and Resolution on your installation should be documented in the
- context-sensitive help for those items.
Assigned To:
- The person responsible for fixing the bug.
*URL:
- A URL associated with the bug, if any.
Summary:
- A one-sentence summary of the problem.
*Status Whiteboard:
- (a.k.a. Whiteboard) A free-form text area for adding short notes
- and tags to a bug.
*Keywords:
- The administrator can define keywords which you can use to tag and
- categorise bugs - e.g. The Mozilla Project has keywords like crash
- and regression.
Platform and OS:
- These indicate the computing environment where the bug was
- found.
Version:
- The "Version" field is usually used for versions of a product which
- have been released, and is set to indicate which versions of a
- Component have the particular problem the bug report is
- about.
Priority:
- The bug assignee uses this field to prioritise his or her bugs.
- It's a good idea not to change this on other people's bugs.
Severity:
- This indicates how severe the problem is - from blocker
- ("application unusable") to trivial ("minor cosmetic issue"). You
- can also use this field to indicate whether a bug is an enhancement
- request.
*Target:
- (a.k.a. Target Milestone) A future version by which the bug is to
- be fixed. e.g. The Bugzilla Project's milestones for future
- Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
- restricted to numbers, thought - you can use any text strings, such
- as dates.
Reporter:
- The person who filed the bug.
CC list:
- A list of people who get mail when the bug changes.
Attachments:
- You can attach files (e.g. testcases or patches) to bugs. If there
- are any attachments, they are listed in this section.
*Dependencies:
- If this bug cannot be fixed unless other bugs are fixed (depends
- on), or this bug stops other bugs being fixed (blocks), their
- numbers are recorded here.
*Votes:
- Whether this bug has any votes.
Additional Comments:
- You can add your two cents to the bug discussion here, if you have
- something worthwhile to say.
3.1.3. Searching for Bugs
The Bugzilla Search page is is the interface where you can find
- any bug report, comment, or patch currently in the Bugzilla system. You
- can play with it here:
- http://landfill.bugzilla.org/bugzilla-tip/query.cgi.
The Search page has controls for selecting different possible
- values for all of the fields in a bug, as described above. For some
- fields, multiple values can be selected. In those cases, Bugzilla
- returns bugs where the content of the field matches one of the selected
- values. If none is selected, then the field can take any value.
Once you've defined a search, you can either run it, or save it
- as a Remembered Query, which can optionally appear in the footer of
- your pages.
Highly advanced querying is done using Boolean Charts.
3.1.4. Bug Lists
If you run a search, a list of matching bugs will be returned.
- The default search is to return all open bugs on the system - don't try
- running this search on a Bugzilla installation with a lot of
- bugs!
The format of the list is configurable. For example, it can be
- sorted by clicking the column headings. Other useful features can be
- accessed using the links at the bottom of the list:
-
Long Format:
-
- this gives you a large page with a non-editable summary of the fields
- of each bug.
Change Columns:
-
- change the bug attributes which appear in the list.
Change several bugs at once:
-
- If your account is sufficiently empowered, you can make the same
- change to all the bugs in the list - for example, changing their
- owner.
Send mail to bug owners:
-
- Sends mail to the owners of all bugs on the list.
Edit this query:
-
- If you didn't get exactly the results you were looking for, you can
- return to the Query page through this link and make small revisions
- to the query you just made so you get more accurate results.
-
3.1.5. Filing Bugs
Years of bug writing experience has been distilled for your
- reading pleasure into the
-
Bug Writing Guidelines.
- While some of the advice is Mozilla-specific, the basic principles of
- reporting Reproducible, Specific bugs, isolating the Product you are
- using, the Version of the Product, the Component which failed, the
- Hardware Platform, and Operating System you were using at the time of
- the failure go a long way toward ensuring accurate, responsible fixes
- for the bug that bit you.
The procedure for filing a test bug is as follows:
Fill in the fields. Bugzilla should have made reasonable
- guesses, based upon your browser, for the "Platform" and "OS"
- drop-down boxes. If they are wrong, change them.
Select "Commit" and send in your bug report.
3.1.6. Patch Viewer
Viewing and reviewing patches in Bugzilla is often difficult due to
- lack of context, improper format and the inherent readability issues that
- raw patches present. Patch Viewer is an enhancement to Bugzilla designed
- to fix that by offering increased context, linking to sections, and
- integrating with Bonsai, LXR and CVS.
Patch viewer allows you to:
View patches in color, with side-by-side view rather than trying
- to interpret the contents of the patch.
See the difference between two patches.
Get more context in a patch.
Collapse and expand sections of a patch for easy
- reading.
Link to a particular section of a patch for discussion or
- review
Go to Bonsai or LXR to see more context, blame, and
- cross-references for the part of the patch you are looking at
Create a rawtext unified format diff out of any patch, no
- matter what format it came from
3.1.6.1. Viewing Patches in Patch Viewer
The main way to view a patch in patch viewer is to click on the
- "Diff" link next to a patch in the Attachments list on a bug. You may
- also do this within the edit window by clicking the "View Attachment As
- Diff" button in the Edit Attachment screen.
3.1.6.2. Seeing the Difference Between Two Patches
To see the difference between two patches, you must first view the
- newer patch in Patch Viewer. Then select the older patch from the
- dropdown at the top of the page ("Differences between [dropdown] and
- this patch") and click the "Diff" button. This will show you what
- is new or changed in the newer patch.
3.1.6.3. Getting More Context in a Patch
To get more context in a patch, you put a number in the textbox at
- the top of Patch Viewer ("Patch / File / [textbox]") and hit enter.
- This will give you that many lines of context before and after each
- change. Alternatively, you can click on the "File" link there and it
- will show each change in the full context of the file. This feature only
- works against files that were diffed using "cvs diff".
3.1.6.4. Collapsing and Expanding Sections of a Patch
To view only a certain set of files in a patch (for example, if a
- patch is absolutely huge and you want to only review part of it at a
- time), you can click the "(+)" and "(-)" links next to each file (to
- expand it or collapse it). If you want to collapse all files or expand
- all files, you can click the "Collapse All" and "Expand All" links at the
- top of the page.
3.1.6.5. Linking to a Section of a Patch
To link to a section of a patch (for example, if you want to be
- able to give someone a URL to show them which part you are talking
- about) you simply click the "Link Here" link on the section header. The
- resulting URL can be copied and used in discussion. (Copy Link
- Location in Mozilla works as well.)
3.1.6.6. Going to Bonsai and LXR
To go to Bonsai to get blame for the lines you are interested in,
- you can click the "Lines XX-YY" link on the section header you are
- interested in. This works even if the patch is against an old
- version of the file, since Bonsai stores all versions of the file.
To go to LXR, you click on the filename on the file header
- (unfortunately, since LXR only does the most recent version, line
- numbers are likely to rot).
3.1.6.7. Creating a Unified Diff
If the patch is not in a format that you like, you can turn it
- into a unified diff format by clicking the "Raw Unified" link at the top
- of the page.