+The Bugzilla Guide - 2.16.4 Release
-The Bugzilla Guide - 2.16.4 ReleaseMatthew P. BarnsonThe Bugzilla Team
+Matthew P. Barnson
-2003-11-01
+The Bugzilla Team
+
+ 2003-11-01
This is the documentation for Bugzilla, the mozilla.org bug-tracking
system. Bugzilla is an enterprise-class piece of software that powers
The most current version of this document can always be found on the
Bugzilla Documentation Page.
- _______________________________________________________________________
+ _________________________________________________________________
Table of Contents
1. About This Guide
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.1 or
- any later version published by the Free Software Foundation; with no
- Invariant Sections, no Front-Cover Texts, and with no Back-Cover
- Texts. A copy of the license is included in Appendix E.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.1 or
+ any later version published by the Free Software Foundation; with no
+ Invariant Sections, no Front-Cover Texts, and with no Back-Cover
+ Texts. A copy of the license is included in Appendix E.
---Copyright (c) 2000-2003 Matthew P. Barnson and The Bugzilla Team
+ --Copyright (c) 2000-2003 Matthew P. Barnson and The Bugzilla Team
If you have any questions regarding this document, its copyright, or
publishing this document in non-electronic form, please contact The
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. 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 pee on your
-furniture and clothing, and global thermonuclear 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, 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 your security needs are met.
+ No liability for the contents of this document can be accepted. Use
+ the concepts, examples, and other content 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 pee on your furniture and clothing, and global thermonuclear
+ 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, 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
+ your security needs are met.
_________________________________________________________________
1.3. New Versions
-This is the 2.16.4 version of The Bugzilla Guide. It is so named to match
-the version of Bugzilla it is disributed with. 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.
+ This is the 2.16.4 version of The Bugzilla Guide. It is so named to
+ match the version of Bugzilla it is disributed with. 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 bugzilla.org;
-including documentation for past releases and the current development
-version.
+ The newest version of this guide can always be found at 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.
+ The documentation for the most recent stable release of Bugzilla can
+ also be found at The Linux Documentation Project.
-The latest version of this document can always be checked out via CVS.
-Please follow the instructions available at the Mozilla CVS page, and check
-out the mozilla/webtools/bugzilla/docs/ subtree.
+ The latest version of this document can always be checked out via CVS.
+ Please follow the instructions available at the Mozilla CVS page, and
+ check out the mozilla/webtools/bugzilla/docs/ subtree.
-The Bugzilla Guide is currently only available in English. If you would like
-to volunteer to translate it, please contact Dave Miller.
+ The Bugzilla Guide is currently only available in English. If you
+ would like to volunteer to translate it, please contact Dave Miller.
_________________________________________________________________
1.4. Credits
-The people listed below have made enormous contributions to the creation of
-this Guide, through their writing, dedicated hacking efforts, numerous
-e-mail and IRC support sessions, and overall excellent contribution to the
-Bugzilla community:
+ The people listed below have made enormous contributions to the
+ creation of this Guide, through their writing, dedicated hacking
+ efforts, numerous e-mail and IRC support sessions, and overall
+ excellent contribution to the Bugzilla community:
Matthew P. Barnson <mbarnson@sisna.com>
for the Herculaean task of pulling together the Bugzilla Guide
1.5. Document Conventions
-This document uses the following conventions:
+ This document uses the following conventions:
Descriptions Appearance
Use caution
+
Caution
- Don't run with scissors!
+ Don't run with scissors!
Hint
+
Tip
- Would you like a breath mint?
+ Would you like a breath mint?
Notes
+
Note
- Dear John...
+ Dear John...
Warnings
+
Warning
- Read this or the cat gets it.
+ Read this or the cat gets it.
File Names filename
Directory Names directory
Commands to be typed command
Emphasized word word
Term found in the glossary Bugzilla
Code Example
-<para>
-Beginning and end of paragraph
-</para>
+ Beginning and end of paragraph
+ </para>
_________________________________________________________________
Chapter 2. Introduction
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.
-
-Bugzilla boasts many advanced features. These include:
+ 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.
+
+ Bugzilla boasts many advanced features. These include:
* Powerful searching
* User-configurable email notifications of bug changes
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 management,
-chip design and development problem tracking (both pre-and-post
-fabrication), and software and hardware bug tracking for luminaries such as
-Redhat, NASA, Linux-Mandrake, and VA Systems. Combined with systems such as
-CVS, Bonsai, or Perforce SCM, 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.
+ 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
+ management, chip design and development problem tracking (both
+ pre-and-post fabrication), and software and hardware bug tracking for
+ luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems.
+ Combined with systems such as CVS, Bonsai, or Perforce SCM, 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.
+ 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/
+ 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/
1. Click the "Open a new Bugzilla account" link, enter your email
address and, optionally, your name in the spaces provided, then
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.
+ 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.
1. Product and Component: Bugs are divided up by Product and
Component, with a Product having one or more Components in it. For
several Components:
Administration: Administration of a Bugzilla installation.
- Bugzilla-General: Anything that doesn't fit in the other components,
- or spans multiple components.
+ 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.
+ 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.
+ 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.
+ 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.
2. 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
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: landfill.bugzilla.org/bugzilla-tip/query.cgi .
+ 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: 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. 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.
+ The Search page has controls for selecting different possible values
+ for all of the fields in a bug, as described above. 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, which have their own
-context-sensitive help .
+ Highly advanced querying is done using Boolean Charts, which have
+ their own context-sensitive help .
_________________________________________________________________
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!
+ 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:
+ 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 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.
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.
+ 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:
+ The procedure for filing a test bug is as follows:
1. Go to Landfill in your browser and click Enter a new bug report.
2. Select a product - any one will do.
3.2. Hints and Tips
-This section distills some Bugzilla tips and best practices that have been
-developed.
+ This section distills some Bugzilla tips and best practices that have
+ been developed.
_________________________________________________________________
3.2.1. Autolinkification
-Bugzilla comments are plain text - so posting HTML will result in literal
-HTML tags rather than being interpreted by a browser. 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. Other strings which get linkified in the obvious
-manner are:
-
-bug 12345
-bug 23456, comment 53
-attachment 4321
-mailto:george@example.com
-george@example.com
-ftp://ftp.mozilla.org
-Most other sorts of URL
+ Bugzilla comments are plain text - so posting HTML will result in
+ literal HTML tags rather than being interpreted by a browser. 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. Other strings which get
+ linkified in the obvious manner are:
+
+ bug 12345
+ bug 23456, comment 53
+ attachment 4321
+ mailto:george@example.com
+ george@example.com
+ ftp://ftp.mozilla.org
+ Most other sorts of URL
A corollary here is that if you type a bug number in a comment, you
should put the word "bug" before it, so it gets autolinkified for the
3.2.2. Quicksearch
-Quicksearch is a single-text-box query tool which uses metacharacters to
-indicate what is to be searched. For example, typing "foo|bar" into
-Quicksearch would search for "foo" or "bar" in the summary and status
-whiteboard of a bug; adding ":BazProduct" would search only in that product.
+ Quicksearch is a single-text-box query tool which uses metacharacters
+ to indicate what is to be searched. For example, typing "foo|bar" into
+ Quicksearch would search for "foo" or "bar" in the summary and status
+ whiteboard of a bug; adding ":BazProduct" would search only in that
+ product.
-You'll find the Quicksearch box on Bugzilla's front page, along with a Help
-link which details how to use it.
+ You'll find the Quicksearch box on Bugzilla's front page, along with a
+ Help link which details how to use it.
_________________________________________________________________
3.2.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. Otherwise, you may spam
-people unnecessarily with bug mail. To take an example: a user can set up
-their account to filter out messages where someone just adds themselves to
-the CC field of a bug (which happens a lot.) If you come along, add yourself
-to the CC field, and add a comment saying "Adding self to CC", then that
-person gets a pointless piece of mail they would otherwise have avoided.
-
-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 four line
-ASCII art creations are not.
+ If you are changing the fields on a bug, only comment if either you
+ have something pertinent to say, or Bugzilla requires it. Otherwise,
+ you may spam people unnecessarily with bug mail. To take an example: a
+ user can set up their account to filter out messages where someone
+ just adds themselves to the CC field of a bug (which happens a lot.)
+ If you come along, add yourself to the CC field, and add a comment
+ saying "Adding self to CC", then that person gets a pointless piece of
+ mail they would otherwise have avoided.
+
+ 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 four
+ line ASCII art creations are not.
_________________________________________________________________
3.2.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 bloat
-the bug for everyone who wants to read it, and cause people to receive fat,
-useless mails.
+ 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 bloat the bug for everyone who wants to read it, and cause
+ people to receive fat, useless mails.
-Trim screenshots. There's no need to show the whole screen if you are
-pointing out a single-pixel problem.
+ Trim screenshots. There's no need to show the whole screen if you are
+ pointing out a single-pixel problem.
-Don't attach simple test cases (e.g. one HTML file, one CSS file and an
-image) as a ZIP file. Instead, upload them in reverse order and edit the
-referring file so that they point to the attached files. This way, the test
-case works immediately out of the bug.
+ Don't attach simple test cases (e.g. one HTML file, one CSS file and
+ an image) as a ZIP file. Instead, upload them in reverse order and
+ edit the referring file so that they point to the attached files. This
+ way, the test case works immediately out of the bug.
_________________________________________________________________
3.2.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 ensure your
-original information is easily accessible.
+ Try to make sure that everything said in the summary is also said in
+ the first comment. Summaries are often updated and this will ensure
+ your original information is easily accessible.
-You do not need to put "any" or similar strings in the URL field. If there
-is no specific URL associated with the bug, leave this field blank.
+ You do not need to put "any" or similar strings in the URL field. If
+ there is no specific URL associated with the bug, leave this field
+ blank.
-If you feel a bug you filed was incorrectly marked as a DUPLICATE of
-another, please question it in your bug, not the bug it was duped to. Feel
-free to CC the person who duped it if they are not already CCed.
+ If you feel a bug you filed was incorrectly marked as a DUPLICATE of
+ another, please question it in your bug, not the bug it was duped to.
+ Feel free to CC the person who duped it if they are not already CCed.
_________________________________________________________________
3.3. 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:
+ 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
-On this tab, you can change your basic account information, including your
-password, email address and real name. For security reasons, in order to
-change anything on this page you must type your current password into the
-"Password" field at the top of the page. If you attempt to change your email
-address, a confirmation email is sent to both the old and new addresses,
-with a link to use to confirm the change. This helps to prevent account
-hijacking.
+ On this tab, you can change your basic account information, including
+ your password, email address and real name. For security reasons, in
+ order to change anything on this page you must type your current
+ password into the "Password" field at the top of the page. If you
+ attempt to change your email address, a confirmation email is sent to
+ both the old and new addresses, with a link to use to confirm the
+ change. This helps to prevent account hijacking.
_________________________________________________________________
3.3.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.)
+ 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.)
-By entering user email names, delineated by commas, into the "Users to
-watch" text entry box you can receive a copy of all the bugmail of other
-users (security settings permitting.) This powerful functionality enables
-seamless transitions as developers change projects or users go on holiday.
+ By entering user email names, delineated by commas, into the "Users to
+ watch" text entry box you can receive a copy of all the bugmail of
+ other users (security settings permitting.) This powerful
+ functionality enables seamless transitions as developers change
+ projects or users go on holiday.
Note
- The ability to watch other users may not be available in all Bugzilla
- installations. If you can't see it, ask your administrator.
+ The ability to watch other users may not be available in all Bugzilla
+ installations. If you can't see it, ask your administrator.
_________________________________________________________________
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.
+ 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
-This is a purely informative page which outlines your current permissions on
-this installation of Bugzilla - what product groups you are in, and whether
-you can edit bugs or perform various administration functions.
+ This is a purely informative page which outlines your current
+ permissions on this installation of Bugzilla - what product groups you
+ are in, and whether you can edit bugs or perform various
+ administration functions.
_________________________________________________________________
Chapter 4. Installation
4.1.1. Introduction
-Bugzilla has been successfully installed under Solaris, Linux, and Win32.
-Win32 is not yet officially supported, but many people have got it working
-fine. Please see the Win32 Installation Notes for further advice on getting
-Bugzilla to work on Microsoft Windows.
+ Bugzilla has been successfully installed under Solaris, Linux, and
+ Win32. Win32 is not yet officially supported, but many people have got
+ it working fine. Please see the Win32 Installation Notes for further
+ advice on getting Bugzilla to work on Microsoft Windows.
_________________________________________________________________
4.1.2. Package List
Note
- If you are running the very most recent version of Perl and MySQL
- (both the executables and development libraries) on your system, you
- can skip these manual installation steps for the Perl modules by using
- Bundle::Bugzilla; see Using Bundle::Bugzilla instead of manually
- installing Perl modules.
+ If you are running the very most recent version of Perl and MySQL
+ (both the executables and development libraries) on your system, you
+ can skip these manual installation steps for the Perl modules by using
+ Bundle::Bugzilla; see Using Bundle::Bugzilla instead of manually
+ installing Perl modules.
The software packages necessary for the proper running of Bugzilla
(with download links) are:
d. MIME::Parser (any) for the email interface
4. The web server of your choice. Apache is highly recommended.
- Warning
+ Warning
- It is a good idea, while installing Bugzilla, to ensure that there is
- some kind of firewall between you and the rest of the Internet,
- because your machine may be insecure for periods during the install.
- Many installation steps require an active Internet connection to
- complete, but you must take care to ensure that at no point is your
- machine vulnerable to an attack.
+ It is a good idea, while installing Bugzilla, to ensure that there is
+ some kind of firewall between you and the rest of the Internet,
+ because your machine may be insecure for periods during the install.
+ Many installation steps require an active Internet connection to
+ complete, but you must take care to ensure that at no point is your
+ machine vulnerable to an attack.
- Note
+ Note
- Linux-Mandrake 8.0 includes every required and optional library for
- Bugzilla. The easiest way to install them is by using the urpmi
- utility. If you follow these commands, you should have everything you
- need for Bugzilla, and checksetup.pl should not complain about any
- missing libraries. You may already have some of these installed.
-
- bash# urpmi perl-mysql
- bash# urpmi perl-chart
- bash# urpmi perl-gd
- bash# urpmi perl-MailTools (for Bugzilla email integration)
- bash# urpmi apache-modules
+ Linux-Mandrake 8.0 includes every required and optional library for
+ Bugzilla. The easiest way to install them is by using the urpmi
+ utility. If you follow these commands, you should have everything you
+ need for Bugzilla, and checksetup.pl should not complain about any
+ missing libraries. You may already have some of these installed.
+
+
+ bash# urpmi perl-mysql
+ bash# urpmi perl-chart
+ bash# urpmi perl-gd
+ bash# urpmi perl-MailTools (for Bugzilla email integration)
+ bash# urpmi apache-modules
_________________________________________________________________
4.1.3. MySQL
-Visit the MySQL homepage at www.mysql.com to grab and install the latest
-stable release of the server.
+ Visit the MySQL homepage at www.mysql.com to grab and install the
+ latest stable release of the server.
Note
- Many of the binary versions of MySQL store their data files in /var.
- On some Unix systems, this is part of a smaller root partition, and
- may not have room for your bug database. You can set the data
- directory as an option to configure if you build MySQL from source
- yourself.
+ Many of the binary versions of MySQL store their data files in /var.
+ On some Unix systems, this is part of a smaller root partition, and
+ may not have room for your bug database. You can set the data
+ directory as an option to configure if you build MySQL from source
+ yourself.
If you install from something other than an RPM or Debian package, you
will need to add mysqld to your init scripts so the server daemon will
4.1.4. Perl
-Any machine that doesn't have Perl on it is a sad machine indeed. Perl can
-be got in source form from perl.com for the rare *nix systems which don't
-have it. Although Bugzilla runs with all post-5.005 versions of Perl, 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.6.1.
+ Any machine that doesn't have Perl on it is a sad machine indeed. Perl
+ can be got in source form from perl.com for the rare *nix systems
+ which don't have it. Although Bugzilla runs with all post-5.005
+ versions of Perl, 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.6.1.
Tip
- You can skip the following Perl module installation steps by
- installing Bundle::Bugzilla from CPAN, which installs all required
- modules for you.
+ You can skip the following Perl module installation steps by
+ installing Bundle::Bugzilla from CPAN, which installs all required
+ modules for you.
- bash# perl -MCPAN -e 'install "Bundle::Bugzilla"'
+ bash# perl -MCPAN -e 'install "Bundle::Bugzilla"'
- Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser,
- which are not essential to a basic Bugzilla install. If installing
- this bundle fails, you should install each module individually to
- isolate the problem.
+ Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser,
+ which are not essential to a basic Bugzilla install. If installing
+ this bundle fails, you should install each module individually to
+ isolate the problem.
_________________________________________________________________
4.1.5. Perl Modules
-All Perl modules can be found on the Comprehensive Perl Archive Network
-(CPAN). The CPAN servers have a real tendency to bog down, so please use
-mirrors.
+ All Perl modules can be found on the Comprehensive Perl Archive
+ Network (CPAN). The CPAN servers have a real tendency to bog down, so
+ please use mirrors.
-Quality, general Perl module installation instructions can be found on the
-CPAN website, but the easy thing to do is to just use the CPAN shell which
-does all the hard work for you. To use the CPAN shell to install a module:
+ Quality, general Perl module installation instructions can be found on
+ the CPAN website, but the easy thing to do is to just use the CPAN
+ shell which does all the hard work for you. To use the CPAN shell to
+ install a module:
-bash# perl -MCPAN -e 'install "<modulename>"'
+ bash# perl -MCPAN -e 'install "<modulename>"'
-To do it the hard way:
+ To do it the hard way:
-Untar the module tarball -- it should create its own directory
+ Untar the module tarball -- it should create its own directory
-CD to the directory just created, and enter the following commands:
+ CD to the directory just created, and enter the following commands:
1. bash# perl Makefile.PL
2. bash# make
3. bash# make test
4. bash# make install
- Warning
-
- Many people complain that Perl modules will not install for them. Most
- times, the error messages complain that they are missing a file in
- "@INC". Virtually every time, this error is due to permissions being
- set too restrictively for you to compile Perl modules or not having
- the necessary Perl development libraries installed on your system.
- Consult your local UNIX systems administrator for help solving these
- permissions issues; if you are the local UNIX sysadmin, please consult
- the newsgroup/mailing list for further assistance or hire someone to
- help you out.
+ Warning
+
+ Many people complain that Perl modules will not install for them. Most
+ times, the error messages complain that they are missing a file in
+ "@INC". Virtually every time, this error is due to permissions being
+ set too restrictively for you to compile Perl modules or not having
+ the necessary Perl development libraries installed on your system.
+ Consult your local UNIX systems administrator for help solving these
+ permissions issues; if you are the local UNIX sysadmin, please consult
+ the newsgroup/mailing list for further assistance or hire someone to
+ help you out.
_________________________________________________________________
4.1.5.1. DBI
-The DBI module is a generic Perl module used the MySQL-related modules. As
-long as your Perl installation was done correctly the DBI module should be a
-breeze. It's a mixed Perl/C module, but Perl's MakeMaker system simplifies
-the C compilation greatly.
+ The DBI module is a generic Perl module used the MySQL-related
+ modules. As long as your Perl installation was done correctly the DBI
+ module should be a breeze. It's a mixed Perl/C module, but Perl's
+ MakeMaker system simplifies the C compilation greatly.
_________________________________________________________________
4.1.5.2. Data::Dumper
-The Data::Dumper module provides data structure persistence for Perl
-(similar to Java's serialization). It comes with later sub-releases of Perl
-5.004, but a re-installation just to be sure it's available won't hurt
-anything.
+ The Data::Dumper module provides data structure persistence for Perl
+ (similar to Java's serialization). It comes with later sub-releases of
+ Perl 5.004, but a re-installation just to be sure it's available won't
+ hurt anything.
_________________________________________________________________
4.1.5.3. MySQL-related modules
-The Perl/MySQL interface requires a few mutually-dependent Perl modules.
-These modules are grouped together into the the Msql-Mysql-modules package.
-
-The MakeMaker process will ask you a few questions about the desired
-compilation target and your MySQL installation. For most of the questions
-the provided default will be adequate, but when asked if your desired target
-is the MySQL or mSQL packages, you should select the MySQL related ones.
-Later you will be asked if you wish to provide backwards compatibility with
-the older MySQL packages; you should answer YES to this question. The
-default is NO.
-
-A host of 'localhost' should be fine and a testing user of 'test' with a
-null password should find itself with sufficient access to run tests on the
-'test' database which MySQL created upon installation.
+ The Perl/MySQL interface requires a few mutually-dependent Perl
+ modules. These modules are grouped together into the the
+ Msql-Mysql-modules package.
+
+ The MakeMaker process will ask you a few questions about the desired
+ compilation target and your MySQL installation. For most of the
+ questions the provided default will be adequate, but when asked if
+ your desired target is the MySQL or mSQL packages, you should select
+ the MySQL related ones. Later you will be asked if you wish to provide
+ backwards compatibility with the older MySQL packages; you should
+ answer YES to this question. The default is NO.
+
+ A host of 'localhost' should be fine and a testing user of 'test' with
+ a null password should find itself with sufficient access to run tests
+ on the 'test' database which MySQL created upon installation.
_________________________________________________________________
4.1.5.4. TimeDate modules
-Many of the more common date/time/calendar related Perl modules have been
-grouped into a bundle similar to the MySQL modules bundle. This bundle is
-stored on the CPAN under the name TimeDate. The component module we're most
-interested in is the Date::Format module, but installing all of them is
-probably a good idea anyway.
+ Many of the more common date/time/calendar related Perl modules have
+ been grouped into a bundle similar to the MySQL modules bundle. This
+ bundle is stored on the CPAN under the name TimeDate. The component
+ module we're most interested in is the Date::Format module, but
+ installing all of them is probably a good idea anyway.
_________________________________________________________________
4.1.5.5. GD (optional)
-The GD library was written by Thomas Boutell a long while ago to
-programatically generate images in C. Since then it's become the defacto
-standard for programatic image construction. The Perl bindings to it found
-in the GD library are used on millions of web pages to generate graphs on
-the fly. That's what Bugzilla will be using it for so you must install it if
-you want any of the graphing to work.
+ The GD library was written by Thomas Boutell a long while ago to
+ programatically generate images in C. Since then it's become the
+ defacto standard for programatic image construction. The Perl bindings
+ to it found in the GD library are used on millions of web pages to
+ generate graphs on the fly. That's what Bugzilla will be using it for
+ so you must install it if you want any of the graphing to work.
Note
- The Perl GD library requires some other libraries that may or may not
- be installed on your system, including libpng and libgd. The full
- requirements are listed in the Perl GD library README. If compiling GD
- fails, it's probably because you're missing a required library.
+ The Perl GD library requires some other libraries that may or may not
+ be installed on your system, including libpng and libgd. The full
+ requirements are listed in the Perl GD library README. If compiling GD
+ fails, it's probably because you're missing a required library.
_________________________________________________________________
4.1.5.6. Chart::Base (optional)
-The Chart module provides Bugzilla with on-the-fly charting abilities. It
-can be installed in the usual fashion after it has been fetched from CPAN.
-Note that earlier versions that 0.99c used GIFs, which are no longer
-supported by the latest versions of GD.
+ The Chart module provides Bugzilla with on-the-fly charting abilities.
+ It can be installed in the usual fashion after it has been fetched
+ from CPAN. Note that earlier versions that 0.99c used GIFs, which are
+ no longer supported by the latest versions of GD.
_________________________________________________________________
4.1.5.7. Template Toolkit
-When you install Template Toolkit, you'll get asked various questions about
-features to enable. The defaults are fine, except that it is recommended you
-use the high speed XS Stash of the Template Toolkit, in order to achieve
-best performance. However, there are known problems with XS Stash and Perl
-5.005_02 and lower. If you wish to use these older versions of Perl, please
-use the regular stash.
+ When you install Template Toolkit, you'll get asked various questions
+ about features to enable. The defaults are fine, except that it is
+ recommended you use the high speed XS Stash of the Template Toolkit,
+ in order to achieve best performance. However, there are known
+ problems with XS Stash and Perl 5.005_02 and lower. If you wish to use
+ these older versions of Perl, please use the regular stash.
_________________________________________________________________
4.1.6. HTTP Server
-You have a freedom of choice here - Apache, Netscape or any other server on
-UNIX would do. You can run the web server on a different machine than MySQL,
-but need to adjust the MySQL "bugs" user permissions accordingly.
+ You have a freedom of choice here - Apache, Netscape or any other
+ server on UNIX would do. You can run the web server on a different
+ machine than MySQL, but need to adjust the MySQL "bugs" user
+ permissions accordingly.
Note
- 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.
+ 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.
You'll want to make sure that your web server will run any file with
the .cgi extension as a CGI and not just display it. If you're using
With Apache you'll also want to make sure that within the httpd.conf
file the line:
-Options ExecCGI
-AllowOverride Limit
+ Options ExecCGI
+ AllowOverride Limit
is in the stanza that covers the directories into which you intend to
put the bugzilla .html and .cgi files.
Note
- AllowOverride Limit allows the use of a Deny statement in the
- .htaccess file generated by checksetup.pl
+ AllowOverride Limit allows the use of a Deny statement in the
+ .htaccess file generated by checksetup.pl
- Users of older versions of Apache may find the above lines in the
- srm.conf and access.conf files, respecitvely.
+ Users of older versions of Apache may find the above lines in the
+ srm.conf and access.conf files, respecitvely.
- Warning
+ Warning
- There are important files and directories that should not be a served
- by the HTTP server - most files in the "data" and "shadow" directories
- and the "localconfig" file. You should configure your HTTP server to
- not serve these files. Failure to do so will expose critical passwords
- and other data. Please see .htaccess files and security for details on
- how to do this for Apache; the checksetup.pl script should create
- appropriate .htaccess files for you.
+ There are important files and directories that should not be a served
+ by the HTTP server - most files in the "data" and "shadow" directories
+ and the "localconfig" file. You should configure your HTTP server to
+ not serve these files. Failure to do so will expose critical passwords
+ and other data. Please see .htaccess files and security for details on
+ how to do this for Apache; the checksetup.pl script should create
+ appropriate .htaccess files for you.
_________________________________________________________________
4.1.7. 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.
+ 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.
Tip
- If you symlink the bugzilla directory into your Apache's HTML
- heirarchy, you may receive Forbidden errors unless you add the
- "FollowSymLinks" directive to the <Directory> entry for the HTML root
- in httpd.conf.
+ If you symlink the bugzilla directory into your Apache's HTML
+ heirarchy, 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
the following Perl one-liner, but I suggest using the symlink approach
to avoid upgrade hassles.
-perl -pi -e
- 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
- processmail syncshadowdb
+ perl -pi -e
+ 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
+ processmail syncshadowdb
Change /usr/bin/perl to match the location of Perl on your machine.
_________________________________________________________________
4.1.8. 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.
+ 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.
-First, you'll want to fix MySQL permissions to allow access from Bugzilla.
-For the purpose of this Installation section, the Bugzilla username will be
-"bugs", and will have minimal permissions.
+ First, you'll want to fix MySQL permissions to allow access from
+ Bugzilla. For the purpose of this Installation section, the Bugzilla
+ username will be "bugs", and will have minimal permissions.
-Begin by giving the MySQL root user a password. MySQL passwords are limited
-to 16 characters.
+ Begin by giving the MySQL root user a password. MySQL passwords are
+ limited to 16 characters.
-bash# mysql -u root mysql
+ bash# mysql -u root mysql
mysql> UPDATE user SET Password=PASSWORD('<new_password>') WHERE
user='root';
-mysql> FLUSH PRIVILEGES;
+ mysql> FLUSH PRIVILEGES;
From this point on, if you need to access MySQL as the MySQL root
user, you will need to use mysql -u root -p and enter <new_password>.
Note
- If you are using MySQL 4, the bugs user also needs to be granted the
- LOCK TABLES and CREATE TEMPORARY TABLES permissions.
+ If you are using MySQL 4, the bugs user also needs to be granted the
+ LOCK TABLES and CREATE TEMPORARY TABLES permissions.
_________________________________________________________________
4.1.9. 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 MySQL
-database and other configuration options are consistent with the Bugzilla
-CGI files. It will make sure Bugzilla files and directories have reasonable
-permissions, set up the data directory, and create all the MySQL tables.
+ Next, run the magic checksetup.pl script. (Many thanks to Holger
+ Schurig for writing this script!) This script is designed to make sure
+ your MySQL database and other configuration options are consistent
+ with the Bugzilla CGI files. It will make sure Bugzilla files and
+ directories have reasonable permissions, set up the data directory,
+ and create all the MySQL tables.
-bash# ./checksetup.pl
+ bash# ./checksetup.pl
The first time you run it, it will create a file called localconfig.
Note
- The checksetup.pl script is designed so that you can run it at any
- time without causing harm. You should run it after any upgrade to
- Bugzilla.
+ The checksetup.pl script is designed so that you can run it at any
+ time without causing harm. You should run it after any upgrade to
+ Bugzilla.
_________________________________________________________________
4.1.10. Configuring Bugzilla
-You should run through the parameters on the Edit Parameters page (link in
-the footer) and set them all to appropriate values. They key parameters are
-documented in Section 5.1.
+ You should run through the parameters on the Edit Parameters page
+ (link in the footer) and set them all to appropriate values. They key
+ parameters are documented in Section 5.1.
_________________________________________________________________
4.2. Optional Additional Configuration
4.2.1. Dependency Charts
-As well as the text-based dependency graphs, Bugzilla also supports
-dependency graphing, using a package called 'dot'. Exactly how this works is
-controlled by the 'webdotbase' parameter, which can have one of three
-values:
+ As well as the text-based dependency graphs, Bugzilla also supports
+ dependency graphing, using a package called 'dot'. Exactly how this
+ works is controlled by the 'webdotbase' parameter, which can have one
+ of three values:
1. A complete file path to the command 'dot' (part of GraphViz) will
generate the graphs locally
4.2.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.
+ As long as you installed the GD and Graph::Base Perl modules you might
+ as well turn on the nifty Bugzilla bug reporting graphs.
-Add a cron entry like this to run collectstats.pl daily at 5 after midnight:
+ Add a cron entry like this to run collectstats.pl daily at 5 after
+ midnight:
-bash# crontab -e
-5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl
+ bash# crontab -e
+ 5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl
After two days have passed you'll be able to view bug graphs from the
Bug Reports page.
4.2.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 can set up
-Bugzilla's automatic whining system to complain at engineers which leave
-their bugs in the NEW state without triaging them.
+ 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 can
+ set up Bugzilla's automatic whining system to complain at engineers
+ which leave their bugs in the NEW state without triaging them.
-This can be done by adding the following command as a daily crontab entry
-(for help on that see that crontab man page):
+ This can be done by adding the following command as a daily crontab
+ entry (for help on that see that crontab man page):
-cd <your-bugzilla-directory> ; ./whineatnews.pl
+ cd <your-bugzilla-directory> ; ./whineatnews.pl
- Tip
+ Tip
+
+ Depending on your system, crontab may have several manpages. The
+ following command should lead you to the most useful page for this
+ purpose:
- Depending on your system, crontab may have several manpages. The
- following command should lead you to the most useful page for this
- purpose:
- man 5 crontab
+ man 5 crontab
_________________________________________________________________
4.2.4. LDAP Authentication
- Warning
+ Warning
- This information on using the LDAP authentication options with
- Bugzilla is old, and the authors do not know of anyone who has tested
- it. Approach with caution.
+ This information on using the LDAP authentication options with
+ Bugzilla is old, and the authors do not know of anyone who has tested
+ it. Approach with caution.
The existing authentication scheme for Bugzilla uses email addresses
as the primary user ID, and a password to authenticate that user. All
4.2.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
-http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3. Executing
-the following code snippet from a UNIX command shell will rectify the
-problem if your Bugzilla installation is intended for an English-speaking
-audience. As always, be sure your Bugzilla installation has a good backup
-before making changes, and I recommend you understand what the script is
-doing before executing it.
+ 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
+ http://www.cet.org/tech_tips/malicious_code_mitigation.html/#3.
+ Executing the following code snippet from a UNIX command shell will
+ rectify the problem if your Bugzilla installation is intended for an
+ English-speaking audience. As always, be sure your Bugzilla
+ installation has a good backup before making changes, and I recommend
+ you understand what the script is doing before executing it.
bash# perl -pi -e "s/Content-Type\: text\/html/Content-Type\: text\/html\; char
set=ISO-8859-1/i" *.cgi *.pl
4.2.6. .htaccess files and security
-To enhance the security of your Bugzilla installation, Bugzilla's
-checksetup.pl script will generate .htaccess files which the Apache
-webserver can use to restrict access to the bugzilla data files. These
-.htaccess files will not work with Apache 1.2.x - but this has security
-holes, so you shouldn't be using it anyway.
+ To enhance the security of your Bugzilla installation, Bugzilla's
+ checksetup.pl script will generate .htaccess files which the Apache
+ webserver can use to restrict access to the bugzilla data files. These
+ .htaccess files will not work with Apache 1.2.x - but this has
+ security holes, so you shouldn't be using it anyway.
Note
- If you are using an alternate provider of webdot services for graphing
- (as described when viewing editparams.cgi in your web browser), you
- will need to change the ip address in data/webdot/.htaccess to the ip
- address of the webdot server that you are using.
+ If you are using an alternate provider of webdot services for graphing
+ (as described when viewing editparams.cgi in your web browser), you
+ will need to change the ip address in data/webdot/.htaccess to the ip
+ address of the webdot server that you are using.
The default .htaccess file may not provide adequate access
restrictions, depending on your web server configuration. Be sure to
/usr/local/bugzilla . You should have this <Directory> entry in your
httpd.conf file:
- <Directory /usr/local/bugzilla/>
- Options +FollowSymLinks +Indexes +Includes +ExecCGI
- AllowOverride All
-</Directory>
+ <Directory /usr/local/bugzilla/>
+ Options +FollowSymLinks +Indexes +Includes +ExecCGI
+ AllowOverride All
+ </Directory>
The important part above is "AllowOverride All" . Without that, the
.htaccess file created by checksetup.pl will not have sufficient
4.2.7. mod_throttle and Security
-It is possible for a user, by mistake or on purpose, to access the database
-many times in a row which can result in very slow access speeds for other
-users. If your Bugzilla installation is experiencing this problem , you may
-install the Apache module mod_throttle which can limit connections by
-ip-address. You may download this module at
-http://www.snert.com/Software/mod_throttle/ Follow the instructions to
-install into your Apache install. This module only functions with the Apache
-web server! You may use the ThrottleClientIP command provided by this module
-to accomplish this goal. See the Module Instructions for more information.
+ It is possible for a user, by mistake or on purpose, to access the
+ database many times in a row which can result in very slow access
+ speeds for other users. If your Bugzilla installation is experiencing
+ this problem , you may install the Apache module mod_throttle which
+ can limit connections by ip-address. You may download this module at
+ http://www.snert.com/Software/mod_throttle/ Follow the instructions to
+ install into your Apache install. This module only functions with the
+ Apache web server! You may use the ThrottleClientIP command provided
+ by this module to accomplish this goal. See the Module Instructions
+ for more information.
_________________________________________________________________
4.3. Win32 Installation Notes
-This section covers installation on Microsoft Windows. Bugzilla has been
-made to work on Win32 platforms, but the Bugzilla team wish to emphasise
-that The easiest way to install Bugzilla on Intel-archiecture machines is to
-install some variant of GNU/Linux, then follow the UNIX installation
-instructions in this Guide. If you have any influence in the platform choice
-for running this system, please choose GNU/Linux instead of Microsoft
-Windows.
+ This section covers installation on Microsoft Windows. Bugzilla has
+ been made to work on Win32 platforms, but the Bugzilla team wish to
+ emphasise that The easiest way to install Bugzilla on
+ Intel-archiecture machines is to install some variant of GNU/Linux,
+ then follow the UNIX installation instructions in this Guide. If you
+ have any influence in the platform choice for running this system,
+ please choose GNU/Linux instead of Microsoft Windows.
Warning
- After that warning, here's the situation for 2.16 and Windows. It
- doesn't work at all out of the box. You are almost certainly better
- off getting the 2.17 version from CVS (after consultation with the
- Bugzilla Team to make sure you are pulling on a stable day) because
- we'll be doing a load of work to make the Win32 experience more
- pleasant than it is now.
+ After that warning, here's the situation for 2.16 and Windows. It
+ doesn't work at all out of the box. You are almost certainly better
+ off getting the 2.17 version from CVS (after consultation with the
+ Bugzilla Team to make sure you are pulling on a stable day) because
+ we'll be doing a load of work to make the Win32 experience more
+ pleasant than it is now.
If you still want to try this, to have any hope of getting it to work,
you'll need to apply the mail patch from bug 124174. After that,
Note
- You should be familiar with, and cross-reference, the rest of the
- Bugzilla Installation section while performing your Win32
- installation.
-
- Making Bugzilla work on Microsoft Windows is no picnic. Support for
- Win32 has improved dramatically in the last few releases, but, if you
- choose to proceed, you should be a very skilled Windows Systems
- Administrator with strong troubleshooting abilities, a high tolerance
- for pain, and moderate perl skills. Bugzilla on NT requires hacking
- source code and implementing some advanced utilities. What follows is
- the recommended installation procedure for Win32; additional
- suggestions are provided in Appendix A .
-
+ You should be familiar with, and cross-reference, the rest of the
+ Bugzilla Installation section while performing your Win32
+ installation.
+
+ Making Bugzilla work on Microsoft Windows is no picnic. Support for
+ Win32 has improved dramatically in the last few releases, but, if you
+ choose to proceed, you should be a very skilled Windows Systems
+ Administrator with strong troubleshooting abilities, a high tolerance
+ for pain, and moderate perl skills. Bugzilla on NT requires hacking
+ source code and implementing some advanced utilities. What follows is
+ the recommended installation procedure for Win32; additional
+ suggestions are provided in Appendix A .
1. Install Apache Web Server for Windows, and copy the Bugzilla files
somewhere Apache can serve them. Please follow all the
instructions referenced in Bugzilla Installation regarding your
Apache configuration, particularly instructions regarding the
"AddHandler" parameter and "ExecCGI" .
- Note
+ Note
- You may also use Internet Information Server or Personal Web Server
- for this purpose. However, setup is quite different. If ActivePerl
- doesn't seem to handle your file associations correctly (for .cgi and
- .pl files), please consult Appendix A .
- If you are going to use IIS, if on Windows NT you must be updated to
- at least Service Pack 4. Windows 2000 ships with a sufficient version
- of IIS.
+ You may also use Internet Information Server or Personal Web Server
+ for this purpose. However, setup is quite different. If ActivePerl
+ doesn't seem to handle your file associations correctly (for .cgi and
+ .pl files), please consult Appendix A .
+ If you are going to use IIS, if on Windows NT you must be updated to
+ at least Service Pack 4. Windows 2000 ships with a sufficient version
+ of IIS.
2. Install ActivePerl for Windows. Check
http://aspn.activestate.com/ASPN/Downloads/ActivePerl for a
current compiled binary.
AppConfig and Template should be obtained from OpenInteract using
the instructions on the Template Toolkit web site .
- Note
+ Note
- You can find a list of modules at
- http://www.activestate.com/PPMPackages/zips/5xx-builds-only/ or
- http://www.activestate.com/PPMPackages/5.6plus
+ You can find a list of modules at
+ http://www.activestate.com/PPMPackages/zips/5xx-builds-only/ or
+ http://www.activestate.com/PPMPackages/5.6plus
The syntax for ppm is: C:> ppm <modulename>
Example 4-1. Installing ActivePerl ppd Modules on Microsoft
Windows
- C:> ppm DBD-Mysql
+ C:> ppm DBD-Mysql
Watch your capitalization!
ActiveState's 5.6Plus directory also contains an AppConfig ppm, so
you might see the following error when trying to install the
the ppd file explicitly via in the install command, f.e.:
Example 4-2. Installing OpenInteract ppd Modules manually on
Microsoft Windows
- install C:\AppConfig.ppd
+ install C:\AppConfig.ppd
4. Install MySQL for NT.
- Note
+ Note
- You can download MySQL for Windows NT from MySQL.com . Some find it
- helpful to use the WinMySqlAdmin utility, included with the download,
- to set up the database.
+ You can download MySQL for Windows NT from MySQL.com . Some find it
+ helpful to use the WinMySqlAdmin utility, included with the download,
+ to set up the database.
5. Setup MySQL
a. C:> C:\mysql\bin\mysql -u root mysql
b. mysql> DELETE FROM user WHERE Host='localhost' AND User='';
h. C:> C:\mysql\bin\mysqladmin -u root -p reload
6. Edit checksetup.pl in your Bugzilla directory. Change this line:
-my $webservergid =
- getgrnam($my_webservergroup);
+ my $webservergid =
+ getgrnam($my_webservergroup);
to
-my $webservergid =
- $my_webservergroup;
+ my $webservergid =
+ $my_webservergroup;
or the name of the group you wish to own the files explicitly:
-my $webservergid =
- 'Administrators'
+ my $webservergid =
+ 'Administrators'
7. Run checksetup.pl from the Bugzilla directory.
8. Edit localconfig to suit your requirements. Set $db_pass to your
"bugs_password" from step 5.d , and $webservergroup to "8" .
- Note
+ Note
- Not sure on the "8" for $webservergroup above. If it's wrong, please
- send corrections.
+ Not sure on the "8" for $webservergroup above. If it's wrong, please
+ send corrections.
9. Edit defparams.pl to suit your requirements. Particularly, set
DefParam("maintainer") and DefParam("urlbase") to match your
install.
- Note
+ Note
- This is yet another step I'm not sure of, since the maintainer of this
- documentation does not maintain Bugzilla on NT. If you can confirm or
- deny that this step is required, please let me know.
+ This is yet another step I'm not sure of, since the maintainer of this
+ documentation does not maintain Bugzilla on NT. If you can confirm or
+ deny that this step is required, please let me know.
10.
- Note
+ Note
- There are several alternatives to Sendmail that will work on Win32.
- The one mentioned here is a suggestion , not a requirement. Some other
- mail packages that can work include BLAT , Windmail , Mercury Sendmail
- , and the CPAN Net::SMTP Perl module (available in .ppm). Every option
- requires some hacking of the Perl scripts for Bugzilla to make it
- work. The option here simply requires the least.
+ There are several alternatives to Sendmail that will work on Win32.
+ The one mentioned here is a suggestion , not a requirement. Some other
+ mail packages that can work include BLAT , Windmail , Mercury Sendmail
+ , and the CPAN Net::SMTP Perl module (available in .ppm). Every option
+ requires some hacking of the Perl scripts for Bugzilla to make it
+ work. The option here simply requires the least.
1. Download NTsendmail, available from www.ntsendmail.com . You
must have a "real" mail server which allows you to relay off
it in your $ENV{"NTsendmail"} (which you should probably
2. Put ntsendmail.pm into your .\perl\lib directory.
3. Add to globals.pl:
-# these settings configure the NTsendmail
- process use NTsendmail;
- $ENV{"NTsendmail"}="your.smtpserver.box";
- $ENV{"NTsendmail_debug"}=1;
- $ENV{"NTsendmail_max_tries"}=5;
+ # these settings configure the NTsendmail
+ process use NTsendmail;
+ $ENV{"NTsendmail"}="your.smtpserver.box";
+ $ENV{"NTsendmail_debug"}=1;
+ $ENV{"NTsendmail_max_tries"}=5;
- Note
+ Note
- Some mention to also edit $db_pass in globals.pl to be your
- "bugs_password" . Although this may get you around some problem
- authenticating to your database, since globals.pl is not normally
- restricted by .htaccess , your database password is exposed to whoever
- uses your web server.
+ Some mention to also edit $db_pass in globals.pl to be your
+ "bugs_password" . Although this may get you around some problem
+ authenticating to your database, since globals.pl is not normally
+ restricted by .htaccess , your database password is exposed to whoever
+ uses your web server.
4. Find and comment out all occurences of " open(SENDMAIL " in
your Bugzilla directory. Then replace them with:
-# new sendmail functionality my $mail=new
- NTsendmail; my $from="bugzilla\@your.machine.name.tld"; my
- $to=$login; my $subject=$urlbase;
- $mail->send($from,$to,$subject,$msg);
+ # new sendmail functionality my $mail=new
+ NTsendmail; my $from="bugzilla\@your.machine.name.tld"; my
+ $to=$login; my $subject=$urlbase;
+ $mail->send($from,$to,$subject,$msg);
- Note
+Note
+
+ Some have found success using the commercial product, Windmail . You
+ could try replacing your sendmail calls with:
- Some have found success using the commercial product, Windmail . You
- could try replacing your sendmail calls with:
-open SENDMAIL,
- "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t >
- mail.log";
+ open SENDMAIL,
+ "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t >
+ mail.log";
- or something to that effect.
+ or something to that effect.
11. Change all references in all files from processmail to
processmail.pl , and rename processmail to processmail.pl .
- Note
+ Note
- Many think this may be a change we want to make for main-tree
- Bugzilla. It's painless for the UNIX folks, and will make the Win32
- people happier.
+ Many think this may be a change we want to make for main-tree
+ Bugzilla. It's painless for the UNIX folks, and will make the Win32
+ people happier.
Note
NTsendmail or the other options listed here. You can change
processmail.pl to make this work.
+
my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP ser
ver
$smtp->mail('<your name>@<you smpt server>');# use the sender's adress here
here is a test mail program for Net::SMTP:
-use Net::SMTP;
- my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug
-=> 1, ); # connect to SMTP server
- $smtp->auth;
- $smtp->mail('you@yourcompany.com');# use the sender's adress
-here
- $smtp->to('someotherAddress@someotherdomain.com'); #
-recipient's address
- $smtp->data(); # Start the mail
- $smtp->datasend('test');
- $smtp->dataend(); # Finish sending the mail
- $smtp->quit; # Close the SMTP connection
-exit;
+ use Net::SMTP;
+ my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug
+ => 1, ); # connect to SMTP server
+ $smtp->auth;
+ $smtp->mail('you@yourcompany.com');# use the sender's adress
+ here
+ $smtp->to('someotherAddress@someotherdomain.com'); #
+ recipient's address
+ $smtp->data(); # Start the mail
+ $smtp->datasend('test');
+ $smtp->dataend(); # Finish sending the mail
+ $smtp->quit; # Close the SMTP connection
+ exit;
12.
- Note
+ Note
- This step is optional if you are using IIS or another web server which
- only decides on an interpreter based upon the file extension (.pl),
- rather than the "shebang" line (#/usr/bonsaitools/bin/perl)
+ This step is optional if you are using IIS or another web server which
+ only decides on an interpreter based upon the file extension (.pl),
+ rather than the "shebang" line (#/usr/bonsaitools/bin/perl)
Modify the path to perl on the first line (#!) of all files to
point to your Perl installation, and add "perl" to the beginning
of all Perl system calls that use a perl script as an argument.
processmail:
-system ("./processmail",@ARGLIST);
- </programlisting> to
- <programlisting>
-system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
+ system ("./processmail",@ARGLIST);
+ </programlisting> to
+ system ("C:\\perl\\bin\\perl", "processmail", @ARGLIST);
lines to createattachment.cgi and showattachment.cgi before the
require 'CGI.pl'; line.
-binmode(STDIN);
-binmode(STDOUT);
+ binmode(STDIN);
+ binmode(STDOUT);
- Note
+ Note
- According to bug 62000 , the perl documentation says that you should
- always use binmode() when dealing with binary files, but never when
- dealing with text files. That seems to suggest that rather than
- arbitrarily putting binmode() at the beginning of the attachment
- files, there should be logic to determine if binmode() is needed or
- not.
+ According to bug 62000 , the perl documentation says that you should
+ always use binmode() when dealing with binary files, but never when
+ dealing with text files. That seems to suggest that rather than
+ arbitrarily putting binmode() at the beginning of the attachment
+ files, there should be logic to determine if binmode() is needed or
+ not.
- Tip
+ Tip
+
+ If you are using IIS or Personal Web Server, you must add cgi
+ relationships to Properties -> Home directory (tab) -> Application
+ Settings (section) -> Configuration (button), such as:
- If you are using IIS or Personal Web Server, you must add cgi
- relationships to Properties -> Home directory (tab) -> Application
- Settings (section) -> Configuration (button), such as:
-.cgi to: <perl install directory>\perl.exe %s
- %s .pl to: <perl install directory>\perl.exe %s %s
- GET,HEAD,POST
+
.cgi to: <perl install directory>\perl.exe %s
+
%s .pl to: <perl install directory>\perl.exe %s %s
+ GET,HEAD,POST
- Change the path to Perl to match your install, of course.
+ Change the path to Perl to match your install, of course.
_________________________________________________________________
4.3.2. Additional Windows Tips
Basically you need to add two String Keys in the registry at the
following location:
+
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Paramete
rs\ScriptMap
The KB article only talks about .pl, but it goes into more detail
and provides a perl test script.
- Tip
+ Tip
+
+ If attempting to run Bugzilla 2.12 or older, you will need to remove
+ encrypt() calls from the Perl source. This is not necessary for
+ Bugzilla 2.13 and later, which includes the current release, Bugzilla
+ 2.16.4.
- If attempting to run Bugzilla 2.12 or older, you will need to remove
- encrypt() calls from the Perl source. This is not necessary for
- Bugzilla 2.13 and later, which includes the current release, Bugzilla
- 2.16.4.
+ Example 4-3. Removing encrypt() for Windows NT Bugzilla version 2.12
+ or earlier
- Example 4-3. Removing encrypt() for Windows NT Bugzilla version 2.12
- or earlier
+ Replace this:
- Replace this:
-SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) .
- ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my
- $enteredcryptpwd = FetchOneColumn();
+ SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) .
+ ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); my
+ $enteredcryptpwd = FetchOneColumn();
- with this:
- my $enteredcryptpwd = $enteredpwd
+ with this:
+ my $enteredcryptpwd = $enteredpwd
- in cgi.pl.
+ in cgi.pl.
_________________________________________________________________
4.4. Mac OS X Installation Notes
-There are a lot of common libraries and utilities out there that Apple did
-not include with Mac OS X, but which run perfectly well on it. The GD
-library, which Bugzilla needs to do bug graphs, is one of these.
-
-The easiest way to get a lot of these is with a program called Fink, which
-is similar in nature to the CPAN installer, but installs common GNU
-utilities. Fink is available from <http://sourceforge.net/projects/fink/>.
-
-Follow the instructions for setting up Fink. Once it's installed, you'll
-want to run the following as root: fink install gd
-
-It will prompt you for a number of dependencies, type 'y' and hit enter to
-install all of the dependencies. Then watch it work.
-
-To prevent creating conflicts with the software that Apple installs by
-default, Fink creates its own directory tree at /sw where it installs most
-of the software that it installs. This means your libraries and headers for
-libgd will be at /sw/lib and /sw/include instead of /usr/lib and
-/usr/local/include. Because of these changed locations for the libraries,
-the Perl GD module will not install directly via CPAN, because it looks for
-the specific paths instead of getting them from your environment. But
-there's a way around that :-)
-
-Instead of typing "install GD" at the cpan> prompt, type look GD. This
-should go through the motions of downloading the latest version of the GD
-module, then it will open a shell and drop you into the build directory.
-Apply this patch to the Makefile.PL file (save the patch into a file and use
-the command patch < patchfile.)
-
-Then, run these commands to finish the installation of the GD module:
-
-perl Makefile.PL
-make
-make test
-make install
-And don't forget to run exit to get back to CPAN.
+ There are a lot of common libraries and utilities out there that Apple
+ did not include with Mac OS X, but which run perfectly well on it. The
+ GD library, which Bugzilla needs to do bug graphs, is one of these.
+
+ The easiest way to get a lot of these is with a program called Fink,
+ which is similar in nature to the CPAN installer, but installs common
+ GNU utilities. Fink is available from
+ <http://sourceforge.net/projects/fink/>.
+
+ Follow the instructions for setting up Fink. Once it's installed,
+ you'll want to run the following as root: fink install gd
+
+ It will prompt you for a number of dependencies, type 'y' and hit
+ enter to install all of the dependencies. Then watch it work.
+
+ To prevent creating conflicts with the software that Apple installs by
+ default, Fink creates its own directory tree at /sw where it installs
+ most of the software that it installs. This means your libraries and
+ headers for libgd will be at /sw/lib and /sw/include instead of
+ /usr/lib and /usr/local/include. Because of these changed locations
+ for the libraries, the Perl GD module will not install directly via
+ CPAN, because it looks for the specific paths instead of getting them
+ from your environment. But there's a way around that :-)
+
+ Instead of typing "install GD" at the cpan> prompt, type look GD. This
+ should go through the motions of downloading the latest version of the
+ GD module, then it will open a shell and drop you into the build
+ directory. Apply this patch to the Makefile.PL file (save the patch
+ into a file and use the command patch < patchfile.)
+
+ Then, run these commands to finish the installation of the GD module:
+
+ perl Makefile.PL
+ make
+ make test
+ make install
+ And don't forget to run exit to get back to CPAN.
_________________________________________________________________
4.5. Troubleshooting
-This section gives solutions to common Bugzilla installation problems.
+ This section gives solutions to common Bugzilla installation problems.
_________________________________________________________________
4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1
-Try executing perl -MCPAN -e 'install CPAN' and then continuing.
+ Try executing perl -MCPAN -e 'install CPAN' and then continuing.
-Certain older versions of the CPAN toolset were somewhat naive about how to
-upgrade Perl modules. When a couple of modules got rolled into the core Perl
-distribution for 5.6.1, CPAN thought that the best way to get those modules
-up to date was to haul down the Perl distribution itself and build it.
-Needless to say, this has caused headaches for just about everybody.
-Upgrading to a newer version of CPAN with the commandline above should fix
-things.
+ Certain older versions of the CPAN toolset were somewhat naive about
+ how to upgrade Perl modules. When a couple of modules got rolled into
+ the core Perl distribution for 5.6.1, CPAN thought that the best way
+ to get those modules up to date was to haul down the Perl distribution
+ itself and build it. Needless to say, this has caused headaches for
+ just about everybody. Upgrading to a newer version of CPAN with the
+ commandline above should fix things.
_________________________________________________________________
4.5.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):
-
+ The following error message may appear due to a bug in DBD::mysql
+ (over which the Bugzilla team have no control):
DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site
/lib/DBD/mysql.pm line 248.
SV = NULL(0x0) at 0x20fc444
To fix this, go to <path-to-perl>/lib/DBD/sponge.pm in your Perl
installation and replace
- my $numFields;
- if ($attribs->{'NUM_OF_FIELDS'}) {
- $numFields = $attribs->{'NUM_OF_FIELDS'};
- } elsif ($attribs->{'NAME'}) {
- $numFields = @{$attribs->{NAME}};
+ my $numFields;
+ if ($attribs->{'NUM_OF_FIELDS'}) {
+ $numFields = $attribs->{'NUM_OF_FIELDS'};
+ } elsif ($attribs->{'NAME'}) {
+ $numFields = @{$attribs->{NAME}};
by
- my $numFields;
- if ($attribs->{'NUM_OF_FIELDS'}) {
- $numFields = $attribs->{'NUM_OF_FIELDS'};
- } elsif ($attribs->{'NAMES'}) {
- $numFields = @{$attribs->{NAMES}};
+ my $numFields;
+ if ($attribs->{'NUM_OF_FIELDS'}) {
+ $numFields = $attribs->{'NUM_OF_FIELDS'};
+ } elsif ($attribs->{'NAMES'}) {
+ $numFields = @{$attribs->{NAMES}};
(note the S added to NAME.)
_________________________________________________________________
4.5.3. cannot chdir(/var/spool/mqueue)
-If you are installing Bugzilla on SuSE Linux, or some other distributions
-with "paranoid" security options, it is possible that the checksetup.pl
-script may fail with the error:
-
-cannot chdir(/var/spool/mqueue): Permission denied
+ If you are installing Bugzilla on SuSE Linux, or some other
+ distributions with "paranoid" security options, it is possible that
+ the checksetup.pl script may fail with the error:
+ cannot chdir(/var/spool/mqueue): Permission denied
This is because your /var/spool/mqueue directory has a mode of
"drwx------". Type chmod 755 /var/spool/mqueue as root to fix this
4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT
-This is caused by a bug in the version of File::Temp that is distributed
-with perl 5.6.0. Many minor variations of this error have been reported.
-Examples can be found in Figure 4-1.
+ This is caused by a bug in the version of File::Temp that is
+ distributed with perl 5.6.0. Many minor variations of this error have
+ been reported. Examples can be found in Figure 4-1.
Figure 4-1. Other File::Temp error messages
-Your vendor has not defined Fcntl macro O_NOINHERIT, used
-at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 208.
+ Your vendor has not defined Fcntl macro O_NOINHERIT, used
+ at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 208.
-Your vendor has not defined Fcntl macro O_EXLOCK, used
-at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 210.
+ Your vendor has not defined Fcntl macro O_EXLOCK, used
+ at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 210.
-Your vendor has not defined Fcntl macro O_TEMPORARY, used
-at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233.
+ Your vendor has not defined Fcntl macro O_TEMPORARY, used
+ at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233.
Numerous people have reported that upgrading to version 5.6.1 or
higher solved the problem for them. A less involved fix is to apply
the patch in Figure 4-2. The patch is also available as a patch file.
Figure 4-2. Patch for File::Temp in Perl 5.6.0
---- File/Temp.pm.orig Thu Feb 6 16:26:00 2003
-+++ File/Temp.pm Thu Feb 6 16:26:23 2003
-@@ -205,6 +205,7 @@
- # eg CGI::Carp
- local $SIG{__DIE__} = sub {};
- local $SIG{__WARN__} = sub {};
-+ local *CORE::GLOBAL::die = sub {};
- $bit = &$func();
- 1;
- };
-@@ -226,6 +227,7 @@
- # eg CGI::Carp
- local $SIG{__DIE__} = sub {};
- local $SIG{__WARN__} = sub {};
-+ local *CORE::GLOBAL::die = sub {};
- $bit = &$func();
- 1;
- };
+ --- File/Temp.pm.orig Thu Feb 6 16:26:00 2003
+ +++ File/Temp.pm Thu Feb 6 16:26:23 2003
+ @@ -205,6 +205,7 @@
+ # eg CGI::Carp
+ local $SIG{__DIE__} = sub {};
+ local $SIG{__WARN__} = sub {};
+ + local *CORE::GLOBAL::die = sub {};
+ $bit = &$func();
+ 1;
+ };
+ @@ -226,6 +227,7 @@
+ # eg CGI::Carp
+ local $SIG{__DIE__} = sub {};
+ local $SIG{__WARN__} = sub {};
+ + local *CORE::GLOBAL::die = sub {};
+ $bit = &$func();
+ 1;
+ };
_________________________________________________________________
Chapter 5. Administering Bugzilla
5.1. Bugzilla Configuration
-Bugzilla is configured by changing various parameters, accessed from the
-"Edit parameters" link in the page footer. Here are some of the key
-parameters on that page. You should run down this list and set them
-appropriately after installing Bugzilla.
-
+ Bugzilla is configured by changing various parameters, accessed from
+ the "Edit parameters" link in the page footer. Here are some of the
+ key parameters on that page. You should run down this list and set
+ them appropriately after installing Bugzilla.
1. maintainer: The maintainer parameter is the email address of the
person responsible for maintaining this Bugzilla installation. The
address need not be that of a valid Bugzilla account.
database. Set "shadowdb" to e.g. "bug_shadowdb" if you will be
running a *very* large installation of Bugzilla.
- Note
+ Note
- Enabling "shadowdb" can adversely affect the stability of your
- installation of Bugzilla. You should regularly check that your
- database is in sync. It is often advisable to force a shadow database
- sync nightly via "cron".
+ Enabling "shadowdb" can adversely affect the stability of your
+ installation of Bugzilla. You should regularly check that your
+ database is in sync. It is often advisable to force a shadow database
+ sync nightly via "cron".
If you use the "shadowdb" option, it is only natural that you
should turn the "queryagainstshadowdb" option on as well.
Otherwise you are replicating data into a shadow database for no
wise idea to require comments when users resolve, reassign, or
reopen bugs at the very least.
- Note
+ Note
- It is generally far better to require a developer comment when
- resolving bugs than not. Few things are more annoying to bug database
- users than having a developer mark a bug "fixed" without any comment
- as to what the fix was (or even that it was truly fixed!)
+ It is generally far better to require a developer comment when
+ resolving bugs than not. Few things are more annoying to bug database
+ users than having a developer mark a bug "fixed" without any comment
+ as to what the fix was (or even that it was truly fixed!)
12. supportwatchers: Turning on this option allows users to ask to
receive copies of all a particular other user's bug email. This
is, of course, subject to the groupset restrictions on the bug; if
5.2.1. Creating the Default User
-When you first run checksetup.pl after installing Bugzilla, it will prompt
-you for the administrative username (email address) and password for this
-"super user". If for some reason you delete the "super user" account,
-re-running checksetup.pl will again prompt you for this username and
-password.
+ When you first run checksetup.pl after installing Bugzilla, it will
+ prompt you for the administrative username (email address) and
+ password for this "super user". If for some reason you delete the
+ "super user" account, re-running checksetup.pl will again prompt you
+ for this username and password.
- Tip
+ Tip
- If you wish to add more administrative users, you must use the MySQL
- interface. Run "mysql" from the command line, and use these commands:
+ If you wish to add more administrative users, you must use the MySQL
+ interface. Run "mysql" from the command line, and use these commands:
- mysql> use bugs;
- mysql> update profiles set groupset=0x7ffffffffffffff where login_name
- = "(user's login name)";
- Yes, that is fourteen "f" 's. A whole lot of f-ing going on if you
+ mysql> use bugs;
+ mysql> update profiles set groupset=0x7ffffffffffffff where login_name
+ = "(user's login name)";
+
+ Yes, that is fourteen "f" 's. A whole lot of f-ing going on if you
want to create a new administator.
_________________________________________________________________
5.2.2.1. Creating new users
-Your users can create their own user accounts by clicking the "New Account"
-link at the bottom of each page (assuming they aren't logged in as someone
-else already.) However, should you desire to create user accounts ahead of
-time, here is how you do it.
+ Your users can create their own user accounts by clicking the "New
+ Account" link at the bottom of each page (assuming they aren't logged
+ in as someone else already.) However, should you desire to create user
+ accounts ahead of time, here is how you do it.
1. After logging in, click the "Users" link at the footer of the
query page, and then click "Add a new user".
2. Fill out the form presented. This page is self-explanatory. When
done, click "Submit".
- Note
+ Note
- Adding a user this way will not send an email informing them of their
- username and password. While useful for creating dummy accounts
- (watchers which shuttle mail to another system, for instance, or email
- addresses which are a mailing list), in general it is preferable to
- log out and use the "New Account" button to create users, as it will
- pre-populate all the required fields and also notify the user of her
- account name and password.
+ Adding a user this way will not send an email informing them of their
+ username and password. While useful for creating dummy accounts
+ (watchers which shuttle mail to another system, for instance, or email
+ addresses which are a mailing list), in general it is preferable to
+ log out and use the "New Account" button to create users, as it will
+ pre-populate all the required fields and also notify the user of her
+ account name and password.
_________________________________________________________________
5.2.2.2. Modifying Users
-To see a specific user, search for their login name in the box provided on
-the "Edit Users" page. To see all users, leave the box blank.
+ To see a specific user, search for their login name in the box
+ provided on the "Edit Users" page. To see all users, leave the box
+ blank.
-You can search in different ways the listbox to the right of the text entry
-box. You can match by case-insensitive substring (the default), regular
-expression, or a reverse regular expression match, which finds every user
-name which does NOT match the regular expression. (Please see the man regexp
-manual page for details on regular expression syntax.)
+ You can search in different ways the listbox to the right of the text
+ entry box. You can match by case-insensitive substring (the default),
+ regular expression, or a reverse regular expression match, which finds
+ every user name which does NOT match the regular expression. (Please
+ see the man regexp manual page for details on regular expression
+ syntax.)
-Once you have found your user, you can change the following fields:
+ Once you have found your user, you can change the following fields:
* Login Name: This is generally the user's full email address.
However, if you have are using the emailsuffix Param, this may
Warning
- Don't disable the administrator account!
+ Don't disable the administrator account!
- Note
+ Note
- The user can still submit bugs via the e-mail gateway, if you set it
- up, even if the disabled text field is filled in. The e-mail gateway
- should not be enabled for secure installations of Bugzilla.
+ The user can still submit bugs via the e-mail gateway, if you set it
+ up, even if the disabled text field is filled in. The e-mail gateway
+ should not be enabled for secure installations of Bugzilla.
* <groupname>: If you have created some groups, e.g.
"securitysensitive", then checkboxes will appear here to allow you
to add users to, or remove them from, these groups.
5.3.1. 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...)
+ 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.
+ 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:
+ To create a new product:
1. Select "products" from the footer
2. Select the "Add" link in the bottom right
5.3.2. 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.
+ 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.
+ 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:
+ To create a new Component:
1. Select the "Edit components" link from the "Edit product" page
2. Select the "Add" link in the bottom right.
5.3.3. 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.
+ 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:
+ To create and edit Versions:
1. From the "Edit product" screen, select "Edit Versions"
2. You will notice that the product already has the default version
5.3.4. 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.
+ 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.
Note
- Milestone options will only appear for a Product if you turned on the
- "usetargetmilestone" Param in the "Edit Parameters" screen.
+ 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:
4. From the Edit product screen, you can enter the URL of a page
which gives information about your milestones and what they mean.
- Tip
+ Tip
- 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.
+ 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
-Voting allows users to be given a pot of votes which they can allocate to
-bugs, to indicate that they'd like them fixed. This allows developers to
-gauge user need for a particular enhancement or bugfix. By allowing bugs
-with a certain number of votes to automatically move from "UNCONFIRMED" to
-"NEW", users of the bug system can help high-priority bugs garner attention
-so they don't sit for a long time awaiting triage.
+ Voting allows users to be given a pot of votes which they can allocate
+ to bugs, to indicate that they'd like them fixed. This allows
+ developers to gauge user need for a particular enhancement or bugfix.
+ By allowing bugs with a certain number of votes to automatically move
+ from "UNCONFIRMED" to "NEW", users of the bug system can help
+ high-priority bugs garner attention so they don't sit for a long time
+ awaiting triage.
-To modify Voting settings:
+ To modify Voting settings:
1. Navigate to the "Edit product" screen for the Product you wish to
modify
5.5. Groups and Group Security
-Groups allow the administrator to isolate bugs or products that should only
-be seen by certain people. There are two types of group - Generic Groups,
-and Product-Based Groups.
+ Groups allow the administrator to isolate bugs or products that should
+ only be seen by certain people. There are two types of group - Generic
+ Groups, and Product-Based Groups.
-Product-Based Groups are matched with products, and allow you to restrict
-access to bugs on a per-product basis. They are enabled using the
-usebuggroups Param. Turning on the usebuggroupsentry Param will mean bugs
-automatically get added to their product group when filed.
+ Product-Based Groups are matched with products, and allow you to
+ restrict access to bugs on a per-product basis. They are enabled using
+ the usebuggroups Param. Turning on the usebuggroupsentry Param will
+ mean bugs automatically get added to their product group when filed.
-Generic Groups have no special relationship to products; you create them,
-and put bugs in them as required. One example of the use of Generic Groups
-is Mozilla's "Security" group, into which security-sensitive bugs are placed
-until fixed. Only the Mozilla Security Team are members of this group.
+ Generic Groups have no special relationship to products; you create
+ them, and put bugs in them as required. One example of the use of
+ Generic Groups is Mozilla's "Security" group, into which
+ security-sensitive bugs are placed until fixed. Only the Mozilla
+ Security Team are members of this group.
-To create Generic Groups:
+ To create Generic Groups:
1. Select the "groups" link in the footer.
2. Take a moment to understand the instructions on the "Edit Groups"
1. Turn on "usebuggroups" and "usebuggroupsentry" in the "Edit
Parameters" screen.
- Warning
+ Warning
- XXX is this still true? "usebuggroupsentry" has the capacity to
- prevent the administrative user from directly altering bugs because of
- conflicting group permissions. If you plan on using
- "usebuggroupsentry", you should plan on restricting administrative
- account usage to administrative duties only. In other words, manage
- bugs with an unpriveleged user account, and manage users, groups,
- Products, etc. with the administrative account.
+ XXX is this still true? "usebuggroupsentry" has the capacity to
+ prevent the administrative user from directly altering bugs because of
+ conflicting group permissions. If you plan on using
+ "usebuggroupsentry", you should plan on restricting administrative
+ account usage to administrative duties only. In other words, manage
+ bugs with an unpriveleged user account, and manage users, groups,
+ Products, etc. with the administrative account.
2. In future, when you create a Product, a matching group will be
automatically created. If you need to add a Product Group to a
Product which was created before you turned on usebuggroups, then
simply create a new group, as outlined above, with the same name
as the Product.
- Warning
+ Warning
- Bugzilla currently has a limit of 64 groups per installation. If you
- have more than about 50 products, you should consider running multiple
- Bugzillas. Ask in the newsgroup for other suggestions for working
- around this restriction.
+ Bugzilla currently has a limit of 64 groups per installation. If you
+ have more than about 50 products, you should consider running multiple
+ Bugzillas. Ask in the newsgroup for other suggestions for working
+ around this restriction.
Note that group permissions are such that you need to be a member of
all the groups a bug is in, for whatever reason, to see that bug.
Warning
- 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.
+ 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.
Note
- 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.
+ 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.
- Warning
+ Warning
- 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.
+ 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.
+ 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.
+ 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.
1. Make sure you are running at least version 3.22.32 of MySQL as
earlier versions had notable security holes.
should consider disabling networking from within MySQL by adding
the following to your /etc/my.conf:
-[myslqd]
-# Prevent network access to MySQL.
-skip-networking
+ [myslqd]
+ # Prevent network access to MySQL.
+ skip-networking
5. You may also consider running MySQL, or even all of Bugzilla in a
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.
+ 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.
Note
- 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.
+ 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.
+ 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, processmail,
Tip
- Bugzilla ships with the ability to generate .htaccess files
- instructing Apache which files should and should not be accessible.
+ Bugzilla ships with the ability to generate .htaccess files
+ instructing Apache which files should and should not be accessible.
You should test to make sure that the files mentioned above are not
accessible from the Internet, especially your localconfig file which
we'd try to access http://bugzilla.mozilla.org/localconfig. You should
get a 403 Forbidden error.
- Caution
+ Caution
- Not following the instructions in this section, including testing, may
- result in sensitive information being globally accessible.
+ Not following the instructions in this section, including testing, may
+ result in sensitive information being globally accessible.
_________________________________________________________________
5.7. Template Customisation
-One of the large changes for 2.16 was the templatisation 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.
+ One of the large changes for 2.16 was the templatisation 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.
-Templatisation also makes localised versions of Bugzilla possible, for the
-first time. In the future, a Bugzilla installation may have templates
-installed for multiple localisations, and select which ones to use based on
-the user's browser language setting.
+ Templatisation also makes localised versions of Bugzilla possible, for
+ the first time. In the future, a Bugzilla installation may have
+ templates installed for multiple localisations, and select which ones
+ to use based on the user's browser language setting.
_________________________________________________________________
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 localisation. 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 customisations 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.
+ 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 localisation. 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 customisations 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.
Note
- Don't directly edit the compiled templates in data/template/* - your
- changes will be lost when Template Toolkit recompiles them.
+ Don't directly edit the compiled templates in data/template/* - your
+ changes will be lost when Template Toolkit recompiles them.
Note
- It is recommended that you run ./checksetup.pl after any template
- edits, especially if you've created a new file in the custom
- directory.
+ 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.
+ 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.
Note
- 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.
+ 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> .
+ 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 customising
-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 customise 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
-
+ There are a few templates you may be particularly interested in
+ customising 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 customise 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
5.8. Upgrading to New Releases
-Upgrading Bugzilla is something we all want to do from time to time, be it
-to get new features or pick up the latest security fix. How easy it is to
-update depends on a few factors.
+ Upgrading Bugzilla is something we all want to do from time to time,
+ be it to get new features or pick up the latest security fix. How easy
+ it is to update depends on a few factors.
* If the new version is a revision or a new point release
* How many, if any, local changes have been made
Tip
- If you can do this, updating using CVS is probably the most painless
- method, especially if you have a lot of local changes.
-bash$ cd /var/www/html/bugzilla
-bash$ cvs login
-Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot
-CVS password: anonymous
-bash$ cvs -q update -r BUGZILLA-2_16_2 -dP
-P checksetup.pl
-P collectstats.pl
-P globals.pl
-P docs/rel_notes.txt
-P template/en/default/list/quips.html.tmpl
+ If you can do this, updating using CVS is probably the most painless
+ method, especially if you have a lot of local changes.
+ bash$ cd /var/www/html/bugzilla
+ bash$ cvs login
+ Logging in to :pserver:anonymous@cvs-mirror.mozilla.org:2401/cvsroot
+ CVS password: anonymous
+ bash$ cvs -q update -r BUGZILLA-2_16_2 -dP
+ P checksetup.pl
+ P collectstats.pl
+ P globals.pl
+ P docs/rel_notes.txt
+ P template/en/default/list/quips.html.tmpl
Caution
- If a line in the output from cvs update begins with a C that
- represents a file with local changes that CVS was unable to properly
- merge. You need to resolve these conflicts manually before Bugzilla
- (or at least the portion using that file) will be usable.
+ If a line in the output from cvs update begins with a C that
+ represents a file with local changes that CVS was unable to properly
+ merge. You need to resolve these conflicts manually before Bugzilla
+ (or at least the portion using that file) will be usable.
Note
- You also need to run ./checksetup.pl before your Bugzilla upgrade will
- be complete.
+ You also need to run ./checksetup.pl before your Bugzilla upgrade will
+ be complete.
Example 5-2. Upgrading using the tarball
If you are unable or unwilling to use CVS, another option that's
always available is to download the latest tarball. This is the most
difficult option to use, especially if you have local changes.
-bash$ cd /var/www/html
-bash$ wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.2.tar.gz
-Output omitted
-bash$ tar xzvf bugzilla-2.16.2.tar.gz
-bugzilla-2.16.2/
-bugzilla-2.16.2/.cvsignore
-bugzilla-2.16.2/1x1.gif
-Output truncated
-bash$ cd bugzilla-2.16.2
-bash$ cp ../bugzilla/localconfig* .
-bash$ cp -r ../bugzilla/data .
-bash$ cd ..
-bash$ mv bugzilla bugzilla.old
-bash$ mv bugzilla-2.16.2 bugzilla
-bash$ cd bugzilla
-bash$ ./checksetup.pl
-Output omitted
+ bash$ cd /var/www/html
+ bash$ wget ftp://ftp.mozilla.org/pub/webtools/bugzilla-2.16.2.tar.gz
+ Output omitted
+ bash$ tar xzvf bugzilla-2.16.2.tar.gz
+ bugzilla-2.16.2/
+ bugzilla-2.16.2/.cvsignore
+ bugzilla-2.16.2/1x1.gif
+ Output truncated
+ bash$ cd bugzilla-2.16.2
+ bash$ cp ../bugzilla/localconfig* .
+ bash$ cp -r ../bugzilla/data .
+ bash$ cd ..
+ bash$ mv bugzilla bugzilla.old
+ bash$ mv bugzilla-2.16.2 bugzilla
+ bash$ cd bugzilla
+ bash$ ./checksetup.pl
+ Output omitted
Warning
- The cp commands both end with periods which is a very important
- detail, it tells the shell that the destination directory is the
- current working directory. Also, the period at the beginning of the
- ./checksetup.pl is important and can not be omitted.
+ The cp commands both end with periods which is a very important
+ detail, it tells the shell that the destination directory is the
+ current working directory. Also, the period at the beginning of the
+ ./checksetup.pl is important and can not be omitted.
Note
- You will now have to reapply any changes you have made to your local
- installation manually.
+ You will now have to reapply any changes you have made to your local
+ installation manually.
Example 5-3. Upgrading using patches
Caution
- If you do this, beware that this doesn't change the entires in your
- CVS directory so it may make updates using CVS (Example 5-1) more
- difficult in the future.
+ If you do this, beware that this doesn't change the entires in your
+ CVS directory so it may make updates using CVS (Example 5-1) more
+ difficult in the future.
_________________________________________________________________
5.9. Integrating Bugzilla with Third-Party Tools
5.9.1. Bonsai
-Bonsai is a web-based tool for managing CVS, the Concurrent Versioning
-System . Using Bonsai, administrators can control open/closed status of
-trees, query a fast relational database back-end for change, branch, and
-comment information, and view changes made since the last time the tree was
-closed. Bonsai also integrates with Tinderbox, the Mozilla automated build
-management system.
+ Bonsai is a web-based tool for managing CVS, the Concurrent Versioning
+ System . Using Bonsai, administrators can control open/closed status
+ of trees, query a fast relational database back-end for change,
+ branch, and comment information, and view changes made since the last
+ time the tree was closed. Bonsai also integrates with Tinderbox, the
+ Mozilla automated build management system.
_________________________________________________________________
5.9.2. CVS
-CVS integration is best accomplished, at this point, using the Bugzilla
-Email Gateway.
+ CVS integration is best accomplished, at this point, using the
+ Bugzilla Email Gateway.
-Follow the instructions in this Guide for enabling Bugzilla e-mail
-integration. Ensure that your check-in script sends an email to your
-Bugzilla e-mail gateway with the subject of "[Bug XXXX]", and you can have
-CVS check-in comments append to your Bugzilla bug. If you want to have the
-bug be closed automatically, you'll have to modify the
-contrib/bugzilla_email_append.pl script.
+ Follow the instructions in this Guide for enabling Bugzilla e-mail
+ integration. Ensure that your check-in script sends an email to your
+ Bugzilla e-mail gateway with the subject of "[Bug XXXX]", and you can
+ have CVS check-in comments append to your Bugzilla bug. If you want to
+ have the bug be closed automatically, you'll have to modify the
+ contrib/bugzilla_email_append.pl script.
-There is also a CVSZilla project, based upon somewhat dated Bugzilla code,
-to integrate CVS and Bugzilla through CVS' ability to email. Check it out
-at: http://homepages.kcbbs.gen.nz/~tonyg/.
+ There is also a CVSZilla project, based upon somewhat dated Bugzilla
+ code, to integrate CVS and Bugzilla through CVS' ability to email.
+ Check it out at: http://homepages.kcbbs.gen.nz/~tonyg/.
_________________________________________________________________
5.9.3. Perforce SCM
-You can find the project page for Bugzilla and Teamtrack Perforce
-integration (p4dti) at: http://www.ravenbrook.com/project/p4dti . "p4dti" is
-now an officially supported product from Perforce, and you can find the
-"Perforce Public Depot" p4dti page at
-http://public.perforce.com/public/perforce/p4dti/index.html .
-
-Integration of Perforce with Bugzilla, once patches are applied, is
-seamless. Perforce replication information will appear below the comments of
-each bug. Be certain you have a matching set of patches for the Bugzilla
-version you are installing. p4dti is designed to support multiple defect
-trackers, and maintains its own documentation for it. Please consult the
-pages linked above for further information.
+ You can find the project page for Bugzilla and Teamtrack Perforce
+ integration (p4dti) at: http://www.ravenbrook.com/project/p4dti .
+ "p4dti" is now an officially supported product from Perforce, and you
+ can find the "Perforce Public Depot" p4dti page at
+ http://public.perforce.com/public/perforce/p4dti/index.html .
+
+ Integration of Perforce with Bugzilla, once patches are applied, is
+ seamless. Perforce replication information will appear below the
+ comments of each bug. Be certain you have a matching set of patches
+ for the Bugzilla version you are installing. p4dti is designed to
+ support multiple defect trackers, and maintains its own documentation
+ for it. Please consult the pages linked above for further information.
_________________________________________________________________
5.9.4. Tinderbox/Tinderbox2
-We need Tinderbox integration information.
+ We need Tinderbox integration information.
_________________________________________________________________
Appendix A. The Bugzilla FAQ
-This FAQ includes questions not covered elsewhere in the Guide.
+ This FAQ includes questions not covered elsewhere in the Guide.
1. General Questions
A.1.1. Where can I find information about Bugzilla?
- A.1.2. What license is Bugzilla distributed under?
- A.1.3. How do I get commercial support for Bugzilla?
+ A.1.2. What license is Bugzilla distributed under?
+ A.1.3. How do I get commercial support for Bugzilla?
A.1.4. What major companies or projects are currently using
- Bugzilla for bug-tracking?
+ Bugzilla for bug-tracking?
- A.1.5. Who maintains Bugzilla?
+ A.1.5. Who maintains Bugzilla?
A.1.6. How does Bugzilla stack up against other bug-tracking
- databases?
+ databases?
A.1.7. Why doesn't Bugzilla offer this or that feature or
- compatibility with this other tracking software?
+ compatibility with this other tracking software?
A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on
- Oracle/Sybase/Msql/PostgreSQL/MSSQL.
+ Oracle/Sybase/Msql/PostgreSQL/MSSQL.
A.1.9. Why do the scripts say /usr/bonsaitools/bin/perl instead
- of /usr/bin/perl or something else?
+ of /usr/bin/perl or something else?
- A.1.10. Is there an easy way to change the Bugzilla cookie name?
+ A.1.10. Is there an easy way to change the Bugzilla cookie name?
2. Managerial Questions
A.2.1. Is Bugzilla web-based, or do you have to have specific
- software or a specific operating system on your machine?
+ software or a specific operating system on your machine?
- A.2.2. Can Bugzilla integrate with Perforce (SCM software)?
- A.2.3. Does Bugzilla allow the user to track multiple projects?
+ A.2.2. Can Bugzilla integrate with Perforce (SCM software)?
+ A.2.3. Does Bugzilla allow the user to track multiple projects?
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?
+ sort by project, severity etc?
A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs
- etc)? If yes, are there any that are NOT allowed?
+ etc)? If yes, are there any that are NOT allowed?
A.2.6. 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 the choice of
- acceptable values?
+ acceptable values?
A.2.7. Does Bugzilla provide any reporting features, metrics,
graphs, etc? You know, the type of stuff that management
- likes to see. :)
+ likes to see. :)
A.2.8. Is there email notification and if so, what do you see
- when you get an email?
+ when you get an email?
A.2.9. Can email notification be set up to send to multiple
- people, some on the To List, CC List, BCC List etc?
+ people, some on the To List, CC List, BCC List etc?
A.2.10. Do users have to have any particular type of email
- application?
+ application?
A.2.11. 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 imported into "matching"
fields? If I wanted to take the results of a query and
- export that data to MS Excel, could I do that?
+ export that data to MS Excel, could I do that?
A.2.12. Has anyone converted Bugzilla to another language to be
- used in other countries? Is it localizable?
+ used in other countries? Is it localizable?
A.2.13. Can a user create and save reports? Can they do this in
- Word format? Excel format?
+ Word format? Excel format?
A.2.14. Does Bugzilla have the ability to search by word, phrase,
- compound search?
+ compound search?
A.2.15. 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 or how are
- they notified?
+ they notified?
- A.2.16. Are there any backup features provided?
+ A.2.16. Are there any backup features provided?
A.2.17. Can users be on the system while a backup is in progress?
-
+
A.2.18. 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.
+ buying an "Out-of-the-Box" solution.
A.2.19. 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 install and a
couple of hours per week to maintain and customize or is
this a multi-week install process, plus a full time job
- for 1 person, 2 people, etc?
+ for 1 person, 2 people, etc?
A.2.20. Is there any licensing fee or other fees for using
Bugzilla? Any out-of-pocket cost other than the bodies
- needed as identified above?
+ needed as identified above?
3. Bugzilla Security
A.3.1. How do I completely disable MySQL security if it's giving
me problems (I've followed the instructions in the
- installation section of this guide)?
+ installation section of this guide)?
- A.3.2. Are there any security problems with Bugzilla?
+ A.3.2. Are there any security problems with Bugzilla?
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.
+ longer working correctly.
4. Bugzilla Email
A.4.1. I have a user who doesn't want to receive any more email
- from Bugzilla. How do I stop it entirely for this user?
+ from Bugzilla. How do I stop it entirely for this user?
A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send
- email to anyone but me. How do I do it?
+ email to anyone but me. How do I do it?
A.4.3. I want whineatnews.pl to whine at something more, or other
- than, only new bugs. How do I do it?
+ than, 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?
+ bug_email.pl. What alternatives do I have?
A.4.5. How do I set up the email interface to submit/change bugs
- via email?
+ via email?
A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's
- extremely slow. What gives?
+ extremely slow. What gives?
- A.4.7. How come email from Bugzilla changes never reaches me?
+ A.4.7. How come email from Bugzilla changes never reaches me?
5. Bugzilla Database
- A.5.1. I've heard Bugzilla can be used with Oracle?
+ A.5.1. I've heard Bugzilla can be used with Oracle?
A.5.2. I think my database might be corrupted, or contain invalid
- entries. What do I do?
+ entries. What do I do?
- A.5.3. I want to manually edit some entries in my database. How?
+ A.5.3. I want to manually edit some entries in my database. How?
A.5.4. I think I've set up MySQL permissions correctly, but
- Bugzilla still can't connect.
+ Bugzilla still can't connect.
A.5.5. How do I synchronize bug information among multiple
- different Bugzilla databases?
+ different Bugzilla databases?
6. Bugzilla and Win32
A.6.1. What is the easiest way to run Bugzilla on Win32
- (Win98+/NT/2K)?
+ (Win98+/NT/2K)?
- A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32?
+ A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32?
A.6.3. CGI's are failing with a "something.cgi is not a valid
- Windows NT application" error. Why?
+ Windows NT application" error. Why?
A.6.4. I'm having trouble with the perl modules for NT not being
- able to talk to to the database.
+ able to talk to to the database.
7. Bugzilla Usage
- A.7.1. How do I change my user name (email address) in Bugzilla?
+ A.7.1. How do I change my user name (email address) in Bugzilla?
A.7.2. The query page is very confusing. Isn't there a simpler
- way to query?
+ way to query?
A.7.3. I'm confused by the behavior of the "accept" button in the
Show Bug form. Why doesn't it assign the bug to me when I
- accept it?
+ accept it?
A.7.4. I can't upload anything into the database via the "Create
- Attachment" link. What am I doing wrong?
+ Attachment" link. What am I doing wrong?
A.7.5. How do I change a keyword in Bugzilla, once some bugs are
- using it?
+ using it?
A.7.6. Why can't I close bugs from the "Change Several Bugs at
- Once" page?
+ Once" page?
8. Bugzilla Hacking
- A.8.1. What bugs are in Bugzilla right now?
+ A.8.1. What bugs are in Bugzilla right now?
A.8.2. How can I change the default priority to a null value? For
instance, have the default priority be "---" instead of
- "P2"?
+ "P2"?
A.8.3. What's the best way to submit patches? What guidelines
- should I follow?
+ should I follow?
1. General Questions
Note
- This convention was abonded during the 2.17 development cycle so it
- will no longer be an issue when 2.18 comes out.
+ This convention was abonded during the 2.17 development cycle so it
+ will no longer be an issue when 2.18 comes out.
A.1.10. Is there an easy way to change the Bugzilla cookie name?
Note
- Questions likely to be asked by managers. :-)
+ Questions likely to be asked by managers. :-)
A.2.1. Is Bugzilla web-based, or do you have to have specific software
or a specific operating system on your machine?
Note
- There are only 55 groups available in version 2.16 of Bugzilla. If you
- are using product groups, this will also limit the number of products
- you can have. This limit does not exist in the current 2.17
- development releases and will not exist in 2.18.
+ There are only 55 groups available in version 2.16 of Bugzilla. If you
+ are using product groups, this will also limit the number of products
+ you can have. This limit does not exist in the current 2.17
+ development releases and will not exist in 2.18.
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,
Note
- Bugzilla's current development versions can do a lot more in the way
- of reporting. To see examples, check out
- http://bugzilla.mozilla.org/report.cgi.
+ Bugzilla's current development versions can do a lot more in the way
+ of reporting. To see examples, check out
+ http://bugzilla.mozilla.org/report.cgi.
A.2.8. Is there email notification and if so, what do you see when you
get an email?
Note
- If you decide to use the bugzilla_email integration features to allow
- Bugzilla to record responses to mail with the associated bug, you may
- need to caution your users to set their mailer to "respond to messages
- in the format in which they were sent". For security reasons Bugzilla
- ignores HTML tags in comments, and if a user sends HTML-based email
- into Bugzilla the resulting comment looks downright awful.
+ If you decide to use the bugzilla_email integration features to allow
+ Bugzilla to record responses to mail with the associated bug, you may
+ need to caution your users to set their mailer to "respond to messages
+ in the format in which they were sent". For security reasons Bugzilla
+ ignores HTML tags in comments, and if a user sends HTML-based email
+ into Bugzilla the resulting comment looks downright awful.
A.2.11. 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
Warning
- Running MySQL with this command line option is very insecure and
- should only be done when not connected to the external network as a
- troubleshooting step.
+ Running MySQL with this command line option is very insecure and
+ should only be done when not connected to the external network as a
+ troubleshooting step.
A.5.5. How do I synchronize bug information among multiple different
Bugzilla databases?
Note
- 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?
+ 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. Database Schema Chart
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!
+ 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, available at MySQL.com . Below are the basics you need to
-know about the Bugzilla database. Check the chart above for more details.
+ 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, available at MySQL.com . Below are the basics
+ you need to know about the Bugzilla database. Check the chart above
+ for more details.
1. To connect to your database:
bash# mysql -u root
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:
-
-+-------------------+
-| Tables in bugs |
-+-------------------+
-| attachments |
-| bugs |
-| bugs_activity |
-| cc |
-| components |
-| dependencies |
-| fielddefs |
-| groups |
-| keyworddefs |
-| keywords |
-| logincookies |
-| longdescs |
-| milestones |
-| namedqueries |
-| products |
-| profiles |
-| profiles_activity |
-| shadowlog |
-| tokens |
-| versions |
-| votes |
-| watch |
-+-------------------+
+ 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:
+ +-------------------+
+ | Tables in bugs |
+ +-------------------+
+ | attachments |
+ | bugs |
+ | bugs_activity |
+ | cc |
+ | components |
+ | dependencies |
+ | fielddefs |
+ | groups |
+ | keyworddefs |
+ | keywords |
+ | logincookies |
+ | longdescs |
+ | milestones |
+ | namedqueries |
+ | products |
+ | profiles |
+ | profiles_activity |
+ | shadowlog |
+ | tokens |
+ | versions |
+ | votes |
+ | watch |
+ +-------------------+
Here's an overview of what each table does. Most columns in each ta
ble have
Appendix C. Useful Patches and Utilities for Bugzilla
-Are you looking for a way to put your Bugzilla into overdrive? Catch some of
-the niftiest tricks here in this section.
+ 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 mod_rewrite 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.
+ 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.
1. 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>
+ <VirtualHost 12.34.56.78>
+ RewriteEngine On
+ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
+ </VirtualHost>
2. There are many, many more things you can do with mod_rewrite.
Please refer to the mod_rewrite documentation at
C.2. Command-line Bugzilla Queries
-There are a suite of Unix utilities for querying Bugzilla from the command
-line. They live in the contrib/cmdline directory. However, they have not yet
-been updated to work with 2.16 (post-templatisation.). There are three files
-- query.conf, buglist and bugs.
-
-query.conf contains the mapping from options to field names and comparison
-types. Quoted option names are "grepped" for, so it should be easy to edit
-this file. Comments (#) have no effect; you must make sure these lines do
-not contain any quoted "option".
-
-buglist is a shell script which submits a Bugzilla query and writes the
-resulting HTML page to stdout. It supports both short options, (such as
-"-Afoo" or "-Rbar") and long options (such as "--assignedto=foo" or
-"--reporter=bar"). If the first character of an option is not "-", it is
-treated as if it were prefixed with "--default=".
-
-The column list is taken from the COLUMNLIST environment variable. This is
-equivalent to the "Change Columns" option when you list bugs in buglist.cgi.
-If you have already used Bugzilla, grep for COLUMNLIST in your cookies file
-to see your current COLUMNLIST setting.
-
-bugs is a simple shell script which calls buglist and extracts the bug
-numbers from the output. Adding the prefix
-"http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list into a
-working link if any bugs are found. Counting bugs is easy. Pipe the results
-through sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'
-
-Akkana Peck says she has good results piping buglist output through w3m -T
-text/html -dump
+ There are a suite of Unix utilities for querying Bugzilla from the
+ command line. They live in the contrib/cmdline directory. However,
+ they have not yet been updated to work with 2.16
+ (post-templatisation.). There are three files - query.conf, buglist
+ and bugs.
+
+ query.conf contains the mapping from options to field names and
+ comparison types. Quoted option names are "grepped" for, so it should
+ be easy to edit this file. Comments (#) have no effect; you must make
+ sure these lines do not contain any quoted "option".
+
+ buglist is a shell script which submits a Bugzilla query and writes
+ the resulting HTML page to stdout. It supports both short options,
+ (such as "-Afoo" or "-Rbar") and long options (such as
+ "--assignedto=foo" or "--reporter=bar"). If the first character of an
+ option is not "-", it is treated as if it were prefixed with
+ "--default=".
+
+ The column list is taken from the COLUMNLIST environment variable.
+ This is equivalent to the "Change Columns" option when you list bugs
+ in buglist.cgi. If you have already used Bugzilla, grep for COLUMNLIST
+ in your cookies file to see your current COLUMNLIST setting.
+
+ bugs is a simple shell script which calls buglist and extracts the bug
+ numbers from the output. Adding the prefix
+ "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list
+ into a working link if any bugs are found. Counting bugs is easy. Pipe
+ the results through sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'
+
+ Akkana Peck says she has good results piping buglist output through
+ w3m -T text/html -dump
_________________________________________________________________
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
+ 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.
+ 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.
-URL: http://bugzilla.redhat.com/bugzilla/
+ URL: http://bugzilla.redhat.com/bugzilla/
-This section last updated 24 Dec 2002
+ This section last updated 24 Dec 2002
_________________________________________________________________
D.2. Loki Bugzilla (Fenris)
-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.
+ 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
+ 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.
+ 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
+ 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.
+ Scarab is a new open source bug-tracking system built using Java
+ Servlet technology. It is currently at version 1.0 beta 13.
-URL: http://scarab.tigris.org
+ URL: http://scarab.tigris.org
-This section last updated 18 Jan 2003
+ This section last updated 18 Jan 2003
_________________________________________________________________
D.5. Perforce SCM
-Although Perforce isn't really a bug tracker, it can be used as such through
-the "jobs" functionality.
+ Although Perforce isn't really a bug tracker, it can be used as such
+ through the "jobs" functionality.
-URL: http://www.perforce.com/perforce/technotes/note052.html
+ URL: http://www.perforce.com/perforce/technotes/note052.html
-This section last updated 27 Jul 2002
+ This section last updated 27 Jul 2002
_________________________________________________________________
D.6. SourceForge
-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.
+ 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.
-URL: http://www.sourceforge.net
+ URL: http://www.sourceforge.net
-This section last updated 27 Jul 2002
+ This section last updated 27 Jul 2002
_________________________________________________________________
Appendix E. GNU Free Documentation License
-Version 1.1, March 2000
+ Version 1.1, March 2000
Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place,
Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy
0. PREAMBLE
-The purpose of this License is to make a manual, textbook, or other written
-document "free" in the sense of freedom: to assure everyone the effective
-freedom to copy and redistribute it, with or without modifying it, either
-commercially or noncommercially. Secondarily, this License preserves for the
-author and publisher a way to get credit for their work, while not being
-considered responsible for modifications made by others.
-
-This License is a kind of "copyleft", which means that derivative works of
-the document must themselves be free in the same sense. It complements the
-GNU General Public License, which is a copyleft license designed for free
-software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free program
-should come with manuals providing the same freedoms that the software does.
-But this License is not limited to software manuals; it can be used for any
-textual work, regardless of subject matter or whether it is published as a
-printed book. We recommend this License principally for works whose purpose
-is instruction or reference.
+ The purpose of this License is to make a manual, textbook, or other
+ written document "free" in the sense of freedom: to assure everyone
+ the effective freedom to copy and redistribute it, with or without
+ modifying it, either commercially or noncommercially. Secondarily,
+ this License preserves for the author and publisher a way to get
+ credit for their work, while not being considered responsible for
+ modifications made by others.
+
+ This License is a kind of "copyleft", which means that derivative
+ works of the document must themselves be free in the same sense. It
+ complements the GNU General Public License, which is a copyleft
+ license designed for free software.
+
+ We have designed this License in order to use it for manuals for free
+ software, because free software needs free documentation: a free
+ program should come with manuals providing the same freedoms that the
+ software does. But this License is not limited to software manuals; it
+ can be used for any textual work, regardless of subject matter or
+ whether it is published as a printed book. We recommend this License
+ principally for works whose purpose is instruction or reference.
_________________________________________________________________
1. APPLICABILITY AND DEFINITIONS
-This License applies to any manual or other work that contains a notice
-placed by the copyright holder saying it can be distributed under the terms
-of this License. The "Document", below, refers to any such manual or work.
-Any member of the public is a licensee, and is addressed as "you".
-
-A "Modified Version" of the Document means any work containing the Document
-or a portion of it, either copied verbatim, or with modifications and/or
-translated into another language.
-
-A "Secondary Section" is a named appendix or a front-matter section of the
-Document that deals exclusively with the relationship of the publishers or
-authors of the Document to the Document's overall subject (or to related
-matters) and contains nothing that could fall directly within that overall
-subject. (For example, if the Document is in part a textbook of mathematics,
-a Secondary Section may not explain any mathematics.) The relationship could
-be a matter of historical connection with the subject or with related
-matters, or of legal, commercial, philosophical, ethical or political
-position regarding them.
-
-The "Invariant Sections" are certain Secondary Sections whose titles are
-designated, as being those of Invariant Sections, in the notice that says
-that the Document is released under this License.
-
-The "Cover Texts" are certain short passages of text that are listed, as
-Front-Cover Texts or Back-Cover Texts, in the notice that says that the
-Document is released under this License.
-
-A "Transparent" copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the general
-public, whose contents can be viewed and edited directly and
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or for
-automatic translation to a variety of formats suitable for input to text
-formatters. A copy made in an otherwise Transparent file format whose markup
-has been designed to thwart or discourage subsequent modification by readers
-is not Transparent. A copy that is not "Transparent" is called "Opaque".
-
-Examples of suitable formats for Transparent copies include plain ASCII
-without markup, Texinfo input format, LaTeX input format, SGML or XML using
-a publicly available DTD, and standard-conforming simple HTML designed for
-human modification. Opaque formats include PostScript, PDF, proprietary
-formats that can be read and edited only by proprietary word processors,
-SGML or XML for which the DTD and/or processing tools are not generally
-available, and the machine-generated HTML produced by some word processors
-for output purposes only.
-
-The "Title Page" means, for a printed book, the title page itself, plus such
-following pages as are needed to hold, legibly, the material this License
-requires to appear in the title page. For works in formats which do not have
-any title page as such, "Title Page" means the text near the most prominent
-appearance of the work's title, preceding the beginning of the body of the
-text.
+ This License applies to any manual or other work that contains a
+ notice placed by the copyright holder saying it can be distributed
+ under the terms of this License. The "Document", below, refers to any
+ such manual or work. Any member of the public is a licensee, and is
+ addressed as "you".
+
+ A "Modified Version" of the Document means any work containing the
+ Document or a portion of it, either copied verbatim, or with
+ modifications and/or translated into another language.
+
+ A "Secondary Section" is a named appendix or a front-matter section of
+ the Document that deals exclusively with the relationship of the
+ publishers or authors of the Document to the Document's overall
+ subject (or to related matters) and contains nothing that could fall
+ directly within that overall subject. (For example, if the Document is
+ in part a textbook of mathematics, a Secondary Section may not explain
+ any mathematics.) The relationship could be a matter of historical
+ connection with the subject or with related matters, or of legal,
+ commercial, philosophical, ethical or political position regarding
+ them.
+
+ The "Invariant Sections" are certain Secondary Sections whose titles
+ are designated, as being those of Invariant Sections, in the notice
+ that says that the Document is released under this License.
+
+ The "Cover Texts" are certain short passages of text that are listed,
+ as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+ the Document is released under this License.
+
+ A "Transparent" copy of the Document means a machine-readable copy,
+ represented in a format whose specification is available to the
+ general public, whose contents can be viewed and edited directly and
+ straightforwardly with generic text editors or (for images composed of
+ pixels) generic paint programs or (for drawings) some widely available
+ drawing editor, and that is suitable for input to text formatters or
+ for automatic translation to a variety of formats suitable for input
+ to text formatters. A copy made in an otherwise Transparent file
+ format whose markup has been designed to thwart or discourage
+ subsequent modification by readers is not Transparent. A copy that is
+ not "Transparent" is called "Opaque".
+
+ Examples of suitable formats for Transparent copies include plain
+ ASCII without markup, Texinfo input format, LaTeX input format, SGML
+ or XML using a publicly available DTD, and standard-conforming simple
+ HTML designed for human modification. Opaque formats include
+ PostScript, PDF, proprietary formats that can be read and edited only
+ by proprietary word processors, SGML or XML for which the DTD and/or
+ processing tools are not generally available, and the
+ machine-generated HTML produced by some word processors for output
+ purposes only.
+
+ The "Title Page" means, for a printed book, the title page itself,
+ plus such following pages as are needed to hold, legibly, the material
+ this License requires to appear in the title page. For works in
+ formats which do not have any title page as such, "Title Page" means
+ the text near the most prominent appearance of the work's title,
+ preceding the beginning of the body of the text.
_________________________________________________________________
2. VERBATIM COPYING
-You may copy and distribute the Document in any medium, either commercially
-or noncommercially, provided that this License, the copyright notices, and
-the license notice saying this License applies to the Document are
-reproduced in all copies, and that you add no other conditions whatsoever to
-those of this License. You may not use technical measures to obstruct or
-control the reading or further copying of the copies you make or distribute.
-However, you may accept compensation in exchange for copies. If you
-distribute a large enough number of copies you must also follow the
-conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and you
-may publicly display copies.
+ You may copy and distribute the Document in any medium, either
+ commercially or noncommercially, provided that this License, the
+ copyright notices, and the license notice saying this License applies
+ to the Document are reproduced in all copies, and that you add no
+ other conditions whatsoever to those of this License. You may not use
+ technical measures to obstruct or control the reading or further
+ copying of the copies you make or distribute. However, you may accept
+ compensation in exchange for copies. If you distribute a large enough
+ number of copies you must also follow the conditions in section 3.
+
+ You may also lend copies, under the same conditions stated above, and
+ you may publicly display copies.
_________________________________________________________________
3. COPYING IN QUANTITY
-If you publish printed copies of the Document numbering more than 100, and
-the Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover Texts:
-Front-Cover Texts on the front cover, and Back-Cover Texts on the back
-cover. Both covers must also clearly and legibly identify you as the
-publisher of these copies. The front cover must present the full title with
-all words of the title equally prominent and visible. You may add other
-material on the covers in addition. Copying with changes limited to the
-covers, as long as they preserve the title of the Document and satisfy these
-conditions, can be treated as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit legibly,
-you should put the first ones listed (as many as fit reasonably) on the
-actual cover, and continue the rest onto adjacent pages.
-
-If you publish or distribute Opaque copies of the Document numbering more
-than 100, you must either include a machine-readable Transparent copy along
-with each Opaque copy, or state in or with each Opaque copy a
-publicly-accessible computer-network location containing a complete
-Transparent copy of the Document, free of added material, which the general
-network-using public has access to download anonymously at no charge using
-public-standard network protocols. If you use the latter option, you must
-take reasonably prudent steps, when you begin distribution of Opaque copies
-in quantity, to ensure that this Transparent copy will remain thus
-accessible at the stated location until at least one year after the last
-time you distribute an Opaque copy (directly or through your agents or
-retailers) of that edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give them
-a chance to provide you with an updated version of the Document.
+ If you publish printed copies of the Document numbering more than 100,
+ and the Document's license notice requires Cover Texts, you must
+ enclose the copies in covers that carry, clearly and legibly, all
+ these Cover Texts: Front-Cover Texts on the front cover, and
+ Back-Cover Texts on the back cover. Both covers must also clearly and
+ legibly identify you as the publisher of these copies. The front cover
+ must present the full title with all words of the title equally
+ prominent and visible. You may add other material on the covers in
+ addition. Copying with changes limited to the covers, as long as they
+ preserve the title of the Document and satisfy these conditions, can
+ be treated as verbatim copying in other respects.
+
+ If the required texts for either cover are too voluminous to fit
+ legibly, you should put the first ones listed (as many as fit
+ reasonably) on the actual cover, and continue the rest onto adjacent
+ pages.
+
+ If you publish or distribute Opaque copies of the Document numbering
+ more than 100, you must either include a machine-readable Transparent
+ copy along with each Opaque copy, or state in or with each Opaque copy
+ a publicly-accessible computer-network location containing a complete
+ Transparent copy of the Document, free of added material, which the
+ general network-using public has access to download anonymously at no
+ charge using public-standard network protocols. If you use the latter
+ option, you must take reasonably prudent steps, when you begin
+ distribution of Opaque copies in quantity, to ensure that this
+ Transparent copy will remain thus accessible at the stated location
+ until at least one year after the last time you distribute an Opaque
+ copy (directly or through your agents or retailers) of that edition to
+ the public.
+
+ It is requested, but not required, that you contact the authors of the
+ Document well before redistributing any large number of copies, to
+ give them a chance to provide you with an updated version of the
+ Document.
_________________________________________________________________
4. MODIFICATIONS
-You may copy and distribute a Modified Version of the Document under the
-conditions of sections 2 and 3 above, provided that you release the Modified
-Version under precisely this License, with the Modified Version filling the
-role of the Document, thus licensing distribution and modification of the
-Modified Version to whoever possesses a copy of it. In addition, you must do
-these things in the Modified Version:
+ You may copy and distribute a Modified Version of the Document under
+ the conditions of sections 2 and 3 above, provided that you release
+ the Modified Version under precisely this License, with the Modified
+ Version filling the role of the Document, thus licensing distribution
+ and modification of the Modified Version to whoever possesses a copy
+ of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
5. COMBINING DOCUMENTS
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified versions,
-provided that you include in the combination all of the Invariant Sections
-of all of the original documents, unmodified, and list them all as Invariant
-Sections of your combined work in its license notice.
-
-The combined work need only contain one copy of this License, and multiple
-identical Invariant Sections may be replaced with a single copy. If there
-are multiple Invariant Sections with the same name but different contents,
-make the title of each such section unique by adding at the end of it, in
-parentheses, the name of the original author or publisher of that section if
-known, or else a unique number. Make the same adjustment to the section
-titles in the list of Invariant Sections in the license notice of the
-combined work.
-
-In the combination, you must combine any sections entitled "History" in the
-various original documents, forming one section entitled "History"; likewise
-combine any sections entitled "Acknowledgements", and any sections entitled
-"Dedications". You must delete all sections entitled "Endorsements."
+ You may combine the Document with other documents released under this
+ License, under the terms defined in section 4 above for modified
+ versions, provided that you include in the combination all of the
+ Invariant Sections of all of the original documents, unmodified, and
+ list them all as Invariant Sections of your combined work in its
+ license notice.
+
+ The combined work need only contain one copy of this License, and
+ multiple identical Invariant Sections may be replaced with a single
+ copy. If there are multiple Invariant Sections with the same name but
+ different contents, make the title of each such section unique by
+ adding at the end of it, in parentheses, the name of the original
+ author or publisher of that section if known, or else a unique number.
+ Make the same adjustment to the section titles in the list of
+ Invariant Sections in the license notice of the combined work.
+
+ In the combination, you must combine any sections entitled "History"
+ in the various original documents, forming one section entitled
+ "History"; likewise combine any sections entitled "Acknowledgements",
+ and any sections entitled "Dedications". You must delete all sections
+ entitled "Endorsements."
_________________________________________________________________
6. COLLECTIONS OF DOCUMENTS
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in the
-collection, provided that you follow the rules of this License for verbatim
-copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute it
-individually under this License, provided you insert a copy of this License
-into the extracted document, and follow this License in all other respects
-regarding verbatim copying of that document.
+ You may make a collection consisting of the Document and other
+ documents released under this License, and replace the individual
+ copies of this License in the various documents with a single copy
+ that is included in the collection, provided that you follow the rules
+ of this License for verbatim copying of each of the documents in all
+ other respects.
+
+ You may extract a single document from such a collection, and
+ distribute it individually under this License, provided you insert a
+ copy of this License into the extracted document, and follow this
+ License in all other respects regarding verbatim copying of that
+ document.
_________________________________________________________________
7. AGGREGATION WITH INDEPENDENT WORKS
-A compilation of the Document or its derivatives with other separate and
-independent documents or works, in or on a volume of a storage or
-distribution medium, does not as a whole count as a Modified Version of the
-Document, provided no compilation copyright is claimed for the compilation.
-Such a compilation is called an "aggregate", and this License does not apply
-to the other self-contained works thus compiled with the Document, on
-account of their being thus compiled, if they are not themselves derivative
-works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these copies of
-the Document, then if the Document is less than one quarter of the entire
-aggregate, the Document's Cover Texts may be placed on covers that surround
-only the Document within the aggregate. Otherwise they must appear on covers
-around the whole aggregate.
+ A compilation of the Document or its derivatives with other separate
+ and independent documents or works, in or on a volume of a storage or
+ distribution medium, does not as a whole count as a Modified Version
+ of the Document, provided no compilation copyright is claimed for the
+ compilation. Such a compilation is called an "aggregate", and this
+ License does not apply to the other self-contained works thus compiled
+ with the Document, on account of their being thus compiled, if they
+ are not themselves derivative works of the Document.
+
+ If the Cover Text requirement of section 3 is applicable to these
+ copies of the Document, then if the Document is less than one quarter
+ of the entire aggregate, the Document's Cover Texts may be placed on
+ covers that surround only the Document within the aggregate. Otherwise
+ they must appear on covers around the whole aggregate.
_________________________________________________________________
8. TRANSLATION
-Translation is considered a kind of modification, so you may distribute
-translations of the Document under the terms of section 4. Replacing
-Invariant Sections with translations requires special permission from their
-copyright holders, but you may include translations of some or all Invariant
-Sections in addition to the original versions of these Invariant Sections.
-You may include a translation of this License provided that you also include
-the original English version of this License. In case of a disagreement
-between the translation and the original English version of this License,
-the original English version will prevail.
+ Translation is considered a kind of modification, so you may
+ distribute translations of the Document under the terms of section 4.
+ Replacing Invariant Sections with translations requires special
+ permission from their copyright holders, but you may include
+ translations of some or all Invariant Sections in addition to the
+ original versions of these Invariant Sections. You may include a
+ translation of this License provided that you also include the
+ original English version of this License. In case of a disagreement
+ between the translation and the original English version of this
+ License, the original English version will prevail.
_________________________________________________________________
9. TERMINATION
-You may not copy, modify, sublicense, or distribute the Document except as
-expressly provided for under this License. Any other attempt to copy,
-modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However, parties who
-have received copies, or rights, from you under this License will not have
-their licenses terminated so long as such parties remain in full compliance.
+ You may not copy, modify, sublicense, or distribute the Document
+ except as expressly provided for under this License. Any other attempt
+ to copy, modify, sublicense or distribute the Document is void, and
+ will automatically terminate your rights under this License. However,
+ parties who have received copies, or rights, from you under this
+ License will not have their licenses terminated so long as such
+ parties remain in full compliance.
_________________________________________________________________
10. FUTURE REVISIONS OF THIS LICENSE
-The Free Software Foundation may publish new, revised versions of the GNU
-Free Documentation License from time to time. Such new versions will be
-similar in spirit to the present version, but may differ in detail to
-address new problems or concerns. See http://www.gnu.org/copyleft/ .
-
-Each version of the License is given a distinguishing version number. If the
-Document specifies that a particular numbered version of this License "or
-any later version" applies to it, you have the option of following the terms
-and conditions either of that specified version or of any later version that
-has been published (not as a draft) by the Free Software Foundation. If the
-Document does not specify a version number of this License, you may choose
-any version ever published (not as a draft) by the Free Software Foundation.
+ The Free Software Foundation may publish new, revised versions of the
+ GNU Free Documentation License from time to time. Such new versions
+ will be similar in spirit to the present version, but may differ in
+ detail to address new problems or concerns. See
+ http://www.gnu.org/copyleft/ .
+
+ Each version of the License is given a distinguishing version number.
+ If the Document specifies that a particular numbered version of this
+ License "or any later version" applies to it, you have the option of
+ following the terms and conditions either of that specified version or
+ of any later version that has been published (not as a draft) by the
+ Free Software Foundation. If the Document does not specify a version
+ number of this License, you may choose any version ever published (not
+ as a draft) by the Free Software Foundation.
_________________________________________________________________
How to use this License for your documents
-To use this License in a document you have written, include a copy of the
-License in the document and put the following copyright and license notices
-just after the title page:
+ To use this License in a document you have written, include a copy of
+ the License in the document and put the following copyright and
+ license notices just after the title page:
Copyright (c) YEAR YOUR NAME. Permission is granted to copy,
distribute and/or modify this document under the terms of the GNU
creating a Product with no Components will create an error in
Bugzilla).
- CPAN
+ CPAN
CPAN stands for the "Comprehensive Perl Archive Network". CPAN
maintains a large number of extremely useful Perl modules -
encapsulated chunks of code for performing a particular task.
S
- SGML
+ SGML
SGML stands for "Standard Generalized Markup Language". Created
in the 1980's to provide an extensible means to maintain
documentation based upon content instead of presentation, SGML
- I've been asked to explain this ... way back when, when Netscape
- released version 4.0 of its browser, we had a release party.
- Naturally, there had been a big push to try and fix every known bug
- before the release. Naturally, that hadn't actually happened. (This is
- not unique to Netscape or to 4.0; the same thing has happened with
- every software project I've ever seen.) Anyway, at the release party,
- T-shirts were handed out that said something like "Netscape 4.0: Zarro
- Boogs". Just like the software, the T-shirt had no known bugs. Uh-huh.
- So, when you query for a list of bugs, and it gets no results, you can
- think of this as a friendly reminder. Of *course* there are bugs
- matching your query, they just aren't in the bugsystem yet...
+ I've been asked to explain this ... way back when, when Netscape
+ released version 4.0 of its browser, we had a release party.
+ Naturally, there had been a big push to try and fix every known bug
+ before the release. Naturally, that hadn't actually happened. (This is
+ not unique to Netscape or to 4.0; the same thing has happened with
+ every software project I've ever seen.) Anyway, at the release party,
+ T-shirts were handed out that said something like "Netscape 4.0: Zarro
+ Boogs". Just like the software, the T-shirt had no known bugs. Uh-huh.
+ So, when you query for a list of bugs, and it gets no results, you can
+ think of this as a friendly reminder. Of *course* there are bugs
+ matching your query, they just aren't in the bugsystem yet...
- --Terry Weissman
+ --Terry Weissman
projects / thirdparty / bugzilla.git / commitdiff
