From a1ca8312b79dbd4dea3ed9e56d583fa858f1b58a Mon Sep 17 00:00:00 2001
From: "gerv%gerv.net" 2004-01-15The Bugzilla Team
This document is copyright (c) 2000-2004 by the various + Bugzilla contributors who wrote it.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation @@ -522,29 +478,10 @@ VALIGN="TOP" Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in Appendix CAppendix D. | ||
| --Copyright (c) 2000-2004 The Bugzilla Team |
If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, @@ -578,10 +515,10 @@ NAME="disclaimer"
Although the Bugzilla development team has taken great care to - ensure that all exploitable bugs or options have been - fixed, security holes surely exist. Great care should be taken both in + ensure that all exploitable bugs have been fixed, security holes surely + exist in any piece of code. Great care should be taken both in the installation and usage of this software. The Bugzilla development - team members assume no liability for your use of this software. You have + team members assume no liability for your use of Bugzilla. You have the source code, and are responsible for auditing it yourself to ensure your security needs are met.
1.3. New VersionsThis is the 2.17.5 version of The Bugzilla Guide. It is so named +> This is the 2.17.7 version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. This version of the guide, like its associated Bugzilla version, is a @@ -607,8 +544,8 @@ NAME="newversions" HREF="http://www.bugzilla.org" TARGET="_top" >http://www.bugzilla.org, or checked out via CVS. - (Please follow the , or checked out via CVS by + following the Mozilla @@ -618,12 +555,68 @@ TARGET="_top" CLASS="filename" >mozilla/webtools/bugzilla/docs/ - subtree.) However, you should read the version + subtree. However, you should read the version which came with the Bugzilla release you are using.
The Bugzilla Guide is currently only available in English. - If you would like to volunteer to translate it, please contact +> The Bugzilla Guide, or a section of it, is also available in + the following languages: + German. +
+ In addition, there are Bugzilla template localisation projects in + the following languages. They may have translated documentation + available: + Belarusian, + Brazilian Portuguese, + Chinese, + French, + German, + Korean, + Russian and + Spanish. +
+ If you would like to volunteer to translate the Guide into additional + languages, please contact Matthew P. Barnson, Kevin Brannen, Dawn Endico, Ben FrantzDale, Eric Hanson, Tara Hernandez, Dave Lawrence, Zach Lipton, Gervase Markham, Andrew Pearson, Joe Robins, Spencer Smith, Jacob Steenhagen, Ron Teitelbaum, Terry Weissman, Martin Wulffeld.
Last but not least, all the members of the
+>
Also, thanks are due to the members of the
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 products.
- Do we need more here? Those who do not use a bug-tracking system tend to rely on
- shared lists, email, spreadsheets and/or Post-It notes to monitor the
- status of defects. This procedure
- is usually error-prone and tends to cause those bugs judged least
- significant by developers to be dropped or ignored. Integrated defect-tracking systems make sure that nothing gets
- swept under the carpet; they provide a method of creating, storing,
- arranging and processing defect reports and enhancement requests. Bugzilla is the leading open-source/free software bug tracking
- system. It boasts many advanced features, including:
- Powerful searching User-configurable email notifications of bug changes Full change history Inter-bug dependency tracking and graphing Excellent attachment management Integrated, product-based, granular security schema Fully security-audited, and runs under Perl's taint mode A robust, stable RDBMS back-end Completely customisable and/or localisable web user
- interface Additional XML, email and console interfaces Extensive configurability Smooth upgrade pathway between versions 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 configuration management solution. 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 runs an up-to-the-minute version,
- so some things may not quite work as this document describes. If you want to use Bugzilla, first you need to create an account.
- Consult with the administrator responsible for your installation of
- Bugzilla for the URL you should use to access it. If you're
- test-driving Bugzilla, use this URL:
- http://landfill.bugzilla.org/bugzilla-tip/.
- Click the
- "Open a new Bugzilla account"
-
- link, enter your email address and, optionally, your name in the
- spaces provided, then click
- "Create Account"
-
- . Within moments, you should receive an email to the address
- you provided, which contains your login name (generally the
- same as the email address), and a password.
- This password is randomly generated, but can be
- changed to something more memorable. Click the
- "Log In"
- link in the footer at the bottom of the page in your browser,
- enter your email address and password into the spaces provided, and
- click
- "Login".
- You are now logged in. Bugzilla uses cookies to remember you are
- logged in so, unless you have cookies disabled or your IP address changes,
- you should not have to log in again. The core of Bugzilla is the screen which displays a particular
- bug. It's a good place to explain some Bugzilla concepts.
-
Bug 1 on Landfill
-
- is a good example. Note that the labels for most fields are hyperlinks;
- clicking them will take you to context-sensitive help on that
- particular field. Fields marked * may not be present on every
- installation of Bugzilla.
Product and Component:
- Bugs are divided up by Product and Component, with a Product
- having one or more Components in it. For example,
- bugzilla.mozilla.org's "Bugzilla" Product is composed of several
- Components:
-
Status and Resolution:
-
- These define exactly what state the bug is in - from not even
- being confirmed as a bug, through to being fixed and the fix
- confirmed by Quality Assurance. The different possible values for
- Status and Resolution on your installation should be documented in the
- context-sensitive help for those items.
Assigned To:
- The person responsible for fixing the bug.
*URL:
- A URL associated with the bug, if any.
Summary:
- A one-sentence summary of the problem.
*Status Whiteboard:
- (a.k.a. Whiteboard) A free-form text area for adding short notes
- and tags to a bug.
*Keywords:
- The administrator can define keywords which you can use to tag and
- categorise bugs - e.g. The Mozilla Project has keywords like crash
- and regression.
Platform and OS:
- These indicate the computing environment where the bug was
- found.
Version:
- The "Version" field is usually used for versions of a product which
- have been released, and is set to indicate which versions of a
- Component have the particular problem the bug report is
- about.
Priority:
- The bug assignee uses this field to prioritise his or her bugs.
- It's a good idea not to change this on other people's bugs.
Severity:
- This indicates how severe the problem is - from blocker
- ("application unusable") to trivial ("minor cosmetic issue"). You
- can also use this field to indicate whether a bug is an enhancement
- request.
*Target:
- (a.k.a. Target Milestone) A future version by which the bug is to
- be fixed. e.g. The Bugzilla Project's milestones for future
- Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
- restricted to numbers, thought - you can use any text strings, such
- as dates.
Reporter:
- The person who filed the bug.
CC list:
- A list of people who get mail when the bug changes.
Attachments:
- You can attach files (e.g. testcases or patches) to bugs. If there
- are any attachments, they are listed in this section.
*Dependencies:
- If this bug cannot be fixed unless other bugs are fixed (depends
- on), or this bug stops other bugs being fixed (blocks), their
- numbers are recorded here.
*Votes:
- Whether this bug has any votes.
Additional Comments:
- You can add your two cents to the bug discussion here, if you have
- something worthwhile to say. The Bugzilla Search page is is the interface where you can find
- any bug report, comment, or patch currently in the Bugzilla system. You
- can play with it here:
- http://landfill.bugzilla.org/bugzilla-tip/query.cgi. The Search page has controls for selecting different possible
- values for all of the fields in a bug, as described above. For some
- fields, multiple values can be selected. In those cases, Bugzilla
- returns bugs where the content of the field matches any one of the selected
- values. If none is selected, then the field can take any value. Once you've run a search, you can save it as a Saved Search, which
- appears in the page footer. Highly advanced querying is done using Boolean Charts. See the
- Boolean Charts help link on the Search page for more information. If you run a search, a list of matching bugs will be returned.
- 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:
- 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: Go to
-
Landfill
- in your browser and click
-
Enter a new bug report.
- Select a product - any one will do. Fill in the fields. Bugzilla should have made reasonable
- guesses, based upon your browser, for the "Platform" and "OS"
- drop-down boxes. If they are wrong, change them. Select "Commit" and send in your bug report. 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.
- 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.
- Viewing and reviewing patches in Bugzilla is often difficult due to
- lack of context, improper format and the inherent readability issues that
- raw patches present. Patch Viewer is an enhancement to Bugzilla designed
- to fix that by offering increased context, linking to sections, and
- integrating with Bonsai, LXR and CVS. Patch viewer allows you to: The main way to view a patch in patch viewer is to click on the
- "Diff" link next to a patch in the Attachments list on a bug. You may
- also do this within the edit window by clicking the "View Attachment As
- Diff" button in the Edit Attachment screen. To see the difference between two patches, you must first view the
- newer patch in Patch Viewer. Then select the older patch from the
- dropdown at the top of the page ("Differences between [dropdown] and
- this patch") and click the "Diff" button. This will show you what
- is new or changed in the newer patch. To get more context in a patch, you put a number in the textbox at
- the top of Patch Viewer ("Patch / File / [textbox]") and hit enter.
- This will give you that many lines of context before and after each
- change. Alternatively, you can click on the "File" link there and it
- will show each change in the full context of the file. This feature only
- works against files that were diffed using "cvs diff". To view only a certain set of files in a patch (for example, if a
- patch is absolutely huge and you want to only review part of it at a
- time), you can click the "(+)" and "(-)" links next to each file (to
- expand it or collapse it). If you want to collapse all files or expand
- all files, you can click the "Collapse All" and "Expand All" links at the
- top of the page. To link to a section of a patch (for example, if you want to be
- able to give someone a URL to show them which part you are talking
- about) you simply click the "Link Here" link on the section header. The
- resulting URL can be copied and used in discussion. (Copy Link
- Location in Mozilla works as well.) To go to Bonsai to get blame for the lines you are interested in,
- you can click the "Lines XX-YY" link on the section header you are
- interested in. This works even if the patch is against an old
- version of the file, since Bonsai stores all versions of the file. To go to LXR, you click on the filename on the file header
- (unfortunately, since LXR only does the most recent version, line
- numbers are likely to rot). This section distills some Bugzilla tips and best practices
- that have been developed. Bugzilla comments are plain text - so typing <U> will
- produce less-than, U, greater-than rather than underlined text.
- However, Bugzilla will automatically make hyperlinks out of certain
- sorts of text in comments. For example, the text
- "http://www.bugzilla.org" will be turned into a link:
- http://www.bugzilla.org.
- Other strings which get linkified in the obvious manner are:
- 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 convenience of others.
- 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. 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,
- if you do it out of habit, but full mail/news-style
- four line ASCII art creations are not.
-
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.
- 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.
- 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 three tabs: 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 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.
-
You can also do further filtering on the client side by
- using the X-Bugzilla-Reason mail header which Bugzilla
- adds to all bugmail. This tells you what relationship you have to the
- bug in question,
- and can be any of Owner, Reporter, QAcontact, CClist, Voter and
- WatchingComponent. By entering user email names, delineated by commas, into the
- "Users to watch" text entry box you can receive a copy of all the
- bugmail of other users (security settings permitting.) This powerful
- functionality enables seamless transitions as developers change
- projects or users go on holiday. The ability to watch other users may not be available in all
- Bugzilla installations. If you can't see it, ask your
- administrator. Bugzilla has been successfully installed under many different
- operating systems including almost all Unix clones and
- Microsoft Windows. Many
- operating systems have utilities that make installation easier or quirks
- that make it harder. We have tried to collect that information in
- Section 4.4, so unless you are on Linux,
- be sure to check out that section before
- you start your installation.
- Windows is one of those operating systems that has many quirks
- and is not yet officially supported by the Bugzilla team. If you wish
- to install Bugzilla on Windows, be sure to see
- Section 4.4.1.
- The Bugzilla server software is usually installed on Linux or
+ Solaris.
+ If you are installing on another OS, check Section 2.4
+ before you start your installation to see if there are any special
+ instructions.
+
As an alternative to following these instructions, you may wish to
+ try Arne Schirmacher's unofficial and unsupported
+ Bugzilla
+ Installer, which installs Bugzilla and all its prerequisites
+ on Linux or Solaris systems.
+ This guide assumes that you have administrative access to the
+ Bugzilla machine. It not possible to
+ install and run Bugzilla itself without administrative access except
+ in the very unlikely event that every single prerequisite is
+ already installed.
+ While installing Bugzilla, it is a good idea to ensure that there
- is some kind of configurable firewall between you and the rest of the
- Internet
- as 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. This guide assumes that you already have your operating system
- installed, network configured, and have administrative access to the
- machine onto which you are installing Bugzilla. It is possible to
- install and run Bugzilla itself without administrative access, but you
- have to
- either make sure all the required software is installed or get somebody
- with administrative access to install it for you.
-
You are strongly recommended to make a backup of your system
- before installing Bugzilla (and at regular intervals thereafter :-).
- Here's a basic step-by-step list:
- Install MySQL
- (3.23.41 or above)
- Install a Webserver
- Put Bugzilla in the WebspaceInstall Bugzilla
- Install Perl ModulesInstall Perl modules
- Installed Version Test: perl -v Any machine that doesn't have Perl on it is a sad machine indeed.
- If your OS doesn't come with it, Perl can be got in source form
- from http://www.perl.com.
- There are also binary versions available for many platforms, most of which
- are linked to from perl.com.
- Although Bugzilla runs with perl 5.6.0,
- it's a good idea to be up to the very latest version
- if you can when running Bugzilla. As of this writing, that is Perl
- version 5.8.2. If your OS doesn't come with it or provide official packages,
- visit the MySQL homepage at
- Installed Version Test: mysql -V
If you don't have it and your OS doesn't provide official packages,
+ visit http://www.mysql.com
- to grab and install the latest stable release of the server.
+>. You need MySQL version
+ 3.23.41 or higher.
If you install from something other than a packaging/installation
- system (such as .rpm, .dep, .exe, or .msi) you will need to configure
- your system so the MySQL server daemon will come back up whenever
- your machine reboots.
+ system (such as .rpm, .dep, .exe, or .msi) make sure the MySQL server
+ is started when the machine boots.
If you wish to have attachments larger than 64K, you will have to
- configure MySQL to accept large packets. This is done by adding the text
- in Figure 4-1 to your
- my.conf file. There is also a parameter in Bugzilla
- for setting the maximum allowable attachment size.
-
- You should set this value to be slightly larger than that parameter.
- Figure 4-1. Set Max Packet Size in MySQL If you are running Bugzilla and MySQL on the same machine, you may
- also wish to utilize the --skip-networking option as
- mentioned in Section 4.5.2 for the added security.
- This first thing you'll want to do is make sure you've given the
- "root" user a password as suggested in
- Section 4.5.2. Then, you need to add a user for
- Bugzilla to use. For clarity, these instructions will
- assume that your MySQL user for Bugzilla will be "bugs_user",
- the database will be called "bugs_db" and the password for
- the "bugs_user" user is "bugs_password". You
- should, of course, substitute the values you intend to use for your site.
- Most people use "bugs" for both the user and
- database name. Don't use it for the password, though...
- We use an SQL GRANT command to create a
- "bugs_user"
- user. This also restricts the
- "bugs_user"
- user to operations within a database called
- "bugs_db", and only allows the account to connect from
- "localhost".
- Modify it to reflect your setup if you will be connecting from
- another machine or as a different user. If you are using MySQL 4, the bugs user also needs to be granted
- the LOCK TABLES and
- CREATE TEMPORARY TABLES permissions,
- so add them to the list in the
- GRANT command.
- Installed Version Test: view the default welcome page at
+ http://<your-machine>/ You have freedom of choice here, pretty much any web server that
is capable of running CGI
- scripts will work. Section 4.2 has more information about
- configuring web servers to work with Bugzilla.
- We strongly recommend Apache as the web server to use. The
- Bugzilla Guide installation instructions, in general, assume you are
- using Apache. If you have got Bugzilla working using another webserver,
+ scripts will work.
+ However, we strongly recommend using the Apache web server
+ (either 1.3.x or 2.x), and
+ the installation instructions usually assume you are
+ using it. If you have got Bugzilla working using another webserver,
please share your experiences with us by filing a bug in Bugzilla Documentation.
-
If you don't have Apache and your OS doesn't provide official packages,
+ visit http://httpd.apache.org/.
+ You should untar the Bugzilla files into a directory that you're
- willing to make writable by the default web server user (probably
-
Download a Bugzilla tarball (or check it out from CVS) and place
+ it in a suitable directory, writable by the default web server user
+ (probably "nobody").
- You may decide to put the files in the main web space for your
- web server or perhaps in
- /usr/local
- with a symbolic link in the web space that points to the Bugzilla
- directory. If you symlink the bugzilla directory into your Apache's
- html
- hierarchy, you may receive
- Forbidden
- errors unless you add the
- FollowSymLinks
- directive to the <Directory> entry for
- the HTML root directory in httpd.conf. cgi-bin directory (this
+> directory. This
includes any directory which is configured using the
ScriptAlias directive of Apache).
+> directive of Apache.
Once all the files are in a web accessible directory, make that
directory writable by your webserver's user. This is a temporary step
- until you run the post-install
+ until you run the
checksetup.pl Next, run the magic checksetup.pl script.
- This is designed to check whether you have all of the right
- Perl modules in the correct
- versions, and that Bugzilla is generally set up correctly.
-
Eventually,
- it will make sure Bugzilla files and directories have reasonable
- permissions, set up the
- data
- directory, and create all the MySQL tables. But the first time you
- run it, it's highly likely to tell you that you are missing a few
- Perl modules. Make a note of which ones they are, and then proceed to
- the next section to install them.
-
The first time you run it with all the correct modules installed,
- it will create a file called
- localconfig. This file contains a variety of settings you may need to tweak
- including how Bugzilla should connect to the MySQL database. The connection settings include:
- server's host: just use
- "localhost"
- if the MySQL server is local database name:
- "bugs_db"
- if you're following these directions MySQL username:
- "bugs_user"
- if you're following these directions Password for the
- "bugs_user"
- MySQL account; ("bugs_password" above) Edit the file to change these. Once you are happy with the
- settings, su to the user
- your web server runs as, and re-run
- checksetup.pl. (Note: on some security-conscious
- systems, you may need to change the login shell for the webserver
- account before you can do this.)
- On this second run, it will create the database and an administrator
- account for which you will be prompted to provide information. 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. Don't be intimidated by this long list of modules. See
- Section 4.1.6.1 for a way of
- installing all the ones you need with a single command.
+>Bugzilla's installation process is based
+ on a script called checksetup.pl.
+ The first thing it checks is whether you have appropriate
+ versions of all the required
+ Perl modules. The aim of this section is to pass this check.
+ When it passes,
+ do not run it again,
+ but proceed to Section 2.2.
Perl modules can be found using
- CPAN on Unix based systems or
- PPM on Win32.
+>
At this point, you need to su to root. You should
+ remain as root until the end of the install. Then run:
+
checksetup.pl will print out a list of the
+ required and optional Perl modules, together with the versions
+ (if any) installed on your machine.
+ The list of required modules is reasonably long; however, you
+ may already have several of them installed.
Good instuctions can be found for using each of these services on
- their respective websites. The basics can be found in
- Example 4-1 for CPAN and
-
There is a meta-module called Bundle::Bugzilla,
+ which installs all the other
+ modules with a single command. You should use this if you are running
+ Perl 5.6.1 or above.
+
The preferred way of installing Perl modules is via CPAN on Unix,
+ or PPM on Windows (see Section 4.4.1.2 for PPM.
+>Section 2.4.1.2). These
+ instructions assume you are using CPAN; if for some reason you need
+ to install the Perl modules manually, see
+ Appendix C.
Example 4-1. Installing perl modules with CPAN The easy way:
- Perl Modules (minimum version):
+>
Here is a complete list of modules and their minimum versions.
+ Some modules have special installation notes, which follow.
+ Required Perl modules:
Bundle::Bugzilla
- (Will allow you to skip the rest)
+>
AppConfig (1.52)
CGI
- (2.88)
+>
CGI (2.93)
Date::Format
- (2.21)
+>
Data::Dumper (any)
DBI
- (1.32)
+>
Date::Format (2.21)
+
DBI (1.32)
File::Spec
- (0.82)
+>
File::Spec (0.82)
File::Temp
- (any)
+>
File::Temp (any)
Template ToolkitTemplate
(2.08)
Text::Wrap
- (2001.0131)
+>
Text::Wrap (2001.0131)
XML::Parser
- (any) for the XML interface
-
GD::Graph
@@ -3307,10 +1615,10 @@ HREF="#install-modules-gd-text-align"
>
MIME::ParserXML::Parser
- (any) for the email interface
+ (any) for the XML interface
MIME::Parser
+ (any) for the optional email interface
+ If you are running at least perl 5.6.1, you can save yourself a lot
- of time by using Bundle::Bugzilla. This bundle contains every module
- required to get Bugzilla running. It does not include GD and friends, but
- these are not required for a base install and can always be added later
- if the need arises.
- Assuming your perl was installed with CPAN (most unix installations
- are), using Bundle::Bugzilla is really easy. Simply follow along with the
- commands below.
- The CGI module parses form elements and cookies and does many
- other usefule things. It come as a part of recent perl distributions, but
- Bugzilla needs a fairly new version.
- 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.
- 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 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.
- File::Spec is a perl module that allows file operations, such as
- generating full path names, to work cross platform.
- File::Temp is used to generate a temporary filename that is
- guaranteed to be unique. It comes as a standard part of perl
- 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.
- Text::Wrap is designed to proved intelligent text wrapping.
- You need the GD library if you want any of the graphing to work.
- The Perl GD library requires some other libraries that may or
- may not be installed on your system, including
- The Perl GD module 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 version of the GD perl module you need is very closely tied
- to the The version of the GD module you need is very closely tied
+ to the libgd version installed on your system.
- If you have a version 1.x of libgd the 2.x
- versions of the GD perl module won't work for you.
- 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. XML::Parser is used by the importxml.pl
- script. You only need it if you are going to be importing bugs (such as
- for bug moving). XML::Parser requires that the
- expat library is already installed on your machine.
- In addition to GD listed above, the reporting interface of Bugzilla
- needs to have the GD::Graph module installed.
- GD::Text::Align, as the name implies, is used to draw aligned
- strings of text. It is needed by the reporting interface.
- MIME::Parser is only needed if you want to use the e-mail interface
- located in the The MIME::Parser module is only required if you want to use the
+ email interface
+ located in the contrib directory.
- PatchReader is only needed if you want to use Patch Viewer, a
- Bugzilla feature to format patches in a pretty HTML fashion. There are a
- number of optional parameters you can configure Patch Viewer with as well,
- including cvsroot, cvsroot_get, lxr_root, bonsai_url, lxr_url, and
- lxr_root. Patch Viewer also optionally will use cvs, diff and interdiff
- utilities if they exist on the system (interdiff can be found in the
- patchutils package at http://cyberelk.net/tim/patchutils/.
- These programs' locations can be configured in localconfig.
-
Once checksetup.pl has run successfully, Bugzilla should start up.
- Proceed to the correct URL and log in with the administrator account
- you defined in the last checksetup.pl run.
-
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.
- The Bugzilla Team recommends Apache when using Bugzilla, however, any web server
- that can be configured to run CGI scripts
- should be able to handle Bugzilla. No matter what web server you choose, but
- especially if you choose something other than Apache, you should be sure to read
- Section 4.5.4.
- The plan for this section is to eventually document the specifics of how to lock
- down permissions on individual web servers.
- You will have to make sure that Apache is properly
- configured to run the Bugzilla CGI scripts. You also need to make sure
- that the
Once you run .htaccess files created by
- ./checksetup.pl are allowed to override Apache's normal access
- permissions or else important password information may be exposed to the
- Internet.
+>checksetup.pl with all the correct
+ modules installed, it displays a message about, and write out a
+ file called,
+ localconfig. This file contains the default
+ settings for a number of Bugzilla parameters.
You need to configure Apache to run .cgi files outside the
+>Load this file in your editor. The only value you
+ need to change is $db_pass, the password for
+ the user you will create for your database.
+ Pick a strong password (for simplicity, it should not contain
+ single quote characters) and put it here.
+
The other options in the localconfig file
+ are documented by their accompanying comments. If you have a slightly
+ non-standard MySQL setup, you may wish to change one or more of
+ the other "$db_*" parameters.
+
You may also wish to change the names of
+ the priorities, severities, operating systems and platforms for your
+ installation. However, you can always change these after installation
+ has finished; if you then re-run
cgi-bin directory.
- Open your
- checksetup.pl, the changes will get picked up.
+ MySQL ships as insecure by default.
+ It allows anybody to on the local machine full administrative
+ capabilities without requiring a password; the special
+ MySQL root account (note: this is not the same as
+ the system root) also has no password.
+ Also, many installations default to running
+ mysqld as the system root.
+ To disable the anonymous user account
+ and set a password for the root user, execute the following. The
+ root user password should be different to the bugs user password
+ you set in
+ httpd.conf file and make sure the
- following line exists and is uncommented: From this point forward, to run the
+ mysql command-line client,
+ you will need to type
+ mysql -u root -p and enter
+ new_password when prompted.
+ If you run MySQL on the same machine as your web server, you
+ should disable remote access to MySQL by adding
+ the following to your /etc/my.conf:
+ To allow Consult the documentation that came with your system for
+ information on making mysqld run as an
+ unprivileged user.
+ For added security, you could also run MySQL, or even all
+ of Bugzilla
+ in a chroot jail; however, instructions for doing that are beyond
+ the scope of this document.
+ You need to configure MySQL to accept large packets, if you
+ want to have attachments larger than 64K. Add the text
+ below to your
+ .htaccess files to override
- permissions and .cgi files to run in the Bugzilla directory, make sure
- the following two lines are in a Directory
- directive that applies to the Bugzilla directory on your system
- (either the Bugzilla directory or one of its parents).
+>/etc/my.conf.
+ There is also a parameter in Bugzilla
+ for setting the maximum allowable attachment size, (default 1MB).
+ Bugzilla will only accept attachments up to the lower of these two
+ sizes.
You should modify the <DirectoryIndex> parameter for
- the Apache virtual host running your Bugzilla installation to
- allow index.cgi as the index page for a
- directory, as well as the usual index.html,
+>You need to add a new MySQL user for
+ Bugzilla to use. (It's not safe to have Bugzilla use the MySQL root
+ account.) The following instructions assume the defaults in
index.htm, and so forth. We use an SQL GRANT command to create a
+ "bugs"
+ user. This also restricts the
+ "bugs"
+ user to operations within a database called
+ "bugs", and only allows the account to connect from
+ "localhost".
+ Modify it to reflect your setup if you will be connecting from
+ another machine or as a different user. Run the mysql command-line client and
+ enter: For more information on Apache and its directives, see the
- glossary entry on Apache.
+>If you are using MySQL 4, you need to add
+ the LOCK TABLES and
+ CREATE TEMPORARY TABLES permissions
+ to the list.
If you need, or for some reason even want, to use Microsoft's
- Internet Information Services or
- Personal Web Server you should be able
- to. You will need to configure them to know how to run CGI scripts,
- however. This is described in Microsoft Knowledge Base article
- Q245225
- for Internet Information Services and
- Q231998
- for Personal Web Server.
+>
Next, rerun checksetup.pl. It reconfirms
+ that all the modules are present, and notices the altered
+ localconfig file, which it assumes you have edited to your
+ satisfaction. It compiles the UI templates,
+ connects to the database using the 'bugs'
+ user you created and the password you defined, and creates the
+ 'bugs' database and the tables therein.
Also, and this can't be stressed enough, make sure that files such as
-
After that, it asks for details of an administrator account. Bugzilla
+ can have multiple administrators - you can create more later - but
+ it needs one to start off with.
+ Enter the email address of an administrator, his or her full name,
+ and a suitable Bugzilla password.
+
localconfig and your checksetup.pl will then finish. You may rerun
+ data
- directory are secured as described in Section 4.5.4.
+>checksetup.pl at any time if you wish.
Ben FrantzDale reported success using AOL Server with Bugzilla. He
- reported his experience and what appears below is based on that.
+>Configure your web server according to the instructions in the
+ appropriate section. The Bugzilla Team recommends Apache.
AOL Server will have to be configured to run
- CGI Because AOL Server doesn't support Load .htaccess
- files, you'll have to create a TCL
- script. You should create an httpd.conf in your editor. Uncomment (or add) the following line.
+ This configures Apache to run .cgi files outside the
+ aolserver/modules/tcl/filter.tcl
- file (the filename shouldn't matter) with the following contents (change
- /bugzilla/ to the web-based path to
- your Bugzilla installation):
- Apache uses <Directory>
+ directives to permit fine-grained permission setting.
+ Add the following two lines to a
+ <Directory> directive that
+ applies either to the Bugzilla directory or one of its parents
+ (e.g. the <Directory /var/www/html>
+ directive).
+ This allows Bugzilla's .htaccess files to
+ override global permissions, and allows .cgi files to run in the
+ Bugzilla directory.
+ Add index.cgi to the end
+ of the DirectoryIndex
+ line. checksetup.pl can set tighter permissions
+ on Bugzilla's files and directories if it knows what user the
+ webserver runs as. Look for the User
+ line in httpd.conf, and place that value in
+ the $webservergroup variable in
+ localconfig. Then rerun
+ checksetup.pl.
+ If you need, or for some reason even want, to use Microsoft's
+ Internet Information Services or
+ Personal Web Server you should be able
+ to. You will need to configure them to know how to run CGI scripts.
+ This is described in Microsoft Knowledge Base article
+ Q245225
+ for Internet Information Services and
+ Q231998
+ for Personal Web Server.
+ Also, and this can't be stressed enough, make sure that files such as
+ localconfig and your data
+ directory are secured as described in Section 2.2.4.4.
+ Ben FrantzDale reported success using AOL Server with Bugzilla. He
+ reported his experience and what appears below is based on that.
+ AOL Server will have to be configured to run
+ CGI scripts, please consult
+ the documentation that came with your server for more information on
+ how to do this.
+ Because AOL Server doesn't support .htaccess
+ files, you'll have to create a TCL
+ script. You should create an aolserver/modules/tcl/filter.tcl
+ file (the filename shouldn't matter) with the following contents (change
+ /bugzilla/ to the web-based path to
+ your Bugzilla installation):
+ This probably doesn't account for all possible editor backup
- files so you may wish to add some additional variations of
- localconfig. For more information, see
-
bug 186383
bug 186383 or Bugtraq ID 6501.
- If you are using webdot from research.att.com (the default
- configuration for the webdotbase paramater), you
- will need to allow access to data/webdot/*.dot
- for the reasearch.att.com machine.
- If you are using a local installation of GraphViz, you will need to allow
- everybody to access *.png,
- *.gif, *.jpg, and
- *.map in the
- data/webdot directory.
- Users of Apache can skip this section because
+ Bugzilla ships with .htaccess files which
+ restrict access in the manner required.
+ Users of other webservers, read on.
+ There are several files in the Bugzilla directory
+ that should not be accessible from the web. You need to configure
+ your webserver so they they aren't. Not doing this may reveal
+ sensitive information such as database passwords.
+ In the main Bugzilla directory, you should: Block:
+ *.pl, *localconfig*, runtests.sh
+ But allow:
+ localconfig.js, localconfig.rdf
+ In data: Block everything But allow:
+ duplicates.rdf
+ In data/webdot: If you use a remote webdot server: Block everything But allow
+ *.dot
+ only for the remote webdot server Otherwise, if you use a local GraphViz: Block everything But allow:
+ *.png, *.gif, *.jpg, *.map
+ And if you don't use any dot: Block everything In Bugzilla: Block everything In template: Block everything You should test to make sure that the files mentioned above are
+ not accessible from the Internet, especially your
+ localconfig file which contains your database
+ password. To test, simply point your web browser at the file; for
+ example, to test mozilla.org's installation, we'd try to access
+ http://bugzilla.mozilla.org/localconfig. You should
+ get a 403 Forbidden
+ error.
+
Your Bugzilla should now be working. Access
+ http://<your-bugzilla-server>/ -
+ you should see the Bugzilla
+ front page. If not, consult the Troubleshooting section,
+ Section 2.5.
+
Log in with the administrator account you defined in the last
+ checksetup.pl run. You should go through
+ the parameters on the Edit Parameters page
+ (see link in the footer) and see if there are any you wish to
+ change.
+ They key parameters are documented in Section 3.1;
+ you should certainly alter
+ maintainer and urlbase;
+ you may also want to alter
+ cookiepath or requirelogin.
+
This would also be a good time to revisit the
+ localconfig file and make sure that the
+ names of the priorities, severities, platforms and operating systems
+ are those you wish to use when you start creating bugs. Remember
+ to rerun checksetup.pl if you change it.
+
Bugzilla has several optional features which require extra
+ configuration. You can read about those in
+ Section 2.3.
+ Chapter 2. Introduction
Chapter 2. Installing Bugzilla2.1. What is Bugzilla?
2.2. Why use a bug-tracking system?
2.3. Why use Bugzilla?
- Chapter 3. Using Bugzilla
3.1. Introduction
3.2. Create a Bugzilla Account
3.3. Anatomy of a Bug
-
Administration:
- Administration of a Bugzilla installation.
Bugzilla-General:
- Anything that doesn't fit in the other components, or spans
- multiple components.
Creating/Changing Bugs:
- Creating, changing, and viewing bugs.
Documentation:
- The Bugzilla documentation, including The Bugzilla Guide.
Email:
- Anything to do with email sent by Bugzilla.
Installation:
- The installation process of Bugzilla.
Query/Buglist:
- Anything to do with searching for bugs and viewing the
- buglists.
Reporting/Charting:
- Getting reports from Bugzilla.
User Accounts:
- Anything about managing a user account from the user's perspective.
- Saved queries, creating accounts, changing passwords, logging in,
- etc.
User Interface:
- General issues having to do with the user interface cosmetics (not
- functionality) including cosmetic issues, HTML templates,
- etc. 3.4. Searching for Bugs
3.5. Bug Lists
-
Long Format:
-
- this gives you a large page with a non-editable summary of the fields
- of each bug.
CSV:
-
- get the buglist as comma-separated values, for import into e.g.
- a spreadsheet.
Change Columns:
-
- change the bug attributes which appear in the list.
Change several bugs at once:
-
- If your account is sufficiently empowered, you can make the same
- change to all the bugs in the list - for example, changing their
- owner.
Send mail to bug owners:
-
- Sends mail to the owners of all bugs on the list.
Edit Search:
-
- If you didn't get exactly the results you were looking for, you can
- return to the Query page through this link and make small revisions
- to the query you just made so you get more accurate results.
Remember Search As:
-
- You can give a search a name and remember it; a link will appear
- in your page footer giving you quick access to run it again later.
- 3.6. Filing Bugs
3.7. Patch Viewer
View patches in color, with side-by-side view rather than trying
- to interpret the contents of the patch. See the difference between two patches. Get more context in a patch. Collapse and expand sections of a patch for easy
- reading. Link to a particular section of a patch for discussion or
- review Go to Bonsai or LXR to see more context, blame, and
- cross-references for the part of the patch you are looking at Create a rawtext unified format diff out of any patch, no
- matter what format it came from 3.7.1. Viewing Patches in Patch Viewer
3.7.2. Seeing the Difference Between Two Patches
3.7.3. Getting More Context in a Patch
3.7.4. Collapsing and Expanding Sections of a Patch
3.7.5. Linking to a Section of a Patch
3.7.6. Going to Bonsai and LXR
3.8. Hints and Tips
3.8.1. Autolinkification
- bug 12345 comment 7 bug 23456, comment 53 attachment 4321 mailto:george@example.com george@example.com ftp://ftp.mozilla.org Most other sorts of URL 3.8.2. Quicksearch
3.8.3. Comments
3.8.4. Attachments
3.9. User Preferences
3.9.1. Account Settings
3.9.2. Email Settings
Chapter 4. Installation
4.1. Step-by-step Install
Install Perl
- (5.6.0 or above)
-
[mysqld]
-# Allow packets up to 1M
-set-variable = max_allowed_packet=1M
-
4.1.2.1. Adding a user to MySQL
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
- DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost
- IDENTIFIED BY 'bugs_password';
- mysql> FLUSH PRIVILEGES;
-
4.1.5. checksetup.pl
bash# ./checksetup.pl
-
- 4.1.6. Perl Modules
2.1.5. Perl Modulesbash# ./checksetup.pl
- and, optionally:
+ Optional Perl modules:
4.1.6.1. Bundle::Bugzilla
bash# perl -MCPAN -eshell
-cpan shell -- CPAN exploration and modules installation (v1.63)
-ReadLine support enabled
-
-cpan>
-
-
4.1.6.2. CGI (2.88)
- CPAN Download Page: http://search.cpan.org/dist/CGI.pm/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/CGI.zip
- Documentation: http://www.perldoc.com/perl5.8.0/lib/CGI.html
- 4.1.6.3. TimeDate modules (2.21)
- CPAN Download Page: http://search.cpan.org/dist/TimeDate/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/TimeDate.zip
- Documentation: http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm
- 4.1.6.4. DBI (1.32)
- CPAN Download Page: http://search.cpan.org/dist/DBI/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBI.zip
- Documentation: http://dbi.perl.org/doc/
- 4.1.6.5. MySQL-related modules
2.1.5.1. DBD::mysql
- CPAN Download Page: http://search.cpan.org/dist/DBD-mysql/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBD-Mysql.zip
- Documentation: http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pod
- 4.1.6.6. File::Spec (0.82)
- CPAN Download Page: http://search.cpan.org/dist/File-Spec/
- PPM Download Page: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip
- Documentation: http://www.perldoc.com/perl5.8.0/lib/File/Spec.html
- 4.1.6.7. File::Temp (any)
- CPAN Download Page: http://search.cpan.org/dist/File-Spec/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip
- Documentation: http://www.perldoc.com/perl5.8.0/lib/File/Temp.html
-
- CPAN Download Page: http://search.cpan.org/dist/Template-Toolkit/
- PPM Download Link: http://openinteract.sourceforge.net/ppmpackages/5.6/Template-Toolkit.tar.gz
- Documentation: http://www.template-toolkit.org/docs.html
- 4.1.6.9. Text::Wrap (2001.0131)
- CPAN Download Page: http://search.cpan.org/dist/Text-Tabs+Wrap/
- Documentation: http://www.perldoc.com/perl5.8.0/lib/Text/Wrap.html
-
- CPAN Download Page: http://search.cpan.org/dist/GD/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GD.zip
- Documentation: http://stein.cshl.org/WWW/software/GD/
-
- CPAN Download Page: http://search.cpan.org/dist/Chart/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Chart.zip
- 4.1.6.12. XML::Parser (any) [optional]
- CPAN Download Page: http://search.cpan.org/dist/XML-Parser/
- Documentation: http://www.perldoc.com/perl5.6.1/lib/XML/Parser.html
-
- CPAN Download Page: http://search.cpan.org/dist/GDGraph/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDGraph.zip
- Documentation: http://search.cpan.org/dist/GDGraph/Graph.pm
- 2.1.5.7. XML::Parser (any)
- CPAN Download Page: http://search.cpan.org/dist/GDTextUtil/
- PPM Download Page: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDTextUtil.zip
- Documentation: http://search.cpan.org/dist/GDTextUtil/Text/Align.pm
-
- CPAN Download Page: http://search.cpan.org/dist/MIME-tools/
- PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/MIME-tools.zip
- Documentation: http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm
-
- CPAN Download Page: http://search.cpan.org/author/JKEISER/PatchReader/
- Documentation: http://www.johnkeiser.com/mozilla/Patch_Viewer.html
- 4.1.7. Configuring Bugzilla
4.2. HTTP Server Configuration
2.2. Configuration4.2.1. Apache httpd
2.2.1. localconfig2.2.2. MySQL
2.2.2.1. Security
bash$ mysql mysql
+ mysql> DELETE FROM user WHERE user = '';
+ mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
+ mysql> FLUSH PRIVILEGES;
AddHandler cgi-script .cgi
-
[myslqd]
+ # Prevent network access to MySQL.
+ skip-networking2.2.2.2. Allow large attachments
Options +ExecCGI
-AllowOverride Limit
-
[mysqld]
+ # Allow packets up to 1M
+ set-variable = max_allowed_packet=1M2.2.2.3. Add a user to MySQL
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
+ DROP,REFERENCES ON bugs.* TO bugs@localhost
+ IDENTIFIED BY '$db_pass';
+ mysql> FLUSH PRIVILEGES
4.2.2. Microsoft Internet Information Services
2.2.3. checksetup.pl4.2.3. AOL Server
2.2.4. Web server scripts, please consult
- the documentation that came with your server for more information on
- how to do this.
- 2.2.4.1. Apache httpd
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
-ns_register_filter preauth GET /bugzilla/localconfig~ filter_deny
-ns_register_filter preauth GET /bugzilla/\#localconfig\# filter_deny
-ns_register_filter preauth GET /bugzilla/*.pl filter_deny
-ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny
-ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny
-ns_register_filter preauth GET /bugzilla/data/* filter_deny
-ns_register_filter preauth GET /bugzilla/template/* filter_deny
-
-proc filter_deny { why } {
- ns_log Notice "filter_deny"
- return "filter_return"
-}
- AddHandler cgi-script .cgi Options +ExecCGI +FollowSymLinks
+ AllowOverride Limit
2.2.4.2. Microsoft Internet Information Services
2.2.4.3. AOL Server
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
+ ns_register_filter preauth GET /bugzilla/localconfig~ filter_deny
+ ns_register_filter preauth GET /bugzilla/\#localconfig\# filter_deny
+ ns_register_filter preauth GET /bugzilla/*.pl filter_deny
+ ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny
+ ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny
+ ns_register_filter preauth GET /bugzilla/data/* filter_deny
+ ns_register_filter preauth GET /bugzilla/template/* filter_deny
+
+ proc filter_deny { why } {
+ ns_log Notice "filter_deny"
+ return "filter_return"
+ }
+ 2.2.4.4. Web Server Access Controls
2.2.5. Bugzilla
Bugzilla has a number of optional features. This section describes how + to configure or enable them. +
As well as the text-based dependency graphs, Bugzilla also - supports dependency graphing, using a package called 'dot'. +>If you have installed the necessary Perl modules you + can start collecting statistics for the nifty Bugzilla + graphs.
bash# crontab -e |
This should bring up the crontab file in your editor. + Add a cron entry like this to run + collectstats.pl + daily at 5 after midnight: +
5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl |
After two days have passed you'll be able to view bug graphs from + the Reports page.
As well as the text-based dependency trees, Bugzilla also + supports a graphical view of dependency relationships, using a + package called 'dot'. Exactly how this works is controlled by the 'webdotbase' parameter, which can have one of three values:
So, to get this working, install +>The easiest way to get this working is to install in Apache. Alternatively, you could set up a webdot server, or use the AT&T - public webdot server (the - default for the webdotbase param). Note that AT&T's server won't work - if Bugzilla is only accessible using HARTS. + public webdot server. This is the default for the webdotbase param, + but it's often overloaded and slow. Note that AT&T's server + won't work + if Bugzilla is only accessible using HARTS. + Editor's note: What the heck is HARTS? Google doesn't know... +
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: -
| 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.
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 +>What good are + bugs if they're not annoying? To help make them more so you can set up Bugzilla's automatic whining system to complain at engineers which leave their bugs in the NEW or REOPENED 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): -
| cd <your-bugzilla-directory> ; - ./whineatnews.pl - - |
Depending on your system, crontab may have several manpages. - The following command should lead you to the most useful page for - this purpose: - |
Patch Viewer is the engine behind Bugzilla's graphical display of + code patches. You can integrate this with copies of the + cvs, lxr and + bonsai tools if you have them, by giving + the locations of your installation of these tools in + editparams.cgi. +
Patch Viewer also optionally will use the + cvs, diff and + interdiff + command-line utilities if they exist on the system. + Interdiff can be obtained from + http://cyberelk.net/tim/patchutils/. + If these programs are not in the system path, you can configure + their locations in localconfig. +
LDAP authentication is a module for Bugzilla's plugin authentication architecture. @@ -4790,7 +3372,7 @@ NAME="param-LDAPBaseDN" >
The LDAPBaseDN parameter should be set to the location in - your LDAP tree that you would like to search for e-mail addresses. + your LDAP tree that you would like to search for email addresses. Your uids should be unique under the DN specified here.
The LDAPmailattribute parameter should be the name of the - attribute which contains the e-mail address your users will enter + attribute which contains the email address your users will enter into the Bugzilla login boxes.
4.3.5. Preventing untrusted Bugzilla content from executing malicious - Javascript code2.3.6. Prevent users injecting malicious + Javascript
It is possible for a Bugzilla attachment to contain malicious - Javascript - code, which would be executed in the domain of your Bugzilla, thereby - making it possible for the attacker to e.g. steal your login cookies. +>It is possible for a Bugzilla user to take advantage of character + set encoding ambiguities to inject HTML into Bugzilla comments. This + could include malicious scripts. Due to internationalization concerns, we are unable to - incorporate by default the code changes necessary to fulfill the CERT - advisory requirements mentioned in + incorporate by default the code changes suggested by http://www.cert.org/tech_tips/malicious_code_mitigation.html/#3. +> the CERT advisory on this issue. If your installation is for an English speaking audience only, making the change below will prevent this problem.
$self->charset('');
- $self->charset('');
$self->charset('ISO-8859-1');
- $self->charset('ISO-8859-1');Bugzilla is unsupported under mod_perl. Effort is underway - to make it work cleanly in a mod_perl environment, but it is - slow going. -
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 + this problem, you may install the Apache module mod_throttle - - which can limit connections by ip-address. You may download this module + which can limit connections by IP address. You may download this module at This module only functions with the Apache web server! - You may use the + The command you need is ThrottleClientIP - - command provided by this module to accomplish this goal. See the +>. See the Module - Instructionsdocumentation for more information.
A single-box Bugzilla only requires port 80, plus port 25 if + you are using the optional email interface. You should firewall all + other ports and/or disable services listening on them. +
Many daemons, such as Apache's httpd and MySQL's mysqld default to + running as either "root" or "nobody". Running + as "root" introduces obvious security problems, but the + problems introduced by running everything as "nobody" may + not be so obvious. Basically, if you're running every daemon as + "nobody" and one of them gets compromised, they all get + compromised. For this reason it is recommended that you create a user + account for each daemon. +
Many aspects of the Bugzilla installation can be affected by the the operating system you choose to install it on. Sometimes it can be made @@ -5003,9 +3606,9 @@ CLASS="section" >4.4.1. Microsoft Windows2.4.1. Microsoft Windows
Making Bugzilla work on windows is still a painful processes. +>Making Bugzilla work on Windows is still a painful processes. The Bugzilla Team is working to make it easier, but that goal is not considered a top priority. If you wish to run Bugzilla, we still recommend doing so on a Unix based system such as GNU/Linux. As of this @@ -5017,9 +3620,9 @@ NAME="os-win32" installing Bugzilla on Win32, here are some pointers. Because this is a development version of the guide, these instructions - are subject to change without notice. In fact, the Bugzilla Team hopes - they do as we would like to have Bugzilla resonabally close to "out of - the box" compatibility by the 2.18 release. + are subject to change without notice. In fact, the Bugzilla Team hopes + to have Bugzilla reasonably close to "out of + the box" compatibility with Windows by the 2.18 release.
Perl for Windows can be obtained from 4.4.1.2. Perl Modules on Win322.4.1.2. Perl Modules on Win32
Bugzilla on Windows requires the same perl modules found in Section 4.1.6Section 2.1.5. The main difference is that windows uses
A complete list of modules that can be installed using ppm can - be found at http://www.activestate.com/PPMPackages/5.6plus. - |
As Bugzilla still doesn't run "out of the box" on - Windows, code has to be modified. This section is an attempt to - list the required changes. + Windows, code has to be modified. This section lists the required + changes.
To make bug e-mail work on Win32 (until
+>To make bug email work on Win32 (until
Don't forget to change the name of your SMTP server and the
- domain of the sending e-mail address (after the '@') in the above
+ domain of the sending email address (after the '@') in the above
lines of code.
As is the case on Unix based systems, any web server should be able to handle Bugzilla; however, the Bugzilla Team still recommends Apache whenever asked. No matter what web server you choose, be sure to pay attention to the security notes in Section 4.5.4Section 2.2.4.4. More information on configuring specific web servers can be found in Section 4.2Section 2.2.4.
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.
Apple did not include the GD library with Mac OS X. Bugzilla + needs this for bug graphs.The easiest way to get a lot of these is with a program called +>You can install it using a program called Fink, which is similar in nature to the CPAN installer, but installs common GNU utilities. Fink is available from .
Follow the instructions for setting up Fink. Once it's installed, - you'll want to use it to install the gd2 package. + you'll want to use it to install the gd2 package.
It will prompt you for a number of dependencies, type 'y' and hit @@ -5433,7 +4005,7 @@ CLASS="glossterm" >CPAN to - install the GD perl module. + install the GD Perl module.
Also available via Fink is expat. Once running using fink to +>Also available via Fink is expat. After using fink to install the expat package you will be able to install XML::Parser using CPAN. There is one caveat. Unlike recent versions of the GD module, XML::Parser doesn't prompt for the location of the @@ -5595,7 +4167,7 @@ CLASS="section" >4.4.3. Linux-Mandrake 8.02.4.3. Linux-Mandrake 8.0
Linux-Mandrake 8.0 includes every required and optional library for Bugzilla. The easiest way to install them is by using the @@ -5683,7 +4255,7 @@ BORDER="0" ALT="(1)">
Poorly-configured MySQL and Bugzilla installations have - given attackers full access to systems in the past. Please take these - guidelines seriously, even for Bugzilla machines hidden away behind - your firewall. 80% of all computer trespassers are insiders, not - anonymous crackers. This is not meant to be a comprehensive list of every possible - security issue pertaining to the software mentioned in this section. - There is - no subsitute for reading the information written by the authors of any - software running on your system. - |
TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla - only needs 1, or 2 if you need to use features that require e-mail such - as bug moving or the e-mail interface from contrib. You should audit - your server and make sure that you aren't listening on any ports you - don't need to be. You may also wish to use some kind of firewall - software to be sure that trafic can only be recieved on ports you - specify. -
MySQL ships by default with many settings that should be changed. - By defaults it allows anybody to connect from localhost without a - password and have full administrative capabilities. It also defaults to - not have a root password (this is not the same as - the system root). Also, many installations default to running - mysqld as the system root. -
Consult the documentation that came with your system for - information on making mysqld run as an - unprivleged user. -
You should also be sure to disable the anonymous user account - and set a password for the root user. This is accomplished using the - following commands: -
bash$ mysql mysql
-mysql> DELETE FROM user WHERE user = '';
-mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
-mysql> FLUSH PRIVILEGES;
- |
From this point forward you will need to use - mysql -u root -p and enter - new_password when prompted when using the - mysql client. -
If you run MySQL on the same machine as your httpd server, you - should consider disabling networking from within MySQL by adding - the following to your /etc/my.conf: -
[myslqd] -# Prevent network access to MySQL. -skip-networking - |
You may also consider running MySQL, or even all of Bugzilla - in a chroot jail; however, instructions for doing that are beyond - the scope of this document. -
Many daemons, such as Apache's httpd and MySQL's mysqld default to - running as either "root" or "nobody". Running - as "root" introduces obvious security problems, but the - problems introduced by running everything as "nobody" may - not be so obvious. Basically, if you're running every daemon as - "nobody" and one of them gets compromised, they all get - compromised. For this reason it is recommended that you create a user - account for each daemon. -
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. - |
There are many files that are placed in the Bugzilla directory - area that should not be accessable from the web. Because of the way - Bugzilla is currently laid out, the list of what should and should - not be accessible is rather complicated. -
Users of Apache don't need to worry about this, however, because - Bugzilla ships with .htaccess files which restrict access to all the - sensitive files in this section. Users of other webservers, read on. -
In the main Bugzilla directory, you should:
Block: - *.pl, *localconfig*, runtests.sh -
But allow: - localconfig.js, localconfig.rdf -
In data:
Block everything
But allow: - duplicates.rdf -
In data/webdot:
If you use a remote webdot server:
Block everything
But allow - *.dot - only for the remote webdot server
Otherwise, if you use a local GraphViz:
Block everything
But allow: - *.png, *.gif, *.jpg, *.map -
And if you don't use any dot:
Block everything
In Bugzilla:
Block everything
In template:
Block everything
You should test to make sure that the files mentioned above are - not accessible from the Internet, especially your - localconfig file which contains your database - password. To test, simply point your web browser at the file; for - example, to test mozilla.org's installation, we'd try to access - http://bugzilla.mozilla.org/localconfig. You should - get a 403 Forbidden - error. -
Not following the instructions in this section, including - testing, may result in sensitive information being globally - accessible. - |
You should check Section 4.2 to see if instructions - have been included for your web server. You should also compare those - instructions with this list to make sure everything is properly - accounted for. - |
This section gives solutions to common Bugzilla installation - problems. + problems. If none of the section headings seems to match your + problem, read the general advice.
If you can't get checksetup.pl to run to + completion, it normally explains what's wrong and how to fix it. + If you can't work it out, or if it's being uncommunicative, post + the errors in the + netscape.public.mozilla.webtools + newsgroup. +
If you have made it all the way through + Section 2.1 (Installation) and + Section 2.2 (Configuration) but + accessing the Bugzilla URL doesn't work, + the first thing to do is to check your webserver error log. For + Apache, this is often located at + /etc/logs/httpd/error_log. The error messages + you see may be self-explanatory enough to enable you to diagnose and + fix the problem. If not, see below for some commonly-encountered + errors. If that doesn't help, post the errors to the newsgroup. +
You have two versions of Perl on your machine. You are installing + modules into one, and Bugzilla is using the other. Rerun the CPAN + commands (or manual compile) using the full path to Perl from the + top of checksetup.pl. This will make sure you + are installing the modules in the right place. +
Try executing 4.6.2. DBD::Sponge::db prepare failed
2.5.4. 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): @@ -6367,7 +4459,7 @@ CLASS="section" >4.6.3. cannot chdir(/var/spool/mqueue)2.5.5. cannot chdir(/var/spool/mqueue)
If you are installing Bugzilla on SuSE Linux, or some other distributions with @@ -6425,28 +4517,15 @@ CLASS="section" >4.6.4. Your vendor has not defined Fcntl macro O_NOINHERIT2.5.6. 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-2. + 5.6.0. Many minor variations of this error have been reported:
Figure 4-2. Other File::Temp error messages
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-3. The patch is also + the following patch, which is also available as a patch file.
Figure 4-3. Patch for File::Temp in Perl 5.6.0
| the template for which you are requesting a hook; |
| where in the template you would like the hook to be placed + (line number/position for latest version of template in CVS + or description of location); + |
| the purpose of the hook; |
| a link to information about your extension, if any. |
The Bugzilla reviewers will promptly review each hook request, + name the hook, add it to the template, check the new version + of the template into CVS, and create the corresponding directory in + BUGZILLA_ROOT/template/en/extension/hook/. +
You may optionally attach a patch to the bug which implements the hook + and check it in yourself after receiving approval from a Bugzilla + reviewer. The developers may suggest changes to the location of the + hook based on their analysis of your needs or so the hook can satisfy + the needs of multiple extensions, but the process of getting hooks + approved and checked in is not as stringent as the process for general + changes to Bugzilla, and any extension, whether released or still in + development, can have hooks added to meet their needs. +
After making sure the hook you need exists (or getting it added if not), + add your extension template to the directory within the Bugzilla + directory tree corresponding to the hook. +
That's it! Now, when the standard template containing the hook + is processed, your extension template will be processed at the point + where the hook appears. +
For example, let's say you have an extension named Projman that adds + project management capabilities to Bugzilla. Projman has an + administration interface edit-projects.cgi, + and you want to add a link to it into the navigation bar at the bottom + of every Bugzilla page for those users who are authorized + to administer projects. +
The navigation bar is generated by the template file + useful-links.html.tmpl, which is located in + the global/ subdirectory on the standard Bugzilla + template path + BUGZILLA_ROOT/template/en/default/. + Looking in useful-links.html.tmpl, you find + the following hook at the end of the list of standard Bugzilla + administration links: +
...
+ [% ', <a href="editkeywords.cgi">keywords</a>'
+ IF user.groups.editkeywords %]
+ [% Hook.process("edit") %]
+... |
The corresponding directory for this hook is + BUGZILLA_ROOT/template/en/extension/hook/global/useful-links.html.tmpl/edit/. +
You put a template named + projman-edit-projects.html.tmpl + into that directory with the following content: +
...[% ', <a href="edit-projects.cgi">projects</a>' IF user.groups.projman_admins %] |
Voila! The link now appears after the other administration links in the + navigation bar for users in the projman_admins group. +
Notes: +
You may want to prefix your extension template names + with the name of your extension, e.g. + projman-foo.html.tmpl, + so they do not conflict with the names of templates installed by + other extensions. +
If your extension includes entirely new templates in addition to + extensions of standard templates, it should install those new + templates into an extension-specific subdirectory of the + BUGZILLA_ROOT/template/en/extension/ + directory. The extension/ directory, like the + default/ and custom/ + directories, is part of the template search path, so putting templates + there enables them to be found by the template processor. +
The template processor looks for templates first in the + custom/ directory (i.e. templates added by the + specific installation), then in the extension/ + directory (i.e. templates added by extensions), and finally in the + default/ directory (i.e. the standard Bugzilla + templates). Thus extension templates can override standard templates, + but installation-specific templates override both. +
Note that overriding standard templates with extension templates + gives you great power but also makes upgrading an installation harder. + As with custom templates, we recommend using this functionality + sparingly and only when absolutely necessary. +
Installation customizers can also take advantage of hooks when adding + code to a Bugzilla template. To do so, create directories in + BUGZILLA_ROOT/template/en/custom/hook/ + equivalent to the directories in + BUGZILLA_ROOT/template/en/extension/hook/ + for the hooks you want to use, then place your customization templates + into those directories. +
Obviously this method of customizing Bugzilla only lets you add code + to the standard templates; you cannot change the existing code. + Nevertheless, for those customizations that only add code, this method + can reduce conflicts when merging changes, making upgrading + your customized Bugzilla installation easier. +
6.3. Modifying Your Running System4.4. Modifying Your Running System
Bugzilla optimizes database lookups by storing all relatively static information in the @@ -8943,7 +7323,7 @@ CLASS="section" >6.4. MySQL Bugzilla Database Introduction4.5. 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 @@ -9003,9 +7383,9 @@ CLASS="section" >
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 @@ -9117,9 +7497,9 @@ CLASS="section" >
Imagine your MySQL database as a series of spreadsheets, and you won't be too far off. If you use this command:
6.5. Integrating Bugzilla with Third-Party Tools4.6. Integrating Bugzilla with Third-Party ToolsBonsai is a web-based tool for managing 6.5.2. CVS4.6.2. CVS
CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway.
6.5.3. Perforce SCM4.6.3. Perforce SCMYou can find the project page for Bugzilla and Teamtrack Perforce integration (p4dti) at: @@ -9466,7 +7846,7 @@ CLASS="section" >6.5.4. Tinderbox/Tinderbox24.6.4. Tinderbox/Tinderbox2
Tinderbox is a continuous-build system which can integrate with Bugzilla - see @@ -9486,6 +7866,1019 @@ TARGET="_top" >
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 runs an up-to-the-minute version, + so some things may not quite work as this document describes.
If you want to use Bugzilla, first you need to create an account. + Consult with the administrator responsible for your installation of + Bugzilla for the URL you should use to access it. If you're + test-driving Bugzilla, use this URL: + http://landfill.bugzilla.org/bugzilla-tip/. +
Click the + "Open a new Bugzilla account" + + link, enter your email address and, optionally, your name in the + spaces provided, then click + "Create Account" + + .
Within moments, you should receive an email to the address + you provided, which contains your login name (generally the + same as the email address), and a password. + This password is randomly generated, but can be + changed to something more memorable.
Click the + "Log In" + link in the footer at the bottom of the page in your browser, + enter your email address and password into the spaces provided, and + click + "Login". +
You are now logged in. Bugzilla uses cookies to remember you are + logged in so, unless you have cookies disabled or your IP address changes, + you should not have to log in again.
The core of Bugzilla is the screen which displays a particular + bug. It's a good place to explain some Bugzilla concepts. + Bug 1 on Landfill + + is a good example. Note that the labels for most fields are hyperlinks; + clicking them will take you to context-sensitive help on that + particular field. Fields marked * may not be present on every + installation of Bugzilla.
Product and Component: + Bugs are divided up by Product and Component, with a Product + having one or more Components in it. For example, + bugzilla.mozilla.org's "Bugzilla" Product is composed of several + Components: +
| Administration: + Administration of a Bugzilla installation. |
| Bugzilla-General: + Anything that doesn't fit in the other components, or spans + multiple components. |
| Creating/Changing Bugs: + Creating, changing, and viewing bugs. |
| Documentation: + The Bugzilla documentation, including The Bugzilla Guide. |
| Email: + Anything to do with email sent by Bugzilla. |
| Installation: + The installation process of Bugzilla. |
| Query/Buglist: + Anything to do with searching for bugs and viewing the + buglists. |
| Reporting/Charting: + Getting reports from Bugzilla. |
| User Accounts: + Anything about managing a user account from the user's perspective. + Saved queries, creating accounts, changing passwords, logging in, + etc. |
| User Interface: + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, + etc. |
Status and Resolution: + + These define exactly what state the bug is in - from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the + context-sensitive help for those items.
Assigned To: + The person responsible for fixing the bug.
*URL: + A URL associated with the bug, if any.
Summary: + A one-sentence summary of the problem.
*Status Whiteboard: + (a.k.a. Whiteboard) A free-form text area for adding short notes + and tags to a bug.
*Keywords: + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression.
Platform and OS: + These indicate the computing environment where the bug was + found.
Version: + The "Version" field is usually used for versions of a product which + have been released, and is set to indicate which versions of a + Component have the particular problem the bug report is + about.
Priority: + The bug assignee uses this field to prioritise his or her bugs. + It's a good idea not to change this on other people's bugs.
Severity: + This indicates how severe the problem is - from blocker + ("application unusable") to trivial ("minor cosmetic issue"). You + can also use this field to indicate whether a bug is an enhancement + request.
*Target: + (a.k.a. Target Milestone) A future version by which the bug is to + be fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not + restricted to numbers, thought - you can use any text strings, such + as dates.
Reporter: + The person who filed the bug.
CC list: + A list of people who get mail when the bug changes.
Attachments: + You can attach files (e.g. testcases or patches) to bugs. If there + are any attachments, they are listed in this section.
*Dependencies: + If this bug cannot be fixed unless other bugs are fixed (depends + on), or this bug stops other bugs being fixed (blocks), their + numbers are recorded here.
*Votes: + Whether this bug has any votes.
Additional Comments: + You can add your two cents to the bug discussion here, if you have + something worthwhile to say.
The Bugzilla Search page is is the interface where you can find + any bug report, comment, or patch currently in the Bugzilla system. You + can play with it here: + http://landfill.bugzilla.org/bugzilla-tip/query.cgi.
The Search page has controls for selecting different possible + values for all of the fields in a bug, as described above. For some + fields, multiple values can be selected. In those cases, Bugzilla + returns bugs where the content of the field matches any one of the selected + values. If none is selected, then the field can take any value.
Once you've run a search, you can save it as a Saved Search, which + appears in the page footer.
Highly advanced querying is done using Boolean Charts. See the + Boolean Charts help link on the Search page for more information.
If you run a search, a list of matching bugs will be returned. +
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. |
| CSV: + + get the buglist as comma-separated values, for import into e.g. + a spreadsheet. |
| Change Columns: + + change the bug attributes which appear in the list. |
| Change several bugs at once: + + If your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner. |
| Send mail to bug owners: + + Sends mail to the owners of all bugs on the list. |
| Edit Search: + + If you didn't get exactly the results you were looking for, you can + return to the Query page through this link and make small revisions + to the query you just made so you get more accurate results. |
| Remember Search As: + + You can give a search a name and remember it; a link will appear + in your page footer giving you quick access to run it again later. + |
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:
Go to + Landfill + in your browser and click + Enter a new bug report. +
Select a product - any one will do.
Fill in the fields. Bugzilla should have made reasonable + guesses, based upon your browser, for the "Platform" and "OS" + drop-down boxes. If they are wrong, change them.
Select "Commit" and send in your bug report.
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. +
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. +
Viewing and reviewing patches in Bugzilla is often difficult due to + lack of context, improper format and the inherent readability issues that + raw patches present. Patch Viewer is an enhancement to Bugzilla designed + to fix that by offering increased context, linking to sections, and + integrating with Bonsai, LXR and CVS.
Patch viewer allows you to:
| View patches in color, with side-by-side view rather than trying + to interpret the contents of the patch. |
| See the difference between two patches. |
| Get more context in a patch. |
| Collapse and expand sections of a patch for easy + reading. |
| Link to a particular section of a patch for discussion or + review |
| Go to Bonsai or LXR to see more context, blame, and + cross-references for the part of the patch you are looking at |
| Create a rawtext unified format diff out of any patch, no + matter what format it came from |
The main way to view a patch in patch viewer is to click on the + "Diff" link next to a patch in the Attachments list on a bug. You may + also do this within the edit window by clicking the "View Attachment As + Diff" button in the Edit Attachment screen.
To see the difference between two patches, you must first view the + newer patch in Patch Viewer. Then select the older patch from the + dropdown at the top of the page ("Differences between [dropdown] and + this patch") and click the "Diff" button. This will show you what + is new or changed in the newer patch.
To get more context in a patch, you put a number in the textbox at + the top of Patch Viewer ("Patch / File / [textbox]") and hit enter. + This will give you that many lines of context before and after each + change. Alternatively, you can click on the "File" link there and it + will show each change in the full context of the file. This feature only + works against files that were diffed using "cvs diff".
To view only a certain set of files in a patch (for example, if a + patch is absolutely huge and you want to only review part of it at a + time), you can click the "(+)" and "(-)" links next to each file (to + expand it or collapse it). If you want to collapse all files or expand + all files, you can click the "Collapse All" and "Expand All" links at the + top of the page.
To link to a section of a patch (for example, if you want to be + able to give someone a URL to show them which part you are talking + about) you simply click the "Link Here" link on the section header. The + resulting URL can be copied and used in discussion. (Copy Link + Location in Mozilla works as well.)
To go to Bonsai to get blame for the lines you are interested in, + you can click the "Lines XX-YY" link on the section header you are + interested in. This works even if the patch is against an old + version of the file, since Bonsai stores all versions of the file.
To go to LXR, you click on the filename on the file header + (unfortunately, since LXR only does the most recent version, line + numbers are likely to rot).
This section distills some Bugzilla tips and best practices + that have been developed.
Bugzilla comments are plain text - so typing <U> will + produce less-than, U, greater-than rather than underlined text. + However, Bugzilla will automatically make hyperlinks out of certain + sorts of text in comments. For example, the text + "http://www.bugzilla.org" will be turned into a link: + http://www.bugzilla.org. + Other strings which get linkified in the obvious manner are: +
| bug 12345 |
| comment 7 |
| 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 convenience of others. +
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.
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, + if you do it out of habit, but full mail/news-style + four line ASCII art creations are not. +
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. +
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. +
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 three tabs:
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 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. +
You can also do further filtering on the client side by + using the X-Bugzilla-Reason mail header which Bugzilla + adds to all bugmail. This tells you what relationship you have to the + bug in question, + and can be any of Owner, Reporter, QAcontact, CClist, Voter and + WatchingComponent.
By entering user email names, delineated by commas, into the + "Users to watch" text entry box you can receive a copy of all the + bugmail of other users (security settings permitting.) This powerful + functionality enables seamless transitions as developers change + projects or users go on holiday.
The ability to watch other users may not be available in all + Bugzilla installations. If you can't see it, ask your + administrator. |
Microsoft has some advice on this matter, as well:
Appendix C. Manual Installation of Perl Modules
C.1. Instructions
If you need to install Perl modules manually, here's how it's done. + Download the module using the link given in the next section, and then + apply this magic incantation, as root: +
+
+
bash# tar -xzvf <module>.tar.gz +bash# cd <module> +bash# perl Makefile.PL +bash# make +bash# make test +bash# make installC.2. Download Locations
Note: some modules are in the core distribution of + ActiveState Perl for Windows. Others are not available. + No PPM links have been provided in either of these two cases. +
CGI: +
+
+ CPAN Download Page: http://search.cpan.org/dist/CGI.pm/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/CGI.zip
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/CGI.html
+TimeDate: +
+
+ CPAN Download Page: http://search.cpan.org/dist/TimeDate/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/TimeDate.zip
+ Documentation: http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm
+DBI: +
+
+ CPAN Download Page: http://search.cpan.org/dist/DBI/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBI.zip
+ Documentation: http://dbi.perl.org/docs/
+DBD::mysql: +
+
+ CPAN Download Page: http://search.cpan.org/dist/DBD-mysql/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/DBD-Mysql.zip
+ Documentation: http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm
+File::Spec: +
+
+ CPAN Download Page: http://search.cpan.org/dist/File-Spec/
+ PPM Download Page: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/File-Spec.zip
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/File/Spec.html
+File::Temp: +
+
+ CPAN Download Page: http://search.cpan.org/dist/File-Temp/
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/File/Temp.html
+Template Toolkit: +
+
+ CPAN Download Page: http://search.cpan.org/dist/Template-Toolkit/
+ PPM Download Link: http://openinteract.sourceforge.net/ppmpackages/5.6/Template-Toolkit.tar.gz
+ Documentation: http://www.template-toolkit.org/docs.html
+Text::Wrap: +
+
+ CPAN Download Page: http://search.cpan.org/dist/Text-Tabs+Wrap/
+ Documentation: http://www.perldoc.com/perl5.8.0/lib/Text/Wrap.html
+GD: +
+
+ CPAN Download Page: http://search.cpan.org/dist/GD/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GD.zip
+ Documentation: http://stein.cshl.org/WWW/software/GD/
+Chart::Base: + +
+
+ CPAN Download Page: http://search.cpan.org/dist/Chart/
+GD::Graph: +
+
+ CPAN Download Page: http://search.cpan.org/dist/GDGraph/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDGraph.zip
+ Documentation: http://search.cpan.org/dist/GDGraph/Graph.pm
+GD::Text::Align: +
+
+ CPAN Download Page: http://search.cpan.org/dist/GDTextUtil/
+ PPM Download Page: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/GDTextUtil.zip
+ Documentation: http://search.cpan.org/dist/GDTextUtil/Text/Align.pm
+MIME::Parser: +
+
+ CPAN Download Page: http://search.cpan.org/dist/MIME-tools/
+ PPM Download Link: http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/MIME-tools.zip
+ Documentation: http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm
+XML::Parser: +
+
+ CPAN Download Page: http://search.cpan.org/dist/XML-Parser/
+ Documentation: http://www.perldoc.com/perl5.6.1/lib/XML/Parser.html
+PatchReader: +
+
+ CPAN Download Page: http://search.cpan.org/author/JKEISER/PatchReader/
+ Documentation: http://www.johnkeiser.com/mozilla/Patch_Viewer.html
+
Version 1.1, March 2000
0. PREAMBLE0. PreambleThe purpose of this License is to make a manual, textbook, or other written document "free" in the sense of freedom: to assure everyone the @@ -12060,7 +11883,7 @@ CLASS="section" >1. APPLICABILITY AND DEFINITIONS1. Applicability and Definition
This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under @@ -12125,7 +11948,7 @@ CLASS="section" >2. VERBATIM COPYING2. Verbatim Copying
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the @@ -12147,7 +11970,7 @@ CLASS="section" >3. COPYING IN QUANTITY3. 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 @@ -12191,7 +12014,7 @@ CLASS="section" >4. MODIFICATIONS4. 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 @@ -12329,7 +12152,7 @@ CLASS="section" >5. COMBINING DOCUMENTS5. Combining Documents
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified @@ -12360,7 +12183,7 @@ CLASS="section" >6. COLLECTIONS OF DOCUMENTS6. Collections of Documents
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies @@ -12381,7 +12204,7 @@ CLASS="section" >7. AGGREGATION WITH INDEPENDENT WORKS7. 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 @@ -12405,7 +12228,7 @@ CLASS="section" >8. TRANSLATION8. Translation
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. @@ -12425,7 +12248,7 @@ CLASS="section" >9. TERMINATION9. Termination
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to @@ -12442,7 +12265,7 @@ CLASS="section" >10. FUTURE REVISIONS OF THIS LICENSE10. 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 @@ -12476,7 +12299,7 @@ NAME="gfdl-howto" of the License in the document and put the following copyright and license notices just after the title page:
0-9, high ascii
For more information about how to configure Apache for Bugzilla, see Section 4.2.1Section 2.2.4.1. Much more detailed information about the suggestions in Section 4.5.2Section 2.2.2.1.
The Bugzilla Guide - 2.17.5 +>The Bugzilla Guide - 2.17.7 Development Release The Bugzilla Guide - 2.17.5 +>The Bugzilla Guide - 2.17.7 Development Release The Bugzilla Guide - 2.17.5 +>The Bugzilla Guide - 2.17.7 Development Release Chapter 5. Administering BugzillaChapter 3. Administering Bugzilla Table of Contents
- 5.1. 3.1. Bugzilla Configuration
- 5.2. 3.2. User Administration
- 5.2.1. 3.2.1. Creating the Default User
- 5.2.2. 3.2.2. Managing Other Users
- 5.3. 3.3. Products
- 5.4. 3.4. Components
- 5.5. 3.5. Versions
- 5.6. 3.6. Milestones
- 5.7. 3.7. Voting
- 5.8. 3.8. Groups and Group Security
- 5.9. 3.9. Upgrading to New Releases
The Bugzilla Guide - 2.17.5 +>The Bugzilla Guide - 2.17.7 Development Release Chapter 3. Using BugzillaChapter 5. Using Bugzilla 3.3. Anatomy of a Bug5.3. 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. diff --git a/mozilla/webtools/bugzilla/docs/html/bugreports.html b/mozilla/webtools/bugzilla/docs/html/bugreports.html index 9dd3e335bd6..7b13680ebde 100644 --- a/mozilla/webtools/bugzilla/docs/html/bugreports.html +++ b/mozilla/webtools/bugzilla/docs/html/bugreports.html @@ -7,7 +7,7 @@ NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ ">
The Bugzilla Guide - 2.17.5 +>The Bugzilla Guide - 2.17.7 Development Release Chapter 3. Using BugzillaChapter 5. Using Bugzilla 3.6. Filing Bugs5.6. Filing Bugs Years of bug writing experience has been distilled for your reading pleasure into the diff --git a/mozilla/webtools/bugzilla/docs/html/cmdline.html b/mozilla/webtools/bugzilla/docs/html/cmdline.html index be3ee0a5ee8..343aa58a07f 100644 --- a/mozilla/webtools/bugzilla/docs/html/cmdline.html +++ b/mozilla/webtools/bugzilla/docs/html/cmdline.html @@ -7,7 +7,7 @@ NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ ">
The Bugzilla Guide - 2.17.5 +>The Bugzilla Guide - 2.17.7 Development Release NextNextGNU Free Documentation LicenseManual Installation of Perl Modules
Components are subsections of a Product. E.g. the computer game you are designing may have a "UI" diff --git a/mozilla/webtools/bugzilla/docs/html/configuration.html b/mozilla/webtools/bugzilla/docs/html/configuration.html new file mode 100644 index 00000000000..295a7654055 --- /dev/null +++ b/mozilla/webtools/bugzilla/docs/html/configuration.html @@ -0,0 +1,1245 @@ +
Poorly-configured MySQL and Bugzilla installations have + given attackers full access to systems in the past. Please take the + security parts of these guidelines seriously, even for Bugzilla + machines hidden away behind your firewall. |
Once you run checksetup.pl with all the correct + modules installed, it displays a message about, and write out a + file called, + localconfig. This file contains the default + settings for a number of Bugzilla parameters. +
Load this file in your editor. The only value you + need to change is $db_pass, the password for + the user you will create for your database. + Pick a strong password (for simplicity, it should not contain + single quote characters) and put it here. +
The other options in the localconfig file + are documented by their accompanying comments. If you have a slightly + non-standard MySQL setup, you may wish to change one or more of + the other "$db_*" parameters. +
You may also wish to change the names of + the priorities, severities, operating systems and platforms for your + installation. However, you can always change these after installation + has finished; if you then re-run + checksetup.pl, the changes will get picked up. +
MySQL ships as insecure by default. + It allows anybody to on the local machine full administrative + capabilities without requiring a password; the special + MySQL root account (note: this is not the same as + the system root) also has no password. + Also, many installations default to running + mysqld as the system root. +
To disable the anonymous user account + and set a password for the root user, execute the following. The + root user password should be different to the bugs user password + you set in + localconfig in the previous section, + and also different to + the password for the system root account on your machine. +
bash$ mysql mysql
+ mysql> DELETE FROM user WHERE user = '';
+ mysql> UPDATE user SET password = password('new_password') WHERE user = 'root';
+ mysql> FLUSH PRIVILEGES; |
From this point forward, to run the + mysql command-line client, + you will need to type + mysql -u root -p and enter + new_password when prompted. +
If you run MySQL on the same machine as your web server, you + should disable remote access to MySQL by adding + the following to your /etc/my.conf: +
[myslqd] + # Prevent network access to MySQL. + skip-networking |
Consult the documentation that came with your system for + information on making mysqld run as an + unprivileged user. +
For added security, you could also run MySQL, or even all + of Bugzilla + in a chroot jail; however, instructions for doing that are beyond + the scope of this document. +
You need to configure MySQL to accept large packets, if you + want to have attachments larger than 64K. Add the text + below to your + /etc/my.conf. + There is also a parameter in Bugzilla + for setting the maximum allowable attachment size, (default 1MB). + Bugzilla will only accept attachments up to the lower of these two + sizes. +
[mysqld] + # Allow packets up to 1M + set-variable = max_allowed_packet=1M |
You need to add a new MySQL user for + Bugzilla to use. (It's not safe to have Bugzilla use the MySQL root + account.) The following instructions assume the defaults in + localconfig; + if you changed those, you need to modify the + SQL command appropriately. You will need the + $db_pass password you set in + localconfig in + Section 2.2.1. +
We use an SQL GRANT command to create a + "bugs" + user. This also restricts the + "bugs" + user to operations within a database called + "bugs", and only allows the account to connect from + "localhost". + Modify it to reflect your setup if you will be connecting from + another machine or as a different user.
Run the mysql command-line client and + enter:
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, + DROP,REFERENCES ON bugs.* TO bugs@localhost + IDENTIFIED BY '$db_pass'; + mysql> FLUSH PRIVILEGES |
If you are using MySQL 4, you need to add + the LOCK TABLES and + CREATE TEMPORARY TABLES permissions + to the list. + |
Next, rerun checksetup.pl. It reconfirms + that all the modules are present, and notices the altered + localconfig file, which it assumes you have edited to your + satisfaction. It compiles the UI templates, + connects to the database using the 'bugs' + user you created and the password you defined, and creates the + 'bugs' database and the tables therein. +
After that, it asks for details of an administrator account. Bugzilla + can have multiple administrators - you can create more later - but + it needs one to start off with. + Enter the email address of an administrator, his or her full name, + and a suitable Bugzilla password. +
checksetup.pl will then finish. You may rerun + checksetup.pl at any time if you wish. +
Configure your web server according to the instructions in the + appropriate section. The Bugzilla Team recommends Apache. +
Load httpd.conf in your editor.
Uncomment (or add) the following line. + This configures Apache to run .cgi files outside the + cgi-bin directory. +
AddHandler cgi-script .cgi |
Apache uses <Directory> + directives to permit fine-grained permission setting. + Add the following two lines to a + <Directory> directive that + applies either to the Bugzilla directory or one of its parents + (e.g. the <Directory /var/www/html> + directive). + This allows Bugzilla's .htaccess files to + override global permissions, and allows .cgi files to run in the + Bugzilla directory. +
Options +ExecCGI +FollowSymLinks + AllowOverride Limit |
Add index.cgi to the end + of the DirectoryIndex + line.
checksetup.pl can set tighter permissions + on Bugzilla's files and directories if it knows what user the + webserver runs as. Look for the User + line in httpd.conf, and place that value in + the $webservergroup variable in + localconfig. Then rerun + checksetup.pl. +
If you need, or for some reason even want, to use Microsoft's + Internet Information Services or + Personal Web Server you should be able + to. You will need to configure them to know how to run CGI scripts. + This is described in Microsoft Knowledge Base article + Q245225 + for Internet Information Services and + Q231998 + for Personal Web Server. +
Also, and this can't be stressed enough, make sure that files such as + localconfig and your data + directory are secured as described in Section 2.2.4.4. +
Ben FrantzDale reported success using AOL Server with Bugzilla. He + reported his experience and what appears below is based on that. +
AOL Server will have to be configured to run + CGI scripts, please consult + the documentation that came with your server for more information on + how to do this. +
Because AOL Server doesn't support .htaccess + files, you'll have to create a TCL + script. You should create an aolserver/modules/tcl/filter.tcl + file (the filename shouldn't matter) with the following contents (change + /bugzilla/ to the web-based path to + your Bugzilla installation): +
ns_register_filter preauth GET /bugzilla/localconfig filter_deny
+ ns_register_filter preauth GET /bugzilla/localconfig~ filter_deny
+ ns_register_filter preauth GET /bugzilla/\#localconfig\# filter_deny
+ ns_register_filter preauth GET /bugzilla/*.pl filter_deny
+ ns_register_filter preauth GET /bugzilla/syncshadowdb filter_deny
+ ns_register_filter preauth GET /bugzilla/runtests.sh filter_deny
+ ns_register_filter preauth GET /bugzilla/data/* filter_deny
+ ns_register_filter preauth GET /bugzilla/template/* filter_deny
+
+ proc filter_deny { why } {
+ ns_log Notice "filter_deny"
+ return "filter_return"
+ }
+ |
This probably doesn't account for all possible editor backup + files so you may wish to add some additional variations of + localconfig. For more information, see + bug 186383 or Bugtraq ID 6501. + |
If you are using webdot from research.att.com (the default + configuration for the webdotbase paramater), you + will need to allow access to data/webdot/*.dot + for the reasearch.att.com machine. + If you are using a local installation of GraphViz, you will need to allow + everybody to access *.png, + *.gif, *.jpg, and + *.map in the + data/webdot directory. + |
Users of Apache can skip this section because + Bugzilla ships with .htaccess files which + restrict access in the manner required. + Users of other webservers, read on. +
There are several files in the Bugzilla directory + that should not be accessible from the web. You need to configure + your webserver so they they aren't. Not doing this may reveal + sensitive information such as database passwords. +
In the main Bugzilla directory, you should:
Block: + *.pl, *localconfig*, runtests.sh +
But allow: + localconfig.js, localconfig.rdf +
In data:
Block everything
But allow: + duplicates.rdf +
In data/webdot:
If you use a remote webdot server:
Block everything
But allow + *.dot + only for the remote webdot server
Otherwise, if you use a local GraphViz:
Block everything
But allow: + *.png, *.gif, *.jpg, *.map +
And if you don't use any dot:
Block everything
In Bugzilla:
Block everything
In template:
Block everything
You should test to make sure that the files mentioned above are + not accessible from the Internet, especially your + localconfig file which contains your database + password. To test, simply point your web browser at the file; for + example, to test mozilla.org's installation, we'd try to access + http://bugzilla.mozilla.org/localconfig. You should + get a 403 Forbidden + error. +
Your Bugzilla should now be working. Access + http://<your-bugzilla-server>/ - + you should see the Bugzilla + front page. If not, consult the Troubleshooting section, + Section 2.5. +
Log in with the administrator account you defined in the last + checksetup.pl run. You should go through + the parameters on the Edit Parameters page + (see link in the footer) and see if there are any you wish to + change. + They key parameters are documented in Section 3.1; + you should certainly alter + maintainer and urlbase; + you may also want to alter + cookiepath or requirelogin. +
This would also be a good time to revisit the + localconfig file and make sure that the + names of the priorities, severities, platforms and operating systems + are those you wish to use when you start creating bugs. Remember + to rerun checksetup.pl if you change it. +
Bugzilla has several optional features which require extra + configuration. You can read about those in + Section 2.3. +
This document is copyright (c) 2000-2004 by the various + Bugzilla contributors who wrote it.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation @@ -103,29 +94,10 @@ VALIGN="TOP" Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in Appendix CAppendix D. | ||
| --Copyright (c) 2000-2004 The Bugzilla Team |
If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, diff --git a/mozilla/webtools/bugzilla/docs/html/credits.html b/mozilla/webtools/bugzilla/docs/html/credits.html index 69cac7052be..cc39bc7d3f7 100644 --- a/mozilla/webtools/bugzilla/docs/html/credits.html +++ b/mozilla/webtools/bugzilla/docs/html/credits.html @@ -7,7 +7,7 @@ NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ ">
Last but not least, all the members of the +> Also, thanks are due to the members of the
Template hooks are a way for extensions to Bugzilla to insert code + into the standard Bugzilla templates without modifying the template files + themselves. The hooks mechanism defines a consistent API for extending + the standard templates in a way that cleanly separates standard code + from extension code. Hooks reduce merge conflicts and make it easier + to write extensions that work across multiple versions of Bugzilla, + making upgrading a Bugzilla installation with installed extensions easier. +
A template hook is just a named place in a standard template file + where extension template files for that hook get processed. Each hook + has a corresponding directory in the Bugzilla directory tree. Hooking an + extension template to a hook is as simple as putting the extension file + into the hook's directory. When Bugzilla processes the standard template + and reaches the hook, it will process all extension templates in the + hook's directory. The hooks themselves can be added into any standard + template upon request by extension authors. +
To use hooks to extend a Bugzilla template, first make sure there is + a hook at the appropriate place within the template you want to extend. + Hooks appear in the standard Bugzilla templates as a single directive + in the format + [% Hook.process("name") %], + where name is the unique (within that template) + name of the hook. +
If you aren't sure which template you want to extend or just want + to browse the available hooks, either use your favorite multi-file search + tool (e.g. grep) to search the standard templates + for occurrences of Hook.process or browse + the directory tree in + BUGZILLA_ROOT/template/en/extension/hook/, + which contains a directory for each hook in the following location: +
BUGZILLA_ROOT/template/en/extension/hook/PATH_TO_STANDARD_TEMPLATE/STANDARD_TEMPLATE_NAME/HOOK_NAME/ +
If there is no hook at the appropriate place within the Bugzilla template + you want to extend, + file + a bug requesting one, specifying: +
| the template for which you are requesting a hook; |
| where in the template you would like the hook to be placed + (line number/position for latest version of template in CVS + or description of location); + |
| the purpose of the hook; |
| a link to information about your extension, if any. |
The Bugzilla reviewers will promptly review each hook request, + name the hook, add it to the template, check the new version + of the template into CVS, and create the corresponding directory in + BUGZILLA_ROOT/template/en/extension/hook/. +
You may optionally attach a patch to the bug which implements the hook + and check it in yourself after receiving approval from a Bugzilla + reviewer. The developers may suggest changes to the location of the + hook based on their analysis of your needs or so the hook can satisfy + the needs of multiple extensions, but the process of getting hooks + approved and checked in is not as stringent as the process for general + changes to Bugzilla, and any extension, whether released or still in + development, can have hooks added to meet their needs. +
After making sure the hook you need exists (or getting it added if not), + add your extension template to the directory within the Bugzilla + directory tree corresponding to the hook. +
That's it! Now, when the standard template containing the hook + is processed, your extension template will be processed at the point + where the hook appears. +
For example, let's say you have an extension named Projman that adds + project management capabilities to Bugzilla. Projman has an + administration interface edit-projects.cgi, + and you want to add a link to it into the navigation bar at the bottom + of every Bugzilla page for those users who are authorized + to administer projects. +
The navigation bar is generated by the template file + useful-links.html.tmpl, which is located in + the global/ subdirectory on the standard Bugzilla + template path + BUGZILLA_ROOT/template/en/default/. + Looking in useful-links.html.tmpl, you find + the following hook at the end of the list of standard Bugzilla + administration links: +
...
+ [% ', <a href="editkeywords.cgi">keywords</a>'
+ IF user.groups.editkeywords %]
+ [% Hook.process("edit") %]
+... |
The corresponding directory for this hook is + BUGZILLA_ROOT/template/en/extension/hook/global/useful-links.html.tmpl/edit/. +
You put a template named + projman-edit-projects.html.tmpl + into that directory with the following content: +
...[% ', <a href="edit-projects.cgi">projects</a>' IF user.groups.projman_admins %] |
Voila! The link now appears after the other administration links in the + navigation bar for users in the projman_admins group. +
Notes: +
You may want to prefix your extension template names + with the name of your extension, e.g. + projman-foo.html.tmpl, + so they do not conflict with the names of templates installed by + other extensions. +
If your extension includes entirely new templates in addition to + extensions of standard templates, it should install those new + templates into an extension-specific subdirectory of the + BUGZILLA_ROOT/template/en/extension/ + directory. The extension/ directory, like the + default/ and custom/ + directories, is part of the template search path, so putting templates + there enables them to be found by the template processor. +
The template processor looks for templates first in the + custom/ directory (i.e. templates added by the + specific installation), then in the extension/ + directory (i.e. templates added by extensions), and finally in the + default/ directory (i.e. the standard Bugzilla + templates). Thus extension templates can override standard templates, + but installation-specific templates override both. +
Note that overriding standard templates with extension templates + gives you great power but also makes upgrading an installation harder. + As with custom templates, we recommend using this functionality + sparingly and only when absolutely necessary. +
Installation customizers can also take advantage of hooks when adding + code to a Bugzilla template. To do so, create directories in + BUGZILLA_ROOT/template/en/custom/hook/ + equivalent to the directories in + BUGZILLA_ROOT/template/en/extension/hook/ + for the hooks you want to use, then place your customization templates + into those directories. +
Obviously this method of customizing Bugzilla only lets you add code + to the standard templates; you cannot change the existing code. + Nevertheless, for those customizations that only add code, this method + can reduce conflicts when merging changes, making upgrading + your customized Bugzilla installation easier. +