Skip to content

bugzilla
bugzilla
Commit 06033dc9 authored by Gervase Markham's avatar Gervase Markham
Browse files
Options

Bug 1067416 - reorganize and update Bugzilla docs.

parent 8ebd893e
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 4184 additions and 609 deletions
docs/TODO
View file @ 06033dc9
......@@ -10,3 +10,7 @@ HTML Output:
* Auto-highlighter thinks # in "bash#" is a comment char
* Style definition lists to have the term in bold
* Fix bug lifecycle image original doc link
Topics to cover:
* email_in.pl
docs/en/rst/_static/bugzilla.css
View file @ 06033dc9
@import 'default.css';
dt { font-weight: bold; }
/* Custom roles */
.param { font-weight: bold; }
.paramval { font-family: monospace; }
.group { font-family: monospace; }
.field { font-weight: bold; }
.command { font-family: monospace; font-size: 130% }
.admonition-todo {
background-color: lightpink;
border: 2px darkred solid;
}
/* Make Buggie's antenna not take up so much space */
.logo {
display: block;
margin-top: -20px;
}
docs/en/rst/about.rst deleted 100644 → 0
View file @ 8ebd893e
.. _about:
================
About This Guide
================
.. _introduction:
Introduction
############
This is the documentation for version |version| of Bugzilla, a
bug-tracking system from mozilla.org.
Bugzilla is an enterprise-class piece of software
that tracks millions of bugs and issues for hundreds of
organizations around the world.
The most current version of this document can always be found on the
`Bugzilla
Documentation Page <http://www.bugzilla.org/docs/>`_.
.. _copyright:
Copyright Information
#####################
This document is copyright (c) 2000-2014 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
License, Version 1.1 or any later version published by the
Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and with no Back-Cover Texts. A copy of
the license is included in :ref:`gfdl`.
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
please contact the Bugzilla Team.
.. _disclaimer:
Disclaimer
##########
No liability for the contents of this document can be accepted.
Follow the instructions herein at your own risk.
This document may contain errors
and inaccuracies that may damage your system, cause your partner
to leave you, your boss to fire you, your cats to
pee on your furniture and clothing, and global thermonuclear
war. Proceed with caution.
Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". We
wholeheartedly endorse the use of GNU/Linux; it is an extremely
versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
Although the Bugzilla development team has taken great care to
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 Bugzilla. You have
the source code, and are responsible for auditing it yourself to ensure
your security needs are met.
.. COMMENT: Section 2: New Versions
.. _newversions:
New Versions
############
This is version |version| of The Bugzilla Guide. It is so named
to match the current version of Bugzilla.
.. todo:: BZ-DEVEL This version of the guide, like its associated Bugzilla version, is a
development version.
The latest version of this guide can always be found at `<http://www.bugzilla.org/docs/>`_. However, you should read
the version which came with the Bugzilla release you are using.
In addition, there are Bugzilla template localization projects in
`several languages <http://www.bugzilla.org/download/#localizations>`_.
They may have translated documentation available. If you would like to
volunteer to translate the Guide into additional languages, please visit the
`Bugzilla L10n team <https://wiki.mozilla.org/Bugzilla:L10n>`_
page.
.. _credits:
Credits
#######
The people listed below have made enormous contributions to the
creation of this Guide, through their writing, dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
.. COMMENT: TODO: This is evil... there has to be a valid way to get this look
Matthew P. Barnson mbarnson@sisna.com
for the Herculean task of pulling together the Bugzilla Guide
and shepherding it to 2.14.
Terry Weissman terry@mozilla.org
for initially writing Bugzilla and creating the README upon
which the UNIX installation documentation is largely based.
Tara Hernandez tara@tequilarists.org
for keeping Bugzilla development going strong after Terry left
mozilla.org and for running landfill.
Dave Lawrence dkl@redhat.com
for providing insight into the key differences between Red
Hat's customized Bugzilla.
Dawn Endico endico@mozilla.org
for being a hacker extraordinaire and putting up with Matthew's
incessant questions and arguments on irc.mozilla.org in #mozwebtools
Jacob Steenhagen jake@bugzilla.org
for taking over documentation during the 2.17 development
period.
Dave Miller justdave@bugzilla.org
for taking over as project lead when Tara stepped down and
continually pushing for the documentation to be the best it can be.
Thanks also go to the following people for significant contributions
to this documentation:
Kevin Brannen, Vlad Dascalu, Ben FrantzDale, Eric Hanson, Zach Lipton, Gervase Markham, Andrew Pearson, Joe Robins, Spencer Smith, Ron Teitelbaum, Shane Travis, Martin Wulffeld.
Also, thanks are due to the members of the
`mozilla.support.bugzilla <news://news.mozilla.org/mozilla.support.bugzilla>`_
newsgroup (and its predecessor, netscape.public.mozilla.webtools).
Without your discussions, insight, suggestions, and patches,
this could never have happened.
.. _conventions:
Document Conventions
####################
This document uses the following conventions:
.. warning:: This is a warning - something you should be aware of.
.. note:: This is just a note, for your information.
A filename or a path to a filename is displayed like this:
:file:`/path/to/filename.ext`
A command to type in the shell is displayed like this:
:command:`command --arguments`
bash$ represents a normal user's prompt under bash shell
bash# represents a root user's prompt under bash shell
A sample of code is illustrated like this:
::
First Line of Code
Second Line of Code
...
This documentation is maintained in reStructured Text format.
Changes are best submitted as diffs, attached
to a bug filed in the `Bugzilla Documentation <https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla;component=Documentation>`_
component.
docs/en/rst/about/index.rst 0 → 100644
View file @ 06033dc9
.. _about:
========================
About This Documentation
========================
This is the documentation for version |version| of Bugzilla, a bug-tracking
system from Mozilla. Bugzilla is an enterprise-class piece of software
that tracks millions of bugs and issues for thousands of organizations around
the world.
The most current version of this document can always be found on the
`Bugzilla website <http://www.bugzilla.org/docs/>`_.
.. _evaluating:
Evaluating Bugzilla
###################
If you want to try out Bugzilla to see if it meets your needs, you can do so
on `Landfill <https://landfill.bugzilla.org/bugzilla-4.4-branch/>`_, our test
server. The `Bugzilla FAQ <https://wiki.mozilla.org/Bugzilla:FAQ>`_ may also
be helpful, as it answers a number of questions people sometimes have about
whether Bugzilla is for them.
.. _getting-help:
Getting More Help
#################
If this document does not answer your questions, we run a
`Mozilla forum <https://www.mozilla.org/about/forums/#support-bugzilla>`_
which can be accessed as a newsgroup, mailing list, or over the web as a
Google Group. Please
`search it <https://groups.google.com/forum/#!forum/mozilla.support.bugzilla>`_
first, and then ask your question there.
If you need a guaranteed response, commercial support is
`available <http://www.bugzilla.org/support/consulting.html>`_ for Bugzilla
from a number of people and organizations.
.. _conventions:
Document Conventions
####################
This document uses the following conventions:
.. warning:: This is a warning—something you should be aware of.
.. note:: This is just a note, for your information.
A filename or a path to a filename is displayed like this:
:file:`/path/to/filename.ext`
A command to type in the shell is displayed like this:
:command:`command --arguments`
A sample of code is illustrated like this:
::
First Line of Code
Second Line of Code
...
This documentation is maintained in
`reStructured Text
<http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_ format using
the `Sphinx <http://www.sphinx-doc.org/>`_ documentation system. It has
recently been rewritten, so it undoubtedly has bugs. Please file any you find, in
the `Bugzilla Documentation
<https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla;component=Documentation>`_
component in Mozilla's installation of Bugzilla. If you also want to make a
patch, that would be wonderful. Changes are best submitted as diffs, attached
to a bug. There is a :ref:`Style Guide <style-guide>` to help you write any
new text and markup.
.. _license:
License
#######
Bugzilla is `free <http://www.gnu.org/philosophy/free-sw.html>`_ and
`open source <http://opensource.org/osd>`_ software, which means (among other
things) that you can download it, install it, and run it for any purpose
whatsoever without the need for license or payment. Isn't that refreshing?
Bugzilla's code is made available under the
`Mozilla Public License 2.0 <http://www.mozilla.org/MPL/2.0/>`_ (MPL),
specifically the variant which is Incompatible with Secondary Licenses.
However, again, if you only want to install and run Bugzilla, you don't need
to worry about that; it's only relevant if you redistribute the code or any
changes you make.
Bugzilla's documentation is made available under the
`Creative Commons CC-BY-SA International License 4.0
<https://creativecommons.org/licenses/by-sa/4.0/>`_,
or any later version.
.. _credits:
Credits
#######
The people listed below have made significant contributions to the
creation of this documentation:
Andrew Pearson,
Ben FrantzDale,
Byron Jones,
Dave Lawrence,
Dave Miller,
Dawn Endico,
Eric Hanson,
Gervase Markham,
Jacob Steenhagen,
Joe Robins,
Kevin Brannen,
Martin Wulffeld,
Matthew P. Barnson,
Ron Teitelbaum,
Shane Travis,
Spencer Smith,
Tara Hernandez,
Terry Weissman,
Vlad Dascalu,
Zach Lipton.
docs/en/rst/administering/custom-fields.rst 0 → 100644
View file @ 06033dc9
.. _custom-fields:
Custom Fields
#############
Custom Fields are fields defined by the administrator, in addition to those
which come with Bugzilla by default. Custom Fields are treated like any other
field—they can be set in bugs and used for search queries.
Administrators should keep in mind that
adding too many fields can make the user interface more complicated and
harder to use. Custom Fields should be added only when necessary and with
careful consideration.
.. note:: Before adding a Custom Field, make sure that Bugzilla cannot already
do the desired behavior. Many Bugzilla options are not enabled by
default, and many times Administrators find that simply enabling
certain options that already exist is sufficient.
Administrators can manage Custom Fields using the
``Custom Fields`` link on the Administration page. The Custom
Fields administration page displays a list of Custom Fields, if any exist,
and a link to "Add a new custom field".
.. _add-custom-fields:
Adding Custom Fields
====================
To add a new Custom Field, click the "Add a new custom field" link. This
page displays several options for the new field, described below.
The following attributes must be set for each new custom field:
- *Name:*
The name of the field in the database, used internally. This name
MUST begin with ``cf_`` to prevent confusion with
standard fields. If this string is omitted, it will
be automatically added to the name entered.
- *Description:*
A brief string used as the label for this Custom Field.
That is the string that users will see, and it should be
short and explicit.
- *Type:*
The type of field to create. There are
several types available:
Bug ID:
A field where you can enter the ID of another bug from
the same Bugzilla installation. To point to a bug in a remote
installation, use the See Also field instead.
Large Text Box:
A multiple line box for entering free text.
Free Text:
A single line box for entering free text.
Multiple-Selection Box:
A list box where multiple options
can be selected. After creating this field, it must be edited
to add the selection options. See
:ref:`edit-values-list` for information about
editing legal values.
Drop Down:
A list box where only one option can be selected.
After creating this field, it must be edited to add the
selection options. See
:ref:`edit-values-list` for information about
editing legal values.
Date/Time:
A date field. This field appears with a
calendar widget for choosing the date.
- *Sortkey:*
Integer that determines in which order Custom Fields are
displayed in the User Interface, especially when viewing a bug.
Fields with lower values are displayed first.
- *Reverse Relationship Description:*
When the custom field is of type ``Bug ID``, you can
enter text here which will be used as label in the referenced
bug to list bugs which point to it. This gives you the ability
to have a mutual relationship between two bugs.
- *Can be set on bug creation:*
Boolean that determines whether this field can be set on
bug creation. If not selected, then a bug must be created
before this field can be set. See :ref:`filing`
for information about filing bugs.
- *Displayed in bugmail for new bugs:*
Boolean that determines whether the value set on this field
should appear in bugmail when the bug is filed. This attribute
has no effect if the field cannot be set on bug creation.
- *Is obsolete:*
Boolean that determines whether this field should
be displayed at all. Obsolete Custom Fields are hidden.
- *Is mandatory:*
Boolean that determines whether this field must be set.
For single and multi-select fields, this means that a (non-default)
value must be selected; for text and date fields, some text
must be entered.
- *Field only appears when:*
A custom field can be made visible when some criteria is met.
For instance, when the bug belongs to one or more products,
or when the bug is of some given severity. If left empty, then
the custom field will always be visible, in all bugs.
- *Field that controls the values that appear in this field:*
When the custom field is of type ``Drop Down`` or
``Multiple-Selection Box``, you can restrict the
availability of the values of the custom field based on the
value of another field. This criteria is independent of the
criteria used in the ``Field only appears when``
setting. For instance, you may decide that some given value
``valueY`` is only available when the bug status
is RESOLVED while the value ``valueX`` should
always be listed.
Once you have selected the field that should control the
availability of the values of this custom field, you can
edit values of this custom field to set the criteria; see
:ref:`edit-values-list`.
.. _edit-custom-fields:
Editing Custom Fields
=====================
As soon as a Custom Field is created, its name and type cannot be
changed. If this field is a drop-down menu, its legal values can
be set as described in :ref:`edit-values-list`. All
other attributes can be edited as described above.
.. _delete-custom-fields:
Deleting Custom Fields
======================
Only custom fields that are marked as obsolete, and that have never
been used, can be deleted completely (else the integrity
of the bug history would be compromised). For custom fields marked
as obsolete, a "Delete" link will appear in the ``Action``
column. If the custom field has been used in the past, the deletion
will be rejected. Marking the field as obsolete, however, is sufficient
to hide it from the user interface entirely.
docs/en/rst/administering/extensions.rst 0 → 100644
View file @ 06033dc9
.. _installed-extensions:
Installed Extensions
====================
Bugzilla can be enhanced using extensions (see :ref:`extensions`). If an
extension comes with documentation in the appropriate format, and you build
your own copy of the Bugzilla documentation using :file:`makedocs.pl`, then
the documentation for your installed extensions will show up here.
Your Bugzilla installation has the following extensions available (as of the
last time you compiled the documentation):
.. toctree::
:maxdepth: 1
:glob:
../extensions/*
docs/en/rst/administering/field-values.rst 0 → 100644
View file @ 06033dc9
.. _field-values:
Field Values
############
Legal values for the operating system, platform, bug priority and
severity, and custom fields of type ``Drop Down`` and
``Multiple-Selection Box`` (see :ref:`custom-fields`),
as well as the list of valid bug statuses and resolutions, can be
customized from the same interface. You can add, edit, disable, and
remove the values that can be used with these fields.
.. _edit-values-list:
Viewing/Editing Legal Values
============================
Editing legal values requires ``admin`` privileges.
Select "Field Values" from the Administration page. A list of all
fields, both system and Custom, for which legal values
can be edited appears. Click a field name to edit its legal values.
There is no limit to how many values a field can have, but each value
must be unique to that field. The sortkey is important to display these
values in the desired order.
When the availability of the values of a custom field is controlled
by another field, you can select from here which value of the other field
must be set for the value of the custom field to appear.
.. _edit-values-delete:
Deleting Legal Values
=====================
Legal values from Custom Fields can be deleted, but only if the
following two conditions are respected:
#. The value is not set as the default for the field.
#. No bug is currently using this value.
If any of these conditions is not respected, the value cannot be deleted.
The only way to delete these values is to reassign bugs to another value
and to set another value as default for the field.
docs/en/rst/administering/flags.rst 0 → 100644
View file @ 06033dc9
.. _flags-admin:
Flags
#####
If you have the :group:`editcomponents` permission, you can
edit Flag Types from the main administration page. Clicking the
:guilabel:`Flags` link will bring you to the :guilabel:`Administer
Flag Types` page. Here, you can select whether you want
to create (or edit) a Bug flag or an Attachment flag.
The two flag types have the same administration interface, and the interface
for creating a flag and editing a flag have the same set of fields.
.. _flags-edit:
Flag Properties
===============
Name
This is the name of the flag. This will be displayed
to Bugzilla users who are looking at or setting the flag.
The name may contain any valid Unicode characters except commas
and spaces.
Description
The description describes the flag in more detail. It is visible
in a tooltip when hovering over a flag either in the :guilabel:`Show Bug`
or :guilabel:`Edit Attachment` pages. This field can be as
long as you like and can contain any character you want.
Category
You can set a flag to be visible or not visible on any combination of
products and components.
Default behaviour for a newly created flag is to appear on all
products and all components, which is why ``__Any__:__Any__``
is already entered in the :guilabel:`Inclusions` box.
If this is not your desired behaviour, you must either set some
exclusions (for products on which you don't want the flag to appear),
or you must remove ``__Any__:__Any__`` from the :guilabel:`Inclusions` box
and define products/components specifically for this flag.
To create an Inclusion, select a Product from the top drop-down box.
You may also select a specific component from the bottom drop-down box.
(Setting ``__Any__`` for Product translates to
"all the products in this Bugzilla".
Selecting ``__Any__`` in the Component field means
"all components in the selected product.")
Selections made, press :guilabel:`Include`, and your
Product/Component pairing will show up in the :guilabel:`Inclusions` box on the right.
To create an Exclusion, the process is the same: select a Product from the
top drop-down box, select a specific component if you want one, and press
:guilabel:`Exclude`. The Product/Component pairing will show up in the
:guilabel:`Exclusions` box on the right.
This flag *will* appear and *can* be set for any
products/components appearing in the :guilabel:`Inclusions` box
(or which fall under the appropriate ``__Any__``).
This flag *will not* appear (and therefore *cannot* be set) on
any products appearing in the :guilabel:`Exclusions` box.
*IMPORTANT: Exclusions override inclusions.*
You may select a Product without selecting a specific Component,
but you cannot select a Component without a Product. If you do so,
Bugzilla will display an error message, even if all your products
have a component by that name. You will also see an error if you
select a Component that does not belong to the selected Product.
*Example:* Let's say you have a product called
``Jet Plane`` that has thousands of components. You want
to be able to ask if a problem should be fixed in the next model of
plane you release. We'll call the flag ``fixInNext``.
However, one component in ``Jet Plane`` is
called ``Pilot``, and it doesn't make sense to release a
new pilot, so you don't want to have the flag show up in that component.
So, you include ``Jet Plane:__Any__`` and you exclude
``Jet Plane:Pilot``.
Sort Key
Flags normally show up in alphabetical order. If you want them to
show up in a different order, you can use this key set the order on each flag.
Flags with a lower sort key will appear before flags with a higher
sort key. Flags that have the same sort key will be sorted alphabetically.
Active
Sometimes you might want to keep old flag information in the
Bugzilla database but stop users from setting any new flags of this type.
To do this, uncheck :guilabel:`active`. Deactivated
flags will still show up in the UI if they are ``?``, ``+``, or ``-``, but
they may only be cleared (unset) and cannot be changed to a new value.
Once a deactivated flag is cleared, it will completely disappear from a
bug/attachment and cannot be set again.
Requestable
New flags are, by default, "requestable", meaning that they
offer users the ``?`` option, as well as ``+``
and ``-``.
To remove the ``?`` option, uncheck "requestable".
Specifically Requestable
By default this box is checked for new flags, meaning that users may make
flag requests of specific individuals. Unchecking this box will remove the
text box next to a flag; if it is still requestable, then requests
cannot target specific users and are open to anyone (called a
request "to the wind" in Bugzilla). Removing this after specific
requests have been made will not remove those requests; that data will
stay in the database (though it will no longer appear to the user).
Multiplicable
Any flag with :guilabel:`Multiplicable:guilabel:` set (default for new flags
is 'on') may be set more than once. After being set once, an unset flag
of the same type will appear below it with "addl." (short for
"additional") before the name. There is no limit to the number of
times a Multiplicable flags may be set on the same bug/attachment.
CC List
If you want certain users to be notified every time this flag is
set to ``?``, ``-``, or ``+``, or is unset, add them here. This is a comma-separated
list of email addresses that need not be restricted to Bugzilla usernames.
Grant Group
When this field is set to some given group, only users in the group
can set the flag to ``+`` and ``-``. This
field does not affect who can request or cancel the flag. For that,
see the :guilabel:`Request Group` field below. If this field
is left blank, all users can set or delete this flag. This field is
useful for restricting which users can approve or reject requests.
Request Group
When this field is set to some given group, only users in the group
can request or cancel this flag. Note that this field has no effect
if the :guilabel:`Grant Group` field is empty. You can set the
value of this field to a different group, but both fields have to be
set to a group for this field to have an effect.
.. _flags-delete:
Deleting a Flag
===============
When you are at the :guilabel:`Administer Flag Types` screen,
you will be presented with a list of Bug flags and a list of Attachment
Flags.
To delete a flag, click on the :guilabel:`Delete` link next to
the flag description.
.. warning:: Once you delete a flag, it is *gone* from
your Bugzilla. All the data for that flag will be deleted.
Everywhere that flag was set, it will disappear,
and you cannot get that data back. If you want to keep flag data,
but don't want anybody to set any new flags or change current flags,
unset :guilabel:`active` in the flag Edit form.
docs/en/rst/administering/groups.rst 0 → 100644
View file @ 06033dc9
.. _groups:
Groups and Security
###################
Groups allow for separating bugs into logical divisions.
Groups are typically used
to isolate bugs that should only be seen by certain people. For
example, a company might create a different group for each one of its customers
or partners. Group permissions could be set so that each partner or customer would
only have access to their own bugs. Or, groups might be used to create
variable access controls for different departments within an organization.
Another common use of groups is to associate groups with products,
creating isolation and access control on a per-product basis.
Groups and group behaviors are controlled in several places:
#. The group configuration page. To view or edit existing groups, or to
create new groups, access the "Groups" link from the "Administration"
page. This section of the manual deals primarily with the aspect of
group controls accessed on this page.
#. Global configuration parameters. Bugzilla has several parameters
that control the overall default group behavior and restriction
levels. For more information on the parameters that control
group behavior globally, see :ref:`param-group-security`.
#. Product association with groups. Most of the functionality of groups
and group security is controlled at the product level. Some aspects
of group access controls for products are discussed in this section,
but for more detail see :ref:`product-group-controls`.
#. Group access for users. See :ref:`users-and-groups` for
details on how users are assigned group access.
Group permissions are such that if a bug belongs to a group, only members
of that group can see the bug. If a bug is in more than one group, only
members of *all* the groups that the bug is in can see
the bug. For information on granting read-only access to certain people and
full edit access to others, see :ref:`product-group-controls`.
.. note:: By default, bugs can also be seen by the Assignee, the Reporter, and
everyone on the CC List, regardless of whether or not the bug would
typically be viewable by them. Visibility to the Reporter and CC List can
be overridden (on a per-bug basis) by bringing up the bug, finding the
section that starts with ``Users in the roles selected below...``
and un-checking the box next to either 'Reporter' or 'CC List' (or both).
.. _create-groups:
Creating Groups
===============
To create a new group, follow the steps below:
#. Select the ``Administration`` link in the page footer,
and then select the ``Groups`` link from the
Administration page.
#. A table of all the existing groups is displayed. Below the table is a
description of all the fields. To create a new group, select the
``Add Group`` link under the table of existing groups.
#. There are five fields to fill out. These fields are documented below
the form. Choose a name and description for the group. Decide whether
this group should be used for bugs (in all likelihood this should be
selected). Optionally, choose a regular expression that will
automatically add any matching users to the group, and choose an
icon that will help identify user comments for the group. The regular
expression can be useful, for example, to automatically put all users
from the same company into one group (if the group is for a specific
customer or partner).
.. note:: If ``User RegExp`` is filled out, users whose email
addresses match the regular expression will automatically be
members of the group as long as their email addresses continue
to match the regular expression. If their email address changes
and no longer matches the regular expression, they will be removed
from the group. Versions 2.16 and older of Bugzilla did not automatically
remove users whose email addresses no longer matched the RegExp.
.. warning:: If specifying a domain in the regular expression, end
the regexp with a "$". Otherwise, when granting access to
"@mycompany\\.com", access will also be granted to
'badperson@mycompany.com.cracker.net'. Use the syntax,
'@mycompany\\.com$' for the regular expression.
#. After the new group is created, it can be edited for additional options.
The "Edit Group" page allows for specifying other groups that should be included
in this group and which groups should be permitted to add and delete
users from this group. For more details, see :ref:`edit-groups`.
.. _edit-groups:
Editing Groups and Assigning Group Permissions
==============================================
To access the "Edit Groups" page, select the
``Administration`` link in the page footer,
and then select the ``Groups`` link from the Administration page.
A table of all the existing groups is displayed. Click on a group name
you wish to edit or control permissions for.
The "Edit Groups" page contains the same five fields present when
creating a new group. Below that are two additional sections, "Group
Permissions" and "Mass Remove". The "Mass Remove" option simply removes
all users from the group who match the regular expression entered. The
"Group Permissions" section requires further explanation.
The "Group Permissions" section on the "Edit Groups" page contains four sets
of permissions that control the relationship of this group to other
groups. If the :param:`usevisibilitygroups` parameter is in use (see
:ref:`parameters`) two additional sets of permissions are displayed.
Each set consists of two select boxes. On the left, a select box
with a list of all existing groups. On the right, a select box listing
all groups currently selected for this permission setting (this box will
be empty for new groups). The way these controls allow groups to relate
to one another is called *inheritance*.
Each of the six permissions is described below.
*Groups That Are a Member of This Group*
Members of any groups selected here will automatically have
membership in this group. In other words, members of any selected
group will inherit membership in this group.
*Groups That This Group Is a Member Of*
Members of this group will inherit membership to any group
selected here. For example, suppose the group being edited is
an Admin group. If there are two products (Product1 and Product2)
and each product has its
own group (Group1 and Group2), and the Admin group
should have access to both products,
simply select both Group1 and Group2 here.
*Groups That Can Grant Membership in This Group*
The members of any group selected here will be able add users
to this group, even if they themselves are not in this group.
*Groups That This Group Can Grant Membership In*
Members of this group can add users to any group selected here,
even if they themselves are not in the selected groups.
*Groups That Can See This Group*
Members of any selected group can see the users in this group.
This setting is only visible if the :param:`usevisibilitygroups` parameter
is enabled on the Bugzilla Configuration page. See
:ref:`parameters` for information on configuring Bugzilla.
*Groups That This Group Can See*
Members of this group can see members in any of the selected groups.
This setting is only visible if the :param:`usevisibilitygroups` parameter
is enabled on the the Bugzilla Configuration page. See
:ref:`parameters` for information on configuring Bugzilla.
.. _users-and-groups:
Assigning Users to Groups
=========================
A User can become a member of a group in several ways:
#. The user can be explicitly placed in the group by editing
the user's profile. This can be done by accessing the "Users" page
from the "Administration" page. Use the search form to find the user
you want to edit group membership for, and click on their email
address in the search results to edit their profile. The profile
page lists all the groups and indicates if the user is a member of
the group either directly or indirectly. More information on indirect
group membership is below. For more details on User Administration,
see :ref:`users`.
#. The group can include another group of which the user is
a member. This is indicated by square brackets around the checkbox
next to the group name in the user's profile.
See :ref:`edit-groups` for details on group inheritance.
#. The user's email address can match the regular expression
that has been specified to automatically grant membership to
the group. This is indicated by "\*" around the check box by the
group name in the user's profile.
See :ref:`create-groups` for details on
the regular expression option when creating groups.
Assigning Group Controls to Products
====================================
The primary functionality of groups is derived from the relationship of
groups to products. The concepts around segregating access to bugs with
product group controls can be confusing. For details and examples on this
topic, see :ref:`product-group-controls`.
docs/en/rst/administering/index.rst 0 → 100644
View file @ 06033dc9
.. _administering:
====================
Administration Guide
====================
For those with :group:`admin` privileges, Bugzilla can be administered using
the :guilabel:`Administration` link in the header. The administrative
controls are divided into several sections:
.. toctree::
:maxdepth: 2
parameters
preferences
users
categorization
flags
custom-fields
field-values
workflow
groups
keywords
whining
quips
extensions
docs/en/rst/administering/keywords.rst 0 → 100644
View file @ 06033dc9
.. _keywords:
Keywords
########
The administrator can define keywords which can be used to tag and
categorise bugs. For example, the keyword "regression" is commonly used.
A company might have a policy stating all regressions
must be fixed by the next release—this keyword can make tracking those
bugs much easier. Keywords are global, rather than per product.
Keywords can be created, edited, or deleted by clicking the "Keywords"
link in the admin page. There are two fields for each keyword—the keyword
itself and a brief description. Currently keywords cannot be marked obsolete
to prevent future usage.
docs/en/rst/administering/preferences.rst 0 → 100644
View file @ 06033dc9
.. _default-preferences:
Default Preferences
###################
Each user of Bugzilla can set certain preferences about how they want
Bugzilla to behave. Here, you can say whether or not each of the possible
preferences is available to the user and, if it is, what the default value
is.
docs/en/rst/administering/quips.rst 0 → 100644
View file @ 06033dc9
.. _quips:
Quips
#####
Quips are small user-defined messages (often quotes or witty sayings) that
can be configured to appear at the top of search results. Each Bugzilla
installation has its own specific quips. Whenever a quip needs to be
displayed, a random selection is made from the pool of already existing quips.
Quip submission is controlled by :param:`quip_list_entry_control`
parameter. It has several possible values: open, moderated, or closed.
In order to enable quips approval you need to set this parameter to
"moderated". In this way, users are free to submit quips for addition,
but an administrator must explicitly approve them before they are
actually used.
In order to see the user interface for the quips, you can
click on a quip when it is displayed together with the search
results. You can also go directly to the quips.cgi URL
(prefixed with the usual web location of the Bugzilla installation).
Once the quip interface is displayed, the "view and edit the whole
quip list" link takes you to the quips administration page, which
lists all quips available in the database.
Next to each quip there is a checkbox, under the
"Approved" column. Quips that have this checkbox checked are
already approved and will appear next to the search results.
The ones that have it unchecked are still preserved in the
database but will not appear on search results pages.
User submitted quips have initially the checkbox unchecked.
Also, there is a delete link next to each quip,
which can be used in order to permanently delete a quip.
Display of quips is controlled by the *display_quips*
user preference. Possible values are "on" and "off".
docs/en/rst/administering/users.rst 0 → 100644
View file @ 06033dc9
.. _users:
Users
#####
.. _defaultuser:
Creating Admin Users
====================
When you first run checksetup.pl after installing Bugzilla, it will
prompt you for the username (email address) and password for the first
admin user. If for some reason you delete all the admin users,
re-running checksetup.pl will again prompt you for a username and
password and make a new admin.
If you wish to add more administrative users, add them to the "admin" group.
.. _user-account-search:
Searching For Users
===================
If you have ``editusers`` privileges or if you are allowed
to grant privileges for some groups, the :guilabel:`Users` link
will appear in the Administration page.
The first screen is a search form to search for existing user
accounts. You can run searches based either on the user ID, real
name or login name (i.e. the email address, or just the first part
of the email address if the :param:`emailsuffix` parameter is set).
The search can be conducted
in different ways using the listbox to the right of the text entry
box. You can match by case-insensitive substring (the default),
regular expression, a *reverse* regular expression
match (which finds every user name which does NOT match the regular
expression), or the exact string if you know exactly who you are
looking for. The search can be restricted to users who are in a
specific group. By default, the restriction is turned off.
The search returns a list of
users matching your criteria. User properties can be edited by clicking
the login name. The Account History of a user can be viewed by clicking
the "View" link in the Account History column. The Account History
displays changes that have been made to the user account, the time of
the change and the user who made the change. For example, the Account
History page will display details of when a user was added or removed
from a group.
.. _modifyusers:
Modifying Users
===============
Once you have found your user, you can change the following
fields:
- *Login Name*:
This is generally the user's full email address. However, if you
have are using the :param:`emailsuffix` parameter, this may
just be the user's login name. Unless you turn off the
:param:`allowemailchange` parameter, users can change their
login names themselves (to any valid email address).
- *Real Name*: The user's real name. Note that
Bugzilla does not require this to create an account.
- *Password*:
You can change the user's password here. Users can automatically
request a new password, so you shouldn't need to do this often.
If you want to disable an account, see Disable Text below.
- *Bugmail Disabled*:
Mark this checkbox to disable bugmail and whinemail completely
for this account. This checkbox replaces the data/nomail file
which existed in older versions of Bugzilla.
- *Disable Text*:
If you type anything in this box, including just a space, the
user is prevented from logging in and from making any changes to
bugs via the web interface.
The HTML you type in this box is presented to the user when
they attempt to perform these actions and should explain
why the account was disabled.
Users with disabled accounts will continue to receive
mail from Bugzilla; furthermore, they will not be able
to log in themselves to change their own preferences and
stop it. If you want an account (disabled or active) to
stop receiving mail, simply check the
``Bugmail Disabled`` checkbox above.
.. note:: Even users whose accounts have been disabled can still
submit bugs via the email gateway, if one exists.
The email gateway should *not* be
enabled for secure installations of Bugzilla.
.. warning:: Don't disable all the administrator accounts!
- *<groupname>*:
If you have created some groups, e.g. "securitysensitive", then
checkboxes will appear here to allow you to add users to, or
remove them from, these groups. The first checkbox gives the
user the ability to add and remove other users as members of
this group. The second checkbox adds the user himself as a member
of the group.
- *canconfirm*:
This field is only used if you have enabled the "unconfirmed"
status. If you enable this for a user,
that user can then move bugs from "Unconfirmed" to a "Confirmed"
status (e.g.: "New" status).
- *creategroups*:
This option will allow a user to create and destroy groups in
Bugzilla.
- *editbugs*:
Unless a user has this bit set, they can only edit those bugs
for which they are the assignee or the reporter. Even if this
option is unchecked, users can still add comments to bugs.
- *editcomponents*:
This flag allows a user to create new products and components,
modify existing products and components, and destroy those that have
no bugs associated with them. If a product or component has bugs
associated with it, those bugs must be moved to a different product
or component before Bugzilla will allow them to be destroyed.
- *editkeywords*:
If you use Bugzilla's keyword functionality, enabling this
feature allows a user to create and destroy keywords. A keyword
must be removed from any bugs upon which it is currently set
before it can be destroyed.
- *editusers*:
This flag allows a user to do what you're doing right now: edit
other users. This will allow those with the right to do so to
remove administrator privileges from other users or grant them to
themselves. Enable with care.
- *tweakparams*:
This flag allows a user to change Bugzilla's Params
(using :file:`editparams.cgi`.)
- *<productname>*:
This allows an administrator to specify the products
in which a user can see bugs. If you turn on the
:param:`makeproductgroups` parameter in
the Group Security Panel in the Parameters page,
then Bugzilla creates one group per product (at the time you create
the product), and this group has exactly the same name as the
product itself. Note that for products that already exist when
the parameter is turned on, the corresponding group will not be
created. The user must still have the :group:`editbugs`
privilege to edit bugs in these products.
.. _createnewusers:
Creating New Users
==================
.. _self-registration:
Self-Registration
-----------------
By default, users can create their own user accounts by clicking the
``New Account`` link at the bottom of each page (assuming
they aren't logged in as someone else already). If you want to disable
this self-registration, or if you want to restrict who can create their
own user account, you have to edit the :param:`createemailregexp`
parameter in the ``Configuration`` page; see
:ref:`parameters`.
.. _user-account-creation:
Administrator Registration
--------------------------
Users with ``editusers`` privileges, such as administrators,
can create user accounts for other users:
#. After logging in, click the "Users" link at the footer of
the query page, and then click "Add a new user".
#. Fill out the form presented. This page is self-explanatory.
When done, click "Submit".
.. note:: Adding a user this way will *not*
send an email informing them of their username and password.
While useful for creating dummy accounts (watchers which
shuttle mail to another system, for instance, or email
addresses which are a mailing list), in general it is
preferable to log out and use the ``New Account``
button to create users, as it will pre-populate all the
required fields and also notify the user of her account name
and password.
.. _user-account-deletion:
Deleting Users
==============
If the :param:`allowuserdeletion` parameter is turned on (see
:ref:`parameters`) then you can also delete user accounts.
Note that, most of the time, this is not the best thing to do. If only
a warning in a yellow box is displayed, then the deletion is safe.
If a warning is also displayed in a red box, then you should NOT try
to delete the user account, else you will get referential integrity
problems in your database, which can lead to unexpected behavior,
such as bugs not appearing in bug lists anymore, or data displaying
incorrectly. You have been warned!
.. _impersonatingusers:
Impersonating Users
===================
There may be times when an administrator would like to do something as
another user. The :command:`sudo` feature may be used to do
this.
.. note:: To use the sudo feature, you must be in the
*bz_sudoers* group. By default, all
administrators are in this group.
If you have access to this feature, you may start a session by
going to the Edit Users page, Searching for a user and clicking on
their login. You should see a link below their login name titled
"Impersonate this user". Click on the link. This will take you
to a page where you will see a description of the feature and
instructions for using it. After reading the text, simply
enter the login of the user you would like to impersonate, provide
a short message explaining why you are doing this, and press the
button.
As long as you are using this feature, everything you do will be done
as if you were logged in as the user you are impersonating.
.. warning:: The user you are impersonating will not be told about what you are
doing. If you do anything that results in mail being sent, that
mail will appear to be from the user you are impersonating. You
should be extremely careful while using this feature.
docs/en/rst/administering/whining.rst 0 → 100644
View file @ 06033dc9
.. _whining:
Whining
#######
Whining is a feature in Bugzilla that can regularly annoy users at
specified times. Using this feature, users can execute saved searches
at specific times (e.g. the 15th of the month at midnight) or at
regular intervals (e.g. every 15 minutes on Sundays). The results of the
searches are sent to the user, either as a single email or as one email
per bug, along with some descriptive text.
.. warning:: Throughout this section it will be assumed that all users are members
of the bz_canusewhines group, membership in which is required in order
to use the Whining system. You can easily make all users members of
the bz_canusewhines group by setting the User RegExp to ".*" (without
the quotes).
Also worth noting is the bz_canusewhineatothers group. Members of this
group can create whines for any user or group in Bugzilla using an
extended form of the whining interface. Features only available to
members of the bz_canusewhineatothers group will be noted in the
appropriate places.
.. note:: For whining to work, a special Perl script must be executed at regular
intervals. More information on this is available in :ref:`installation-whining`.
.. note:: This section does not cover the whineatnews.pl script.
See :ref:`installation-whining-cron` for more information on
The Whining Cron.
.. _whining-overview:
The Event
=========
The whining system defines an "Event" as one or more queries being
executed at regular intervals, with the results of said queries (if
there are any) being emailed to the user. Events are created by
clicking on the "Add new event" button.
Once a new event is created, the first thing to set is the "Email
subject line". The contents of this field will be used in the subject
line of every email generated by this event. In addition to setting a
subject, space is provided to enter some descriptive text that will be
included at the top of each message (to help you in understanding why
you received the email in the first place).
The next step is to specify when the Event is to be run (the Schedule)
and what searches are to be performed (the Searches).
.. _whining-schedule:
Whining Schedule
================
Each whining event is associated with zero or more schedules. A
schedule is used to specify when the search (specified below) is to be
run. A new event starts out with no schedules (which means it will
never run, as it is not scheduled to run). To add a schedule, press
the "Add a new schedule" button.
Each schedule includes an interval, which you use to tell Bugzilla
when the event should be run. An event can be run on certain days of
the week, certain days of the month, during weekdays (defined as
Monday through Friday), or every day.
.. warning:: Be careful if you set your event to run on the 29th, 30th, or 31st of
the month, as your event may not run exactly when expected. If you
want your event to run on the last day of the month, select "Last day
of the month" as the interval.
Once you have specified the day(s) on which the event is to be run, you
should now specify the time at which the event is to be run. You can
have the event run at a certain hour on the specified day(s), or
every hour, half-hour, or quarter-hour on the specified day(s).
If a single schedule does not execute an event as many times as you
would want, you can create another schedule for the same event. For
example, if you want to run an event on days whose numbers are
divisible by seven, you would need to add four schedules to the event,
setting the schedules to run on the 7th, 14th, 21st, and 28th (one day
per schedule) at whatever time (or times) you choose.
.. note:: If you are a member of the bz_canusewhineatothers group, then you
will be presented with another option: "Mail to". Using this you
can control who will receive the emails generated by this event. You
can choose to send the emails to a single user (identified by email
address) or a single group (identified by group name). To send to
multiple users or groups, create a new schedule for each additional
user/group.
.. _whining-query:
Whining Searches
================
Each whining event is associated with zero or more searches. A search
is any saved search to be run as part of the specified schedule (see
above). You start out without any searches associated with the event
(which means that the event will not run, as there will never be any
results to return). To add a search, press the "Add a search" button.
The first field to examine in your newly added search is the Sort field.
Searches are run, and results included, in the order specified by the
Sort field. Searches with smaller Sort values will run before searches
with bigger Sort values.
The next field to examine is the Search field. This is where you
choose the actual search that is to be run. Instead of defining search
parameters here, you are asked to choose from the list of saved
searches (the same list that appears at the bottom of every Bugzilla
page). You are only allowed to choose from searches that you have
saved yourself (the default saved search, "My Bugs", is not a valid
choice). If you do not have any saved searches, you can take this
opportunity to create one (see :ref:`list`).
.. note:: When running searches, the whining system acts as if you are the user
executing the search. This means that the whining system will ignore
bugs that match your search but that you cannot access.
Once you have chosen the saved search to be executed, give the search a
descriptive title. This title will appear in the email, above the
results of the search. If you choose "One message per bug", the search
title will appear at the top of each email that contains a bug matching
your search.
Finally, decide if the results of the search should be sent in a single
email, or if each bug should appear in its own email.
.. warning:: Think carefully before checking the "One message per bug" box. If
you create a search that matches thousands of bugs, you will receive
thousands of emails!
Saving Your Changes
===================
Once you have defined at least one schedule and created at least one
search, go ahead and "Update/Commit". This will save your Event and make
it available for immediate execution.
.. note:: If you ever feel like deleting your event, you may do so using the
"Remove Event" button in the upper-right corner of each Event. You
can also modify an existing event, so long as you "Update/Commit"
after completing your modifications.
docs/en/rst/administering/workflow.rst 0 → 100644
View file @ 06033dc9
.. _workflow:
Workflow
########
The bug status workflow—which statuses are valid transitions from which
other statuses—can be customized.
You need to begin by defining the statuses and resolutions you want to use
(see :ref:`field-values`). By convention, these are in all capital letters.
Only one bug status, UNCONFIRMED, can never be renamed nor deleted. However,
it can be disabled entirely on a per-product basis (see :ref:`categorization`).
The status referred to by the :param:`duplicate_or_move_bug_status` parameter, if
set, is also undeletable. To make it deletable,
simply set the value of that parameter to a different status.
Aside from the empty value, two resolutions, DUPLICATE and FIXED, cannot be
renamed or deleted. (FIXED could be if we fixed
`bug 1007605 <https://bugzilla.mozilla.org/show_bug.cgi?id=1007605>`_.)
Once you have defined your statuses, you can configure the workflow of
how a bug moves between them. The workflow configuration
page displays all existing bug statuses twice: first on the left for the
starting status, and on the top for the target status in the transition.
If the checkbox is checked, then the transition from the left to the top
status is legal; if it's unchecked, that transition is forbidden.
The status used as the :param:`duplicate_or_move_bug_status` parameter
(normally RESOLVED or its equivalent) is required to be a legal transition
from every other bug status, and so this is enforced on the page.
The "View Comments Required on Status Transitions" link below the table
lets you set which transitions require a comment from the user.
docs/en/rst/api.rst deleted 100644 → 0
View file @ 8ebd893e
WebService API
==============
This Bugzilla installation has the following WebService APIs available
(as of the last time you compiled the documentation):
.. toctree::
:glob:
api/core/v*/index*
api/extensions/*/v*/index*
docs/en/rst/api/index.rst 0 → 100644
View file @ 06033dc9
.. _apis:
WebService API Reference
========================
This Bugzilla installation has the following WebService APIs available
(as of the last time you compiled the documentation):
.. toctree::
:glob:
core/v*/index*
extensions/*/v*/index*
docs/en/rst/conf.py
View file @ 06033dc9
......@@ -25,7 +25,7 @@ needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.todo']
extensions = ['sphinx.ext.todo', 'sphinx.ext.extlinks']
if tags.has('enable_rst2pdf'):
extensions.append('rst2pdf.pdfbuilder')
......@@ -78,7 +78,7 @@ for line in open("../../../Bugzilla/Constants.pm"):
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
exclude_patterns = ['**.inc.rst']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
......@@ -100,6 +100,29 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
rst_prolog = """
.. role:: param
:class: param
.. role:: paramval
:class: paramval
.. role:: group
:class: group
.. role:: field
:class: field
.. |min-perl-ver| replace:: 5.10.1
"""
rst_epilog = """
----------
This documentation undoubtedly has bugs; if you find some, please file
them `here <https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation>`_.
"""
# -- Options for HTML output ---------------------------------------------------
......@@ -126,7 +149,7 @@ html_style = "bugzilla.css"
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = "../images/bugzilla.png"
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
......@@ -158,7 +181,7 @@ html_use_smartypants = False
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
html_use_index = False
# If true, the index is split into individual pages for each letter.
#html_split_index = False
......@@ -170,7 +193,7 @@ html_show_sourcelink = False
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
html_show_copyright = False
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
......@@ -183,7 +206,6 @@ html_show_sourcelink = False
# Output file base name for HTML help builder.
htmlhelp_basename = 'Bugzilladoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
......@@ -258,11 +280,6 @@ texinfo_documents = [
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# Global substitutions and other markup required in every page
rst_epilog = """
.. |min-perl-ver| replace:: 5.10.1
"""
# -- Options for PDF output --------------------------------------------------
# Grouping the document tree into PDF files. List of tuples
......@@ -360,3 +377,10 @@ pdf_use_numbered_links = True
# Background images fitting mode
pdf_fit_background_mode = 'scale'
# -- Options for Sphinx extensions -------------------------------------------
# Temporary highlighting of TODO items
todo_include_todos = False
extlinks = {'bug': ('https://bugzilla.mozilla.org/show_bug.cgi?id=%s', 'bug ')}
docs/en/rst/extensions.rst deleted 100644 → 0
View file @ 8ebd893e
Extensions
==========
Your Bugzilla installation has the following extensions available (as of the
last time you compiled the documentation):
.. toctree::
:glob:
extensions/*/*
docs/en/rst/index.rst
View file @ 06033dc9
.. Bugzilla documentation master file, created by
sphinx-quickstart on Tue Sep 3 16:11:00 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
======================
Bugzilla Documentation
======================
.. toctree::
:maxdepth: 3
:numbered:
:maxdepth: 1
:numbered: 4
about/index
using/index
installing/index
administering/index
integrating/index
api/index
.. toctree::
:hidden:
installing/mysql
installing/postgresql
installing/oracle
installing/sqlite
.. toctree::
:hidden:
installing/apache
installing/apache-windows
installing/iis
about
installation
administration
security
using
extensions
api
customization
patches
troubleshooting
modules
gfdl
.. todolist::
docs/en/rst/installing/apache-windows.rst 0 → 100644
View file @ 06033dc9
.. _apache-windows:
Apache
######
These instructions require editing the Apache configuration file, which is
at :file:`C:\\Program Files\\Apache Group\\Apache2\\conf\\httpd.conf`.
Installing
==========
Download the Apache HTTP Server, version 2.2.x or higher, from
`the Apache website <http://httpd.apache.org/download.cgi>`_.
Apache uses a standard Windows installer. Just follow the prompts, making sure
you "Install for All Users". Be aware the Apache will always install itself
into an :file:`Apache2` directory under what ever path you specify. The
default install path will be displayed as
:file:`C:\\Program Files\\Apache Group`, which will result in Apache being
installed to :file:`C:\\Program Files\\Apache Group\\Apache2`.
If you are already running IIS on your machine, you must configure Apache to
run on a port other than 80, which IIS is using. However you aren't asked the
port to listen on at install time. Choose "All Users" (which says port 80),
and we'll change the port later.
The remainder of this document assumes you have installed Apache into
the default location, :file:`C:\\Program Files\\Apache Group\\Apache2`.
Apache Account Permissions
==========================
By default Apache installs itself to run as the SYSTEM account. For security
reasons it's better the reconfigure the service to run as an Apache user.
Create a new Windows user that is a member of **no** groups, and reconfigure
the Apache2 service to run as that account.
Whichever account you are running Apache as, SYSTEM or otherwise, needs write
and modify access to the following directories and all their subdirectories.
Depending on your version of Windows, this access may already be granted.
* :file:`C:\\Bugzilla\\data`
* :file:`C:\\Program Files\\Apache Group\\Apache2\\logs`
* :file:`C:\\Temp`
* :file:`C:\\Windows\\Temp`
Note that :file:`C:\\Bugzilla\\data` is created the first time you run
:file:`checksetup.pl`.
Port and DocumentRoot
=====================
Edit the Apache configuration file (see above).
If you need to change the port that Apache runs on (listens on, or binds to),
for example because another web server such as IIS is running on the same
machine, edit the ``Listen`` option and change the value after the colon.
Change the ``DocumentRoot`` setting to point to :file:`C:/Bugzilla`. There
are two locations in :file:`httpd.conf` that need to be updated (search for
``DocumentRoot``). You need to use ``/`` instead of ``\`` as a path separator.
Enable CGI Support
==================
Edit the Apache configuration file (see above).
To enable CGI support in Apache, you need to enable the CGI handler, by
uncommenting the ``AddHandler cgi-script .cgi`` line.
Teach Apache About Bugzilla
===========================
Edit the Apache configuration file (see above).
Add the following stanza:
.. code-block:: apache
<Directory "C:/Bugzilla">
ScriptInterpreterSource Registry-Strict
Options +ExecCGI +FollowSymLinks
DirectoryIndex index.cgi index.html
AllowOverride Limit FileInfo Indexes Options
</Directory>
In order for ``ScriptInterpreterSource Registry-Strict`` to work, you also
need to add an entry to the Registry so Apache will use Perl to execute .cgi
files.
Create a key ``HKEY_CLASSES_ROOT\.cgi\Shell\ExecCGI\Command`` with the
default value of the full path of :file:`perl.exe` with a ``-T`` parameter.
For example :file:`C:\\Perl\\bin\\perl.exe -T`.
Logging
=======
Unless you want to keep statistics on how many hits your Bugzilla install is
getting, it's a good idea to disable logging by commenting out the
``CustomLog`` directive in the Apache config file.
If you don't disable logging, you should at least disable logging of "query
strings". When external systems interact with Bugzilla via webservices
(REST/XMLRPC/JSONRPC) they include the user's credentials as part of the URL
(in the query string). Therefore, to avoid storing passwords in clear text
on the server we recommend configuring Apache to not include the query string
in its log files.
#. Find the following line in the Apache config file, which defines the
logging format for ``vhost_combined``:
.. code-block:: apache
LogFormat "%v:%p %h %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined
#. Replace ``%r`` with ``%m %U``.
(If you have configured Apache differently, a different log line might apply.
Adjust these instructions accordingly.)
Restart Apache
==============
Finally, restart Apache to get it pick up the changes:
:command:`net stop apache2`
:command:`net start apache2`
docs/en/rst/installing/apache.rst 0 → 100644
View file @ 06033dc9
.. This document is shared among all non-Windows OSes.
.. _apache:
Apache
######
You have two options for running Bugzilla under Apache - mod_cgi (the
default) and mod_perl. mod_perl is faster but takes more resources. You
should probably only consider mod_perl if your Bugzilla is going to be heavily
used.
These instructions require editing the Apache configuration file, which is:
* Fedora/Red Hat: :file:`/etc/httpd/conf/httpd.conf`
* Debian/Ubuntu: :file:`/etc/apache2/apache2.conf`
* Mac OS X: :file:`/etc/apache2/httpd.conf`
Alternatively, on Debian or Ubuntu, you can instead put the below code into a
separate file in the directory :file:`/etc/apache2/sites-enabled/`.
In these instructions, when asked to restart Apache, the command is:
:command:`sudo apachectl start`
(or run it as root if your OS installation does not use sudo).
Securing Apache
===============
When external systems interact with Bugzilla via webservices
(REST/XMLRPC/JSONRPC) they include the user's credentials as part of the URL
(in the "query string"). Therefore, to avoid storing passwords in clear text
on the server we recommend configuring Apache to not include the query string
in its log files.
#. Edit the Apache configuration file (see above).
#. Find the following line in the above mentioned file, which defines the
logging format for ``vhost_combined``:
.. code-block:: apache
LogFormat "%v:%p %h %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined
#. Replace ``%r`` with ``%m %U``.
#. Restart Apache.
.. _apache-mod_cgi:
Apache with mod_cgi
===================
To configure your Apache web server to work with Bugzilla while using
mod_cgi, do the following:
#. Edit the Apache configuration file (see above).
#. Create a ``<Directory>`` directive that applies to the location
of your Bugzilla installation. In this example, Bugzilla has
been installed at :file:`/var/www/html/bugzilla`. On Mac OS X, use
:file:`/Library/WebServer/Documents/bugzilla`.
.. code-block:: apache
<Directory /var/www/html/bugzilla>
AddHandler cgi-script .cgi
Options +ExecCGI +FollowSymLinks
DirectoryIndex index.cgi index.html
AllowOverride Limit FileInfo Indexes Options
</Directory>
These instructions allow Apache to run .cgi files found within the Bugzilla
directory; instructs the server to look for a file called :file:`index.cgi`
or, if not found, :file:`index.html` if someone only types the directory name
into the browser; and allows Bugzilla's :file:`.htaccess` files to override
some global permissions.
.. _apache-mod_perl:
Apache with mod_perl
====================
Some configuration is required to make Bugzilla work with Apache
and mod_perl.
.. note:: It is not known whether anyone has even tried mod_perl on Mac OS X.
#. Edit the Apache configuration file (see above).
#. Add the following information, substituting where appropriate with your
own local paths.
.. code-block:: apache
PerlSwitches -w -T
PerlConfigRequire /var/www/html/bugzilla/mod_perl.pl
.. note:: This should be used instead of the <Directory> block
shown above. This should also be above any other ``mod_perl``
directives within the :file:`httpd.conf` and the directives must be
specified in the order above.
.. warning:: You should also ensure that you have disabled ``KeepAlive``
support in your Apache install when utilizing Bugzilla under mod_perl
or you may suffer a
`performance penalty <http://modperlbook.org/html/11-4-KeepAlive.html>`_.
On restarting Apache, Bugzilla should now be running within the
mod_perl environment.
Please bear the following points in mind when considering using Bugzilla
under mod_perl:
* mod_perl support in Bugzilla can take up a HUGE amount of RAM - easily
30MB per httpd child. The more RAM you can get, the better. mod_perl is
basically trading RAM for speed. At least 2GB total system RAM is
recommended for running Bugzilla under mod_perl.
* Under mod_perl, you have to restart Apache if you make any manual change to
any Bugzilla file. You can't just reload--you have to actually
*restart* the server (as in make sure it stops and starts
again). You *can* change :file:`localconfig` and the :file:`params` file
manually, if you want, because those are re-read every time you load a page.
* You must run in Apache's Prefork MPM (this is the default). The Worker MPM
may not work -- we haven't tested Bugzilla's mod_perl support under threads.
(And, in fact, we're fairly sure it *won't* work.)
* Bugzilla generally expects to be the only mod_perl application running on
your entire server. It may or may not work if there are other applications also
running under mod_perl. It does try its best to play nice with other mod_perl
applications, but it still may have conflicts.
* It is recommended that you have one Bugzilla instance running under mod_perl
on your server. Bugzilla has not been tested with more than one instance running.
docs/en/rst/installing/backups.rst 0 → 100644
View file @ 06033dc9
.. _backups:
Backups
#######
Database
========
Here are some sample commands you could use to backup
your database, depending on what database system you're
using. You may have to modify these commands for your
particular setup. Replace the $VARIABLEs with appropriate values for your
setup.
MySQL
-----
:command:`mysqldump --opt -u $USERNAME -p $DATABASENAME > backup.sql`
See the
`mysqldump documentation <http://dev.mysql.com/doc/mysql/en/mysqldump.html>`_
for more information on :file:`mysqldump`.
.. todo:: Mention max_allowed_packet? Convert this item to a bug on checkin.
PostgreSQL
----------
:command:`pg_dump --no-privileges --no-owner -h localhost -U $USERNAME > bugs.sql`
Bugzilla
========
The Bugzilla directory contains some data files and configuration files which
you would want to retain. A simple recursive copy will do the job here.
:command:`cp -rp $BUGZILLA_HOME /var/backups/bugzilla`
docs/en/rst/installing/essential-post-install-config.rst 0 → 100644
View file @ 06033dc9
.. _essential-post-install-config:
Essential Post-Installation Configuration
#########################################
Bugzilla is configured in the Administration Parameters. Log in with the
administrator account you defined in the last :file:`checksetup.pl` run,
then click :guilabel:`Administration` in the header, and then
:guilabel:`Parameters`. You will see the different parameter sections
down the left hand side of the page.
.. _config-essential-params:
Parameters
==========
There are a few parameters which it is very important to define (or
explicitly decide not to change).
The first set of these are in the :guilabel:`Required Settings` section.
* :param:`urlbase`: this is the URL by which people should access
Bugzilla's front page.
* :param:`sslbase`: if you have configured SSL on your Bugzilla server,
this is the SSL URL by which people should access Bugzilla's front page.
* :param:`ssl_redirect`: Set this if you want everyone to be redirected
to use the SSL version. Recommended if you have set up SSL.
* :param:`cookiebase`: Bugzilla uses cookies to remember who each user is.
In order to set those cookies in the correct scope, you may need to set a
cookiebase. If your Bugzilla is at the root of your domain, you don't need
to change the default value.
You may want to put your email address in the :param:`maintainer`
parameter in the :guilabel:`General` section. This will then let people
know who to contact if they see problems or hit errors.
If you don't want just anyone able to read your Bugzilla, set the
:param:`requirelogin` parameter in the :guilabel:`User Authentication`
section, and change or clear the :param:`createemailregexp` parameter.
.. _email:
Email
=====
Bugzilla requires the ability to set up email. You have a number of choices
here. The simplest is to get Gmail or some other email provider to do the
work for you, but you can also hand the mail off to a local email server,
or run one yourself on the Bugzilla machine.
Bugzilla's approach to email is configured in the :guilabel:`Email` section
of the Parameters.
.. _install-MTA:
Use Another Mail Server
-----------------------
This section corresponds to choosing a :param:`mail_delivery_method` of
:paramval:`SMTP`.
This method passes the email off to an existing mail server. Your
organization may well already have one running for their internal email, and
may prefer to use it for confidentiality reasons. If so, you need the
following information about it:
* The domain name of the server (Parameter: :param:`smtpserver`)
* The username and password to use (Parameters: :param:`smtp_username` and
:param:`smtp_password`)
* Whether the server uses SSL (Parameter: :param:`smtp_ssl`)
* The address you should be sending mail 'From' (Parameter:
:param:`mailfrom`)
If your organization does not run its own mail server, you can use the
services of one of any number of popular email providers.
Gmail
'''''
Visit https://gmail.com and create a new Gmail account for your Bugzilla to
use. Then, set the following parameter values in the "Email" section:
* :param:`mail_delivery_method`: :paramval:`SMTP`
* :param:`mailfrom`: :paramval:`new_gmail_address@gmail.com`
* :param:`smtpserver`: :paramval:`smtp.gmail.com:465`
* :param:`smtp_username`: :paramval:`new_gmail_address@gmail.com`
* :param:`smtp_password`: :paramval:`new_gmail_password`
* :param:`smtp_ssl`: :paramval:`On`
Run Your Own Mail Server
------------------------
This section corresponds to choosing a :param:`mail_delivery_method` of
:paramval:`Sendmail`.
Unless you know what you are doing, and can deal with the possible problems
of spam, bounces and blacklists, it is probably unwise to set up your own
mail server just for Bugzilla. However, if you wish to do so, some guidance
follows.
On Linux, any Sendmail-compatible MTA (Mail Transfer Agent) will
suffice. Sendmail, Postfix, qmail and Exim are examples of common
MTAs. Sendmail is the original Unix MTA, but the others are easier to
configure, and therefore many people replace Sendmail with Postfix or
Exim. They are drop-in replacements, so Bugzilla will not
distinguish between them.
If you are using Sendmail, version 8.7 or higher is required. If you are
using a Sendmail-compatible MTA, it must be compatible with at least version
8.7 of Sendmail.
On Mac OS X 10.3 and later, `Postfix <http://www.postfix.org/>`_
is used as the built-in email server. Postfix provides an executable
that mimics sendmail enough to satisfy Bugzilla.
On Windows, if you find yourself unable to use Bugzilla's built-in SMTP
support (e.g. because the necessary Perl modules are not available), you can
use :paramval:`Sendmail` with a little application called
`sendmail.exe <http://glob.com.au/sendmail/>`_, which provides
sendmail-compatible calling conventions and encapsulates the SMTP
communication to another mail server. Like Bugzilla, :command:`sendmail.exe`
can be configured to log SMTP communication to a file in case of problems.
Detailed information on configuring an MTA is outside the scope of this
document. Consult the manual for the specific MTA you choose for detailed
installation instructions. Each of these programs will have their own
configuration files where you must configure certain parameters to
ensure that the mail is delivered properly. They are implemented
as services, and you should ensure that the MTA is in the auto-start
list of services for the machine.
If a simple mail sent with the command-line :file:`mail` program
succeeds, then Bugzilla should also be fine.
Troubleshooting
---------------
If you are having trouble, check that any configured SMTP server can be
reached from your Bugzilla server and that any given authentication
credentials are valid. If these things seem correct and your mails are still
not sending, check if your OS uses SELinux or AppArmor. Either of these
may prevent your web server from sending email. The SELinux boolean
`httpd_can_sendmail <http://selinuxproject.org/page/ApacheRecipes#Allow_the_Apache_HTTP_Server_to_send_mail>`_
may need to be set to True.
If all those things don't help, activate the :param:`smtp_debug` parameter
and check your webserver logs.
.. _config-products:
Products, Components, Versions and Milestones
=============================================
Bugs in Bugzilla are categorised into Products and, inside those Products,
Components (and, optionally, if you turn on the :param:`useclassifications`
parameter, Classifications as a level above Products).
Bugzilla comes with a single Product, called "TestProduct", which contains a
single component, imaginatively called "TestComponent". You will want to
create your own Products and their Components. It's OK to have just one
Component inside a Product. Products have Versions (which represents the
version of the software in which a bug was found) and Target Milestones
(which represent the future version of the product in which the bug is
hopefully to be fixed - or, for RESOLVED bugs, was fixed. You may also want
to add some of those.
Once you've created your own, you will want to delete TestProduct (which
will delete TestComponent automatically). Note that if you've filed a bug in
TestProduct to try Bugzilla out, you'll need to move it elsewhere before it's
possible to delete TestProduct.
Now, you may want to do some of the :ref:`optional-post-install-config`.
docs/en/rst/installing/iis.rst 0 → 100644
View file @ 06033dc9
.. _iis:
Microsoft IIS
#############
Bugzilla works with IIS as a normal CGI application. These instructions assume
that you are using Windows 7 Ultimate x64. Procedures for other versions are
probably similar.
Begin by starting Internet Information Services (IIS) Manager.
:guilabel:`Start` --> :guilabel:`Administrators Tools` -->
:guilabel:`Internet Information Services (IIS) Manager`. Or run the command:
:command:`inetmgr`
Create a New Application
========================
Expand your :guilabel:`Server` until the :guilabel:`Default Web Site` shows
its children.
Right-click :guilabel:`Default Web Site` and select
:guilabel:`Add Application` from the menu.
Unde :guilabel:`Alias`, enter the alias for the website. This is the path
below the domain where you want Bugzilla to appear.
Under :guilabel:`Physical Path`, enter the path to Bugzilla,
:file:`C:\\Bugzilla`.
When finished, click :guilabel:`OK`.
Configure the Default Document
==============================
Click on the Application that you just created. Double-click on
:guilabel:`Default Document`, and click :guilabel:`Add` underneath the
Actions menu.
Under :guilabel:`Name`, enter ``index.cgi``.
All other default documents can be removed for this application.
.. warning:: Do not delete the default document from the
:guilabel:`Default Website`.
Add Handler Mappings
====================
Ensure that you are at the Default Website. Under :guilabel:`IIS`,
double-click :guilabel:`Handler Mappings`. Under :guilabel:`Actions`, click
:guilabel:`Add Script Map`. You need to do this twice.
For the first one, set the following values (replacing paths if necessary):
* :guilabel:`Request Path`: ``*.pl``
* :guilabel:`Executable`: ``C:\Perl\bin\perl.exe "%s% %s%``
* :guilabel:`Name`: ``Perl Script Map``
At the prompt select :guilabel:`No`.
.. note:: The ActiveState Perl installer may have already created an entry for
.pl files that is limited to ``GET,HEAD,POST``. If so, this mapping should
be removed, as Bugzilla's .pl files are not designed to be run via a web
server.
.. todo:: My `source <https://wiki.mozilla.org/Installing_under_IIS_7.5>`_ says
to add a mapping for .pl, but that's sort of contradicted by the note above
from a different source. Which is right?
For the second one, set the following values (replacing paths if necessary):
* :guilabel:`Request Path`: ``*.cgi``
* :guilabel:`Executable`: ``C:\Perl\bin\perl.exe "%s% %s%``
* :guilabel:`Name`: ``CGI Script Map``
At the prompt select :guilabel:`No`.
Bugzilla Application
====================
Ensure that you are at the Bugzilla Application. Under :guilabel:`IIS`,
double-click :guilabel:`Handler Mappings`. Under :guilabel:`Actions`, click
:guilabel:`Add Script Map`.
Set the following values (replacing paths if necessary):
* :guilabel:`Request Path`: ``*.cgi``
* :guilabel:`Executable`: ``C:\Perl\bin\perl.exe -x"C:\Bugzilla" -wT "%s" %s``
* :guilabel:`Name`: ``Bugzilla``
At the prompt select :guilabel:`No`.
.. todo:: The Executable lines in the three things above are weirdly
inconsistent. Is this intentional? My source is `this page <https://wiki.mozilla.org/Installing_under_IIS_7.5>`_.
.. todo:: `LpSolit <http://lpsolit.wordpress.com/2010/10/22/make-bugzilla-work-with-iis7-easy/>`_
suggests there's a step to do with authorizing CGI modules. Where does that fit?
Common Problems
===============
Bugzilla runs but it's not possible to log in
You've probably configured IIS to use ActiveState's ISAPI DLL -- in other
words you're using PerlEx, or the executable IIS is configured to use is
:file:`PerlS.dll` or :file:`Perl30.dll`.
Reconfigure IIS to use :file:`perl.exe`.
IIS returns HTTP 502 errors
You probably forgot the ``-T`` argument to :file:`perl` when configuring the
executable in IIS.
XMLRPC interface not working with IIS
This is a known issue. See :bug:`708252`.
docs/en/rst/installing/index.rst 0 → 100644
View file @ 06033dc9
.. highlight:: console
.. _installing:
==================================
Installation and Maintenance Guide
==================================
.. note:: If you just want to *use* Bugzilla,
you do not need to install it. None of this chapter is relevant to
you. Ask your Bugzilla administrator for the URL to access it from
your web browser. You may want to read the :ref:`using`.
Bugzilla can be installed under Linux, Windows, Mac OS X, and perhaps other
operating systems. However, if you are setting it up on a dedicated machine
and you have control of the operating system to use, the Bugzilla team
wholeheartedly recommends Linux as an extremely versatile, stable, and robust
operating system that provides an ideal environment for Bugzilla. In that
case, you may want to read the :ref:`Quick Start instructions <quick-start>`.
.. toctree::
:maxdepth: 1
quick-start
linux
windows
mac-os-x
essential-post-install-config
optional-post-install-config
migrating
moving
upgrading
backups
sanity-check
merging-accounts
multiple-bugzillas
docs/en/rst/installing/installing-end.inc.rst 0 → 100644
View file @ 06033dc9
localconfig
===========
You should now change into the Bugzilla directory and run
:file:`checksetup.pl`, without any parameters:
|checksetupcommand|
:file:`checksetup.pl` will write out a file called :file:`localconfig`.
This file contains the default settings for a number of
Bugzilla parameters, the most important of which are the group your web
server runs as, and information on how to connect to your database.
Load this file in your editor. You will need to check/change ``$db_driver``
and ``$db_pass``, which are respectively the type of the database you are
using and the password for the ``bugs`` database user you have created.
``$db_driver`` can be either ``mysql``, ``Pg`` (PostgreSQL), ``Oracle`` or
``Sqlite``. All values are case sensitive.
Set the value of ``$webservergroup`` to the group your web server runs as.
* Fedora/Red Hat: ``apache``
* Debian/Ubuntu: ``www-data``
* Mac OS X: ``_www``
* Windows: ignore this setting; it does nothing
The other options in the :file:`localconfig` file are documented by their
accompanying comments. If you have a non-standard database setup, you may
need to change one or more of the other ``$db_*`` parameters.
.. note:: If you are using Oracle, ``$db_name`` should be set to
the SID name of your database (e.g. ``XE`` if you are using Oracle XE).
checksetup.pl
=============
Next, run :file:`checksetup.pl` an additional time:
|checksetupcommand|
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.
:file:`checksetup.pl` will then finish. You may rerun
:file:`checksetup.pl` at any time if you wish.
Success
=======
Your Bugzilla should now be working. Check by running:
|testservercommand|
If that passes, access ``http://<your-bugzilla-server>/`` in your browser -
you should see the Bugzilla front page. Of course, if you installed Bugzilla
in a subdirectory, make sure that's in the URL.
docs/en/rst/installing/linux.rst 0 → 100644
View file @ 06033dc9
.. _linux:
Linux
#####
Some Linux distributions include Bugzilla and its dependencies in their
package management systems. If you have root access, installing Bugzilla on
any Linux system could be as simple as finding the Bugzilla package in the
package management application and installing it. There may be a small bit
of additional configuration required.
If you are installing your machine from scratch, :ref:`quick-start` may be
the best instructions for you.
.. _linux-install-packages:
Install Packages
================
Use your distribution's package manager to install Perl, your preferred
database engine (MySQL if in doubt), and a webserver (Apache if in doubt).
Some distributions even have a Bugzilla package, although that will vary
in age.
The commands below will install those things and some of Bugzilla's other
prerequisites as well. If you find a package doesn't install or the name
is not found, just remove it from the list and reissue the command. If you
want to use a different database or webserver, substitute the package
names as appropriate.
Fedora and Red Hat
------------------
The following command will install Red Hat's packaged version of Bugzilla:
:command:`yum install bugzilla httpd mysql-server`
However, if you go this route, you need to read :bug:`415605`, which details
some problems with the Email::Send package. Then, you can skip to
:ref:`configuring your database <linux-config-database>`. It may be useful to
know that Fedora stores the Bugzilla files in :file:`/usr/share/bugzilla`, so
that's where you'll run :file:`checksetup.pl`.
If you want to install a version of Bugzilla from the Bugzilla project, you
will instead need:
:command:`yum install httpd mysql-server mod_perl mod_perl-devel httpd-devel
graphviz patchutils gcc 'perl(Apache2::SizeLimit)' 'perl(Authen::Radius)'
'perl(Authen::SASL)' 'perl(Cache::Memcached)' 'perl(CGI)' 'perl(Chart::Lines)'
'perl(Daemon::Generic)' 'perl(Date::Format)' 'perl(DateTime)'
'perl(DateTime::TimeZone)' 'perl(DBI)' 'perl(Digest::SHA)' 'perl(Email::MIME)'
'perl(Email::MIME::Attachment::Stripper)' 'perl(Email::Reply)'
'perl(Email::Sender)' 'perl(Encode)' 'perl(Encode::Detect)'
'perl(File::MimeInfo::Magic)' 'perl(File::Slurp)' 'perl(GD)' 'perl(GD::Graph)'
'perl(GD::Text)' 'perl(HTML::FormatText::WithLinks)' 'perl(HTML::Parser)'
'perl(HTML::Scrubber)' 'perl(IO::Scalar)' 'perl(JSON::RPC)' 'perl(JSON::XS)'
'perl(List::MoreUtils)' 'perl(LWP::UserAgent)' 'perl(Math::Random::ISAAC)'
'perl(MIME::Parser)' 'perl(mod_perl2)' 'perl(Net::LDAP)' 'perl(Net::SMTP::SSL)'
'perl(PatchReader)' 'perl(SOAP::Lite)' 'perl(Template)'
'perl(Template::Plugin::GD::Image)' 'perl(Test::Taint)' 'perl(TheSchwartz)'
'perl(URI)' 'perl(XMLRPC::Lite)' 'perl(XML::Twig)'`
If you are running RHEL6, you will have to enable the "RHEL Server Optional"
channel in RHN to get some of those packages.
If you plan to use SQlite as your database, you will need to also install
the appropriate packages for that.
Ubuntu and Debian
-----------------
:command:`apt-get install git nano`
:command:`apt-get install apache2 mysql-server libappconfig-perl
libdate-calc-perl libtemplate-perl libmime-perl build-essential
libdatetime-timezone-perl libdatetime-perl libemail-sender-perl
libemail-mime-perl libemail-mime-modifier-perl libdbi-perl libdbd-mysql-perl
libcgi-pm-perl libmath-random-isaac-perl libmath-random-isaac-xs-perl
apache2-mpm-prefork libapache2-mod-perl2 libapache2-mod-perl2-dev
libchart-perl libxml-perl libxml-twig-perl perlmagick libgd-graph-perl
libtemplate-plugin-gd-perl libsoap-lite-perl libhtml-scrubber-perl
libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl
libtest-taint-perl libauthen-radius-perl libfile-slurp-perl
libencode-detect-perl libmodule-build-perl libnet-ldap-perl
libauthen-sasl-perl libtemplate-perl-doc libfile-mimeinfo-perl
libhtml-formattext-withlinks-perl libgd-dev lynx-cur graphviz`
If you plan to use SQlite as your database, you will need to also install
the appropriate packages for that.
Gentoo
------
:command:`emerge -av bugzilla`
will install Bugzilla and all its dependencies. If you don't have the vhosts
USE flag enabled, Bugzilla will end up in :file:`/var/www/localhost/bugzilla`.
Then, you can skip to :ref:`configuring your database
<linux-config-database>`.
.. _linux-install-perl:
Perl
====
Test which version of Perl you have installed with:
::
$ perl -v
Bugzilla requires at least Perl |min-perl-ver|.
.. _linux-install-bzfiles:
Bugzilla
========
The best way to get Bugzilla is to check it out from git:
:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla`
Run the above command in your home directory, replacing "X.X" with the 2-digit
version number of the stable release of Bugzilla that you want - e.g. "4.4".
If that's not possible, you can
`download a tarball of Bugzilla <http://www.bugzilla.org/download/>`_.
Place Bugzilla in a suitable directory, accessible by the default web server
user (probably ``apache`` or ``www-data``).
Good locations are either directly in the web server's document directory
(often :file:`/var/www/html`) or in :file:`/usr/local`, either with a
symbolic link to the web server's document directory or an alias in the web
server's configuration.
.. warning:: The default Bugzilla distribution is NOT designed to be placed
in a :file:`cgi-bin` directory. This
includes any directory which is configured using the
``ScriptAlias`` directive of Apache.
.. _linux-install-perl-modules:
Perl Modules
============
Bugzilla requires a number of Perl modules. You can install these globally
using your system's package manager, or install Bugzilla-only copies. At
times, Bugzilla may require a version of a Perl module newer than the one
your distribution packages, in which case you will need to install a
Bugzilla-only copy of the newer version.
At this point you probably need to become ``root``, e.g. by using
:command:`su`. You should remain as root until the end of the install. This
can be avoided in some circumstances if you are a member of your webserver's
group, but being root is easier and will always work.
To check whether you have all the required modules, run:
:command:`./checksetup.pl --check-modules`
You can run this command as many times as necessary.
If you have not already installed the necessary modules, and want to do it
system-wide, invoke your package manager appropriately at this point.
Alternatively, you can install all missing modules locally (i.e. just for
Bugzilla) like this:
:command:`./install-module.pl --all`
Or, you can pass an individual module name:
:command:`./install-module.pl <modulename>`
.. note:: If you are using a package-based distribution, and attempting to
install the Perl modules from CPAN (e.g. by using
:file:`install-module.pl`), you may need to install the "development"
packages for MySQL and GD before attempting to install the related Perl
modules. The names of these packages will vary depending on the specific
distribution you are using, but are often called
:file:`<packagename>-devel`.
.. todo:: Give examples for Debian/Ubuntu and RedHat.
Convert this item to a bug after checkin.
.. _linux-config-webserver:
Web Server
==========
Any web server that is capable of running CGI scripts can be made to work.
We have specific configuration instructions for the following:
* :ref:`apache`
.. _linux-config-database:
Database Engine
===============
Bugzilla supports MySQL, PostgreSQL, Oracle and SQLite as database servers.
You only require one of these systems to make use of Bugzilla. MySQL is
most commonly used. SQLite is good for trial installations as it requires no
setup. Configure your server according to the instructions below:
* :ref:`mysql`
* :ref:`postgresql`
* :ref:`oracle`
* :ref:`sqlite`
.. |checksetupcommand| replace:: :command:`./checksetup.pl`
.. |testservercommand| replace:: :command:`./testserver.pl http://<your-bugzilla-server>/`
.. include:: installing-end.inc.rst
Next, do the :ref:`essential-post-install-config`.
docs/en/rst/installing/mac-os-x.rst 0 → 100644
View file @ 06033dc9
.. _mac-os-x:
Mac OS X
########
.. _macosx-install-packages:
.. note:: The Bugzilla team has very little Mac expertise and we've not been
able to do a successful install of the latest version. We got
close, though. If you've managed it, tell us how and we can update
these docs!
Install Packages
================
OS X 10.7 provides Perl 5.12 and Apache 2.2. Install the following additional
packages:
* git: Download an installer from
`the git website <http://www.git-scm.com/downloads>`_.
* MySQL: Download an installer from
`the MySQL website <http://dev.mysql.com/downloads/mysql/>`_.
.. _macosx-install-bzfiles:
Bugzilla
========
The best way to get Bugzilla is to check it out from git:
:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla`
Run the above command in your home directory, replacing "X.X" with the 2-digit
version number of the stable release of Bugzilla that you want - e.g. "4.4".
This will place Bugzilla in the directory :file:`$HOME/bugzilla`.
If that's not possible, you can
`download a tarball of Bugzilla <http://www.bugzilla.org/download/>`_.
.. _macosx-libraries:
Additional System Libraries
===========================
Apple does not include the GD library with Mac OS X. Bugzilla needs this if
you want to display bug graphs, and you need to install it before you try
installing the GD Perl module.
You can use `MacPorts <http://www.macports.org/>`_, `Homebrew <http://brew.sh/>`_ or
`Fink <http://sourceforge.net/projects/fink/>`_, all of which can install common
Unix programs on Mac OS X.
If you don't have one of the above installed already, pick one and follow the
instructions for setting it up. Then, use it to install the :file:`gd2` package
(MacPorts/Fink) or the :file:`gd` package (Brew).
The package manager may prompt you to install a number of dependencies; you
will need to agree to this.
.. note:: To prevent creating conflicts with the software that Apple
installs by default, Fink creates its own directory tree at :file:`/sw`
where it installs most of
the software that it installs. This means your libraries and headers
will be at :file:`/sw/lib` and :file:`/sw/include` instead
of :file:`/usr/lib` and :file:`/usr/include`. When the
Perl module config script for the GD module asks where your :file:`libgd`
is, be sure to tell it :file:`/sw/lib`.
.. _macosx-install-perl-modules:
Perl Modules
============
Bugzilla requires a number of Perl modules. On Mac OS X, the easiest thing to
do is to install local copies (rather than system-wide copies) of any ones
that you don't already have. However, if you do want to install them
system-wide, run the below commands as root with the :command:`--global`
option.
To check whether you have all the required modules and what is still missing,
run:
:command:`perl checksetup.pl --check-modules`
You can run this command as many times as necessary.
Install all missing modules locally like this:
:command:`perl install-module.pl --all`
.. _macosx-config-webserver:
Web Server
==========
Any web server that is capable of running CGI scripts can be made to work.
We have specific configuration instructions for the following:
* :ref:`apache`
You'll need to create a symbolic link so the webserver can see Bugzilla:
:command:`cd /Library/WebServer/Documents`
:command:`sudo ln -s $HOME/bugzilla bugzilla`
In :guilabel:`System Preferences` --> :guilabel:`Sharing`, enable the
:guilabel:`Web Sharing` checkbox to start Apache.
.. _macosx-config-database:
Database Engine
===============
Bugzilla supports MySQL, PostgreSQL, Oracle and SQLite as database servers.
You only require one of these systems to make use of Bugzilla. MySQL is
most commonly used on Mac OS X. (In fact, we have no reports of anyone using
anything else.) Configure your server according to the instructions below:
* :ref:`mysql`
* :ref:`postgresql`
* :ref:`oracle`
* :ref:`sqlite`
.. |checksetupcommand| replace:: :command:`perl checksetup.pl`
.. |testservercommand| replace:: :command:`perl testserver.pl http://<your-bugzilla-server>/`
.. include:: installing-end.inc.rst
Next, do the :ref:`essential-post-install-config`.
docs/en/rst/installing/merging-accounts.rst 0 → 100644
View file @ 06033dc9
Merging Accounts
################
Sometimes, users create a second account, perhaps because they don't realise
they can change the email address associated with their original account.
And then, once they discover this, they don't want to abandon the history
associated with either account.
The best way forward in this case would be to merge one of their accounts
into the other one, so it looked like the target account had done all the
actions of both. In Bugzilla's :file:`contrib` directory, there is a script
called :file:`merge-users.pl`. While code in this directory is not officially
supported by the Bugzilla team, this script may be useful to you in
solving the above problem.
docs/en/rst/installing/migrating-from-1.inc.rst 0 → 100644
View file @ 06033dc9
.. This file is included in multiple places, so can't have labels as they
appear as duplicates.
The procedure to migrate to Git is as follows. The idea is to switch version
control systems without changing the version of Bugzilla you are using,
to minimise the risk of conflict or problems. Any upgrade can then
happen as a separate step.
docs/en/rst/installing/migrating-from-2.inc.rst 0 → 100644
View file @ 06033dc9
.. This file is included in multiple places, so can't have labels as they
appear as duplicates.
Download Code from Git
======================
First, you need to find what version of Bugzilla you are using. It should be
in the top right corner of the front page but, if not, open the file
:file:`Bugzilla/Constants.pm` in your Bugzilla directory and search for
:code:`BUGZILLA_VERSION`.
Then, you need to download an additional copy of your *current* version of
Bugzilla from the git repository, and place it in a separate directory
alongside your existing Bugzilla installation (which we will assume is in a
directory called :file:`bugzilla`).
To do this, you will need a copy of the :command:`git` program. All Linux
distributions have it; search your package manager for "git". On Windows or
Mac OS X, you can
`download the official build <http://www.git-scm.com/downloads>`_.
Once git is installed, run these commands to pull a copy of Bugzilla:
:command:`git clone https://git.mozilla.org/bugzilla/bugzilla bugzilla-new`
:command:`cd bugzilla-new`
:command:`git checkout release-$VERSION`
Replace $VERSION with the three-digit version number of your current Bugzilla,
e.g. "4.2.2". (If the the final digit would have been a 0, omit it - so use
"4.4" for the first release in the 4.4 series.)
You will get a message about a 'detached HEAD'. Don't worry; your head is
still firmly attached to your shoulders.
Save Any Local Customizations
=============================
Go into your original Bugzilla directory and run this command:
|diffcommand|
If you have made customizations to your Bugzilla, and you made them by
changing the Bugzilla code itself (rather than using the Extension system),
then :file:`patch.diff` will have significant content. You will want to keep a copy
of those changes by keeping a copy of this file and any files referenced in it
by "Only in" lines. If the file has zero size or only insignificant content,
you haven't made any local customizations of this sort.
Shut Down Bugzilla
==================
At this point, you should shut down Bugzilla to make sure nothing changes
while you make the switch. Go into the administrative interface and put an
appropriate message into the :param:`shutdownhtml` parameter, which is in the
"General" section of the administration parameters. As the name implies, HTML
is allowed.
This would be a good time to make :ref:`backups`. We shouldn't be affecting
the database, but you can't be too careful.
Copy Across Data and Modules
============================
Copy the contents of the following directories from your current installation
of Bugzilla into the corresponding directory in :file:`bugzilla-new/`:
.. code-block:: none
lib/
data/
template/en/custom (may or may not exist)
You also need to copy any extensions you have written or installed, which are
in the :file:`extensions/` directory. |extstatusinfo|
Lastly, copy the following file from your current installation of Bugzilla
into the corresponding place in :file:`bugzilla-new/`:
.. code-block:: none
localconfig
This file contains your database password and access details. Because your
two versions of Bugzilla are the same, this should all work fine.
Reapply Local Customizations
============================
If your :file:`patch.diff` file was zero sized, you can
jump to the next step. Otherwise, you have to apply the patch to your new
installation. If you are on Windows and you don’t have the :command:`patch`
program, you can download it from
`GNUWin <http://gnuwin32.sourceforge.net/packages/patch.htm>`_. Once
downloaded, you must copy patch.exe into the Windows directory.
Copy :file:`patch.diff` into the :file:`bugzilla-new` directory and then do:
:command:`patch -p0 --dry-run < patch.diff`
The patch should apply cleanly because you have exactly the same version of
Bugzilla in both directories. If it does, remove the :command:`--dry-run` and
rerun the command to apply it for real. If it does not apply cleanly, it is
likely that you have managed to get a Bugzilla version mismatch between the
two directories.
Swap The New Version In
=======================
Now we swap the directories over, and run checksetup.pl to confirm that all
is well. From the directory containing the :file:`bugzilla` and
:file:`bugzilla-new` directories, run:
:command:`mv bugzilla bugzilla-old`
:command:`mv bugzilla-new bugzilla`
:command:`cd bugzilla`
:command:`./checksetup.pl`
Running :file:`checksetup.pl` should not result in any changes to your database at
the end of the run. If it does, then it's most likely that the two versions
of Bugzilla you have are not, in fact, the same.
Re-enable Bugzilla
==================
Go into the administrative interface and clear the contents of the
:param:`shutdownhtml` parameter.
Test Bugzilla
=============
Use your Bugzilla for several days to check that the switch has had no
detrimental effects. Then, if necessary, follow the instructions in
:ref:`upgrading-with-git` to upgrade to the latest version of Bugzilla.
Rolling Back
============
If something goes wrong at any stage of the switching process (e.g. your
patch doesn't apply, or checksetup doesn't complete), you can always just
switch the directories back (if you've got that far) and re-enable Bugzilla
(if you disabled it) and then seek help. Even if you have re-enabled Bugzilla,
and find a problem a little while down the road, you are still using the same
version so there would be few side effects to switching the directories back
a day or three later.
docs/en/rst/installing/migrating-from-a-tarball.rst 0 → 100644
View file @ 06033dc9
.. _migrating-from-a-tarball:
Migrating from a Tarball
########################
.. |diffcommand| replace:: :command:`diff -ru -x data -x lib -x docs -x .git -x CVS -x .cvsignore -x .bzr -x .bzrignore -x .bzrrev ../bugzilla-new . > ../patch.diff`
.. |extstatusinfo| replace:: Copy across any subdirectories which do not exist
in your new install.
The procedure to migrate to Git is as follows. The idea is to switch without
changing the version of Bugzilla you are using, to minimise the risk of
conflict or problems. Any upgrade can then happen as a separate step.
.. include:: migrating-from-2.inc.rst
docs/en/rst/installing/migrating-from-bzr.rst 0 → 100644
View file @ 06033dc9
.. _migrating-from-bazaar:
Migrating from Bazaar
#####################
.. |updatecommand| replace:: :command:`bzr up -r tag:bugzilla-$VERSION`
.. |diffcommand| replace:: :command:`bzr diff > patch.diff`
.. |extstatusinfo| replace:: The command :command:`bzr status extensions/` should help you work out what you added, if anything.
.. include:: migrating-from-1.inc.rst
.. include:: migrating-from-2.inc.rst
docs/en/rst/installing/migrating-from-cvs.rst 0 → 100644
View file @ 06033dc9
.. _migrating-from-cvs:
Migrating from CVS
##################
.. |updatecommand| replace:: :command:`cvs update -rBUGZILLA-$VERSION-STABLE -dP`
.. |diffcommand| replace:: :command:`cvs diff -puN > patch.diff`
.. |extstatusinfo| replace:: The command :command:`cvs status extensions/` should help you work out what you added, if anything.
.. include:: migrating-from-1.inc.rst
.. include:: migrating-from-2.inc.rst
docs/en/rst/installing/migrating.rst 0 → 100644
View file @ 06033dc9
.. _migrating-from-other-btses:
Migrating From Other Bug-Tracking Systems
#########################################
Bugzilla has a framework you can use for migrating from other bug-tracking
systems -
`Bugzilla::Migrate <http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/Migrate.html>`_.
It provides the infrastructure you will need,
but requires a module to be written to define the specifics of the system you
are coming from. One exists for
`Gnats <https://www.gnu.org/software/gnats/>`_. If you write one for a
popular system, please share your code with us.
Alternatively, Bugzilla comes with a script, :file:`importxml.pl`, which
imports bugs in Bugzilla's XML format. You can see examples of this format
by clicking the :guilabel:`XML` link at the bottom of a bug in a running
Bugzilla. You would need to read the script to see how it handles errors,
default values, creating non-existing values and so on.
Bugzilla::Migrate is preferred if possible.
docs/en/rst/installing/moving.rst 0 → 100644
View file @ 06033dc9
.. _moving:
Moving Bugzilla Between Machines
################################
Sometimes it's necessary to take a working installation of Bugzilla and move
it to new hardware. This page explains how to do that, assuming that you
have Bugzilla's webserver and database on the same machine, and you are moving
both of them.
You are advised to install the same version of Bugzilla on the new
machine as the old machine - any :ref:`upgrade <upgrading>` you also need to
do can then be done as a separate step. But if you do install a newer version,
things should still work.
1. Shut down your Bugzilla by loading the front page, going to
:guilabel:`Administration` | :guilabel:`Parameters` | :guilabel:`General`
and putting some explanatory text into the :param:`shutdownhtml` parameter.
2. Make a :ref:`backup <backups>` of the bugs database.
3. On your new machine, install Bugzilla using the instructions at
:ref:`installing`. Look at the old machine if you need to know what values
you used for configuring e.g. MySQL.
4. Copy the :file:`data` directory and the :file:`localconfig` file from the
old Bugzilla installation to the new one.
5. If anything about your database configuration changed (location of the
server, username, password, etc.) as part of the move, update the
appropriate variables in :file:`localconfig`.
6. If the new URL to your new Bugzilla installation is different from the old
one, update the :param:`urlbase` parameter in :file:`data/params.json`
using a text editor.
7. Copy the database backup file from your old server to the new one.
8. Create an empty ``bugs`` database on the new server. For MySQL, that would
look like this:
:command:`mysql -u root -p -e "CREATE DATABASE bugs DEFAULT CHARACTER SET utf8;"`
9. Import your backup file into your new ``bugs`` database. Again, for MySQL:
:command:`mysql -u root -p bugs < $BACKUP_FILE_NAME`
If you get an error about "packet too large" or "MySQL server has gone
away", you need to adjust the ``max_allowed_packet`` setting in
your :file:`my.cnf` file (usually :file:`/etc/my.cnf`) file to match or
exceed the value configured in the same file in your old version of MySQL.
If there are *any* errors during this step, you have to work out what
went wrong, and then drop the database, create it again using the step
above, and run the import again.
10. Run :file:`checksetup.pl` to make sure all is OK.
(Unless you are using a newer version of Bugzilla on your new server, this
should not make any changes.)
:command:`./checksetup.pl`
11. Activate your new Bugzilla by loading the front page on the new server,
going to :guilabel:`Administration` | :guilabel:`Parameters` |
:guilabel:`General` and removing the text from the :param:`shutdownhtml`
parameter.
docs/en/rst/installing/multiple-bugzillas.rst 0 → 100644
View file @ 06033dc9
.. _multiple-bz-dbs:
One Installation, Multiple Instances
####################################
This is a somewhat specialist feature; if you don't know whether you need it,
you don't. It is useful to admins who want to run many separate instances of
Bugzilla from a single installed codebase.
This is possible by using the ``PROJECT`` environment variable. When accessed,
Bugzilla checks for the existence of this variable, and if present, uses
its value to check for an alternative configuration file named
:file:`localconfig.<PROJECT>` in the same location as
the default one (:file:`localconfig`). It also checks for
customized templates in a directory named
:file:`<PROJECT>` in the same location as the
default one (:file:`template/<langcode>`). By default
this is :file:`template/en/default` so ``PROJECT``'s templates
would be located at :file:`template/en/PROJECT`.
To set up an alternate installation, just export ``PROJECT=foo`` before
running :command:`checksetup.pl` for the first time. It will
result in a file called :file:`localconfig.foo` instead of
:file:`localconfig`. Edit this file as described above, with
reference to a new database, and re-run :command:`checksetup.pl`
to populate it. That's all.
Now you have to configure the web server to pass this environment
variable when accessed via an alternate URL, such as virtual host for
instance. The following is an example of how you could do it in Apache,
other Webservers may differ.
.. code-block:: apache
<VirtualHost 12.34.56.78:80>
ServerName bugzilla.example.com
SetEnv PROJECT foo
</VirtualHost>
Don't forget to also export this variable before accessing Bugzilla
by other means, such as repeating tasks like those above.
docs/en/rst/installing/mysql.rst 0 → 100644
View file @ 06033dc9
.. _mysql:
MySQL
#####
You need MySQL version 5.0.15 or higher.
It's possible to test which version of MySQL you have installed with:
:command:`mysql -V`
Installing
==========
Windows
-------
Download the MySQL 32-bit or 64-bit MSI installer from the
`MySQL website <http://www.mysql.com/downloads/mysql/>`_ (~28 MB).
MySQL has a standard Windows installer. It's ok to select a Typical MySQL
install (the default). The rest of this documentation assumes assume you
have installed MySQL into :file:`C:\\mysql`. Adjust paths appropriately if not.
Linux/Mac OS X
--------------
The package install instructions given previously should have installed MySQL
on your machine, if it didn't come with it already. Run:
:command:`mysql_secure_installation`
and follow its advice.
If you did install MySQL manually rather than from a package, make sure the
server is started when the machine boots.
.. _mysql-add-user:
Add a User
==========
You need to add a new MySQL user for Bugzilla to use. Run the :file:`mysql`
command-line client and enter:
::
GRANT SELECT, INSERT,
UPDATE, DELETE, INDEX, ALTER, CREATE, LOCK TABLES,
CREATE TEMPORARY TABLES, DROP, REFERENCES ON bugs.*
TO bugs@localhost IDENTIFIED BY '$DB_PASS';
FLUSH PRIVILEGES;
You need to replace ``$DB_PASS`` with a strong password you have chosen.
Write that password down somewhere.
The above command permits an account called ``bugs``
to connect from the local machine, ``localhost``. Modify the command to
reflect your setup if you will be connecting from another
machine or as a different user.
Change Configuration
====================
To change MySQL's configuration, you need to edit your MySQL
configuration file, which is:
* Red Hat/Fedora: :file:`/etc/my.cnf`
* Debian/Ubuntu: :file:`/etc/mysql/my.cnf`
* Windows: :file:`C:\\mysql\\bin\\my.ini`
* Mac OS X: :file:`/etc/my/cnf`
.. _mysql-max-allowed-packet:
Allow Large Attachments and Many Comments
-----------------------------------------
By default on some systems, MySQL will only allow you to insert things
into the database that are smaller than 1MB.
Bugzilla attachments
may be larger than this. Also, Bugzilla combines all comments
on a single bug into one field for full-text searching, and the
combination of all comments on a single bug could in some cases
be larger than 1MB.
We recommend that you allow at least 16MB packets by
adding or altering the ``max_allowed_packet`` parameter in your MySQL
configuration in the ``[mysqld]`` section, so that the number is at least
16M, like this (note that it's ``M``, not ``MB``):
::
[mysqld]
# Allow packets up to 16M
max_allowed_packet=16M
.. _mysql-small-words:
Allow Small Words in Full-Text Indexes
--------------------------------------
By default, words must be at least four characters in length
in order to be indexed by MySQL's full-text indexes. This causes
a lot of Bugzilla-specific words to be missed, including "cc",
"ftp" and "uri".
MySQL can be configured to index those words by setting the
``ft_min_word_len`` param to the minimum size of the words to index.
::
[mysqld]
# Allow small words in full-text indexes
ft_min_word_len=2
.. _mysql-attach-table-size:
Permit Attachments Table to Grow Beyond 4GB
===========================================
This is optional configuration for Bugzillas which are expected to become
very large, and needs to be done after Bugzilla is fully installed.
By default, MySQL will limit the size of a table to 4GB.
This limit is present even if the underlying filesystem
has no such limit. To set a higher limit, run the :file:`mysql`
command-line client and enter the following, replacing ``$bugs_db``
with your Bugzilla database name (which is ``bugs`` by default):
.. code-block:: sql
USE $bugs_db;
ALTER TABLE attachments AVG_ROW_LENGTH=1000000, MAX_ROWS=20000;
The above command will change the limit to 20GB. MySQL will have
to make a temporary copy of your entire table to do this, so ideally
you should do this when your attachments table is still small.
.. note:: If you have set the setting in Bugzilla which allows large
attachments to be stored on disk, the above change does not affect that.
docs/en/rst/installing/optional-post-install-config.rst 0 → 100644
View file @ 06033dc9
.. _optional-post-install-config:
Optional Post-Install Configuration
###################################
Bugzilla has a number of optional features. This section describes how
to configure or enable them.
.. _recurring-tasks:
Recurring Tasks
===============
Several of the below features require you to set up a script to run at
recurring intervals. The method of doing this varies by operating system.
Linux
-----
Run:
:command:`crontab -e`
This should bring up the crontab file in your editor. Add the relevant
cron line from the sections below in order to enable the corresponding
feature.
Windows
-------
Windows comes with a Task Scheduler. To run a particular script, do the
following:
#. :guilabel:`Control Panel` --> :guilabel:`Scheduled Tasks` -->
:guilabel:`Add Scheduled Task`
#. Next
#. Browse
#. Find :file:`perl.exe` (normally :file:`C:\\Perl\\bin\\perl.exe`)
#. Give the task a name, such as "Bugzilla <scriptname>"
#. Request the task be performed at your desired time and interval
#. If you're running Apache as a user, not as SYSTEM, enter that user
here. Otherwise you're best off creating an account that has write access
to the Bugzilla directory and using that
#. Tick "Open Advanced Properties.." and click Finish
#. Append the script name to the end of the "Run" field. eg
:command:`C:\\Perl\\bin\\perl.exe C:\\Bugzilla\\<scriptname>`
#. Change "start in" to the Bugzilla directory
.. _installation-bug-graphs:
Bug Graphs
==========
If you have installed the necessary Perl modules, as indicated by
:file:`checksetup.pl`, you can ask Bugzilla to regularly collect statistics
so that you can see graphs and charts.
On Linux, use a cron line as follows:
.. code-block:: none
5 0 * * * cd <your-bugzilla-directory> && ./collectstats.pl
On Windows, schedule the :file:`collectstats.pl` script to run daily.
After two days have passed you'll be able to view bug graphs from
the Reports page.
.. _installation-whining:
Whining
=======
Users can configure Bugzilla to annoy them at regular intervals, by having
Bugzilla execute saved searches at certain times and emailing the results to
the user. This is known as "Whining". The details of how a user configures
Whining is described in :ref:`whining`, but for it to work a Perl script must
be executed at regular intervals.
On Linux, use a cron line as follows:
.. code-block:: none
*/15 * * * * cd <your-bugzilla-directory> && ./whine.pl
On Windows, schedule the :file:`whine.pl` script to run every 15 minutes.
.. _installation-whining-cron:
Whining at Untriaged Bugs
=========================
It's possible for bugs to languish in an untriaged state. Bugzilla has a
specific system to issue complaints about this particular problem to all the
relevant engineers automatically by email.
On Linux, use a cron line as follows:
.. code-block:: none
55 0 * * * cd <your-bugzilla-directory> && ./whineatnews.pl
On Windows, schedule the :file:`whineatnews.pl` script to run daily.
Dependency Graphs
=================
Bugzilla can draw graphs of the dependencies (depends on/blocks relationships)
between bugs, if you install a package called :file:`dot`.
Linux
-----
Put the complete path to the :file:`dot` command (from the ``graphviz``
package) in the :param:`webdotbase` parameter. E.g. :paramval:`/usr/bin/dot`.
Windows
-------
Download and install Graphviz from
`the Graphviz website <http://www.graphviz.org/Download_windows.php>`_. Put
the complete path to :file:`dot.exe` in the :param:`webdotbase` parameter,
using forward slashes as path separators. E.g.
:paramval:`C:/Program Files/ATT/Graphviz/bin/dot.exe`.
docs/en/rst/installing/oracle.rst 0 → 100644
View file @ 06033dc9
.. _oracle:
Oracle
######
.. warning:: Bugzilla supports Oracle, but none of the current developers run
it. Your mileage may vary.
You need Oracle version 10.02.0 or later.
.. _oracle-tablespace:
Create a New Tablespace
=======================
You can use the existing tablespace or create a new one for Bugzilla.
To create a new tablespace, run the following command:
::
CREATE TABLESPACE bugs
DATAFILE '*$path_to_datafile*' SIZE 500M
AUTOEXTEND ON NEXT 30M MAXSIZE UNLIMITED
Here, the name of the tablespace is 'bugs', but you can
choose another name. *$path_to_datafile* is
the path to the file containing your database, for instance
:file:`/u01/oradata/bugzilla.dbf`.
The initial size of the database file is set in this example to 500 Mb,
with an increment of 30 Mb everytime we reach the size limit of the file.
.. _oracle-add-user:
Add a User to Oracle
====================
The user name and password must match what you set in :file:`localconfig`
(``$db_user`` and ``$db_pass``, respectively). Here, we assume that
the user name is 'bugs' and the tablespace name is the same
as above.
::
CREATE USER bugs
IDENTIFIED BY "$db_pass"
DEFAULT TABLESPACE bugs
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT;
-- GRANT/REVOKE ROLE PRIVILEGES
GRANT CONNECT TO bugs;
GRANT RESOURCE TO bugs;
-- GRANT/REVOKE SYSTEM PRIVILEGES
GRANT UNLIMITED TABLESPACE TO bugs;
GRANT EXECUTE ON CTXSYS.CTX_DDL TO bugs;
.. _oracle_webserver:
Configure the Web Server
========================
If you use Apache, append these lines to :file:`httpd.conf`
to set ORACLE_HOME and LD_LIBRARY_PATH. For instance:
.. code-block:: apache
SetEnv ORACLE_HOME /u01/app/oracle/product/10.2.0/
SetEnv LD_LIBRARY_PATH /u01/app/oracle/product/10.2.0/lib/
When this is done, restart your web server.
docs/en/rst/installing/postgresql.rst 0 → 100644
View file @ 06033dc9
.. _postgresql:
PostgreSQL
##########
Test which version of PostgreSQL you have installed with:
:command:`psql -V`
You need PostgreSQL version 8.03.0000 or higher.
If you install PostgreSQL manually rather than from a package, make sure the
server is started when the machine boots.
.. _posgresql-add-user:
Add a User
==========
You need to add a new user to PostgreSQL for the Bugzilla
application to use when accessing the database. The following instructions
assume the defaults in :file:`localconfig`; if you
changed those, you need to modify the commands appropriately.
On most systems, to create a user in PostgreSQL, login as the root user, and
then switch to being the postgres (Unix) user:
:command:`su - postgres`
As the postgres user, you then need to create a new user:
:command:`createuser -U postgres -dRSP bugs`
When asked for a password, provide one and write it down for later reference.
The created user will not be a superuser (-S) and will not be able to create
new users (-R). He will only have the ability to create databases (-d).
.. _postgresql-access:
Permit Access
=============
Edit the file :file:`pg_hba.conf` which is
usually located in :file:`/var/lib/pgsql/data/`. In this file,
you will need to add a new line to it as follows:
::
host all bugs 127.0.0.1 255.255.255.255 md5
This means that for TCP/IP (host) connections, allow connections from
'127.0.0.1' to 'all' databases on this server from the 'bugs' user, and use
password authentication ('md5') for that user.
Now, you will need to stop and start PostgreSQL fully. (Do not use any
'restart' command, due to the possibility of a change to
:file:`postgresql.conf`.)
docs/en/rst/installing/quick-start.rst 0 → 100644
View file @ 06033dc9
.. _quick-start:
Quick Start (Ubuntu Linux 14.04)
################################
This quick start guide makes installing Bugzilla as simple as possible for
those who are able to choose their environment. It creates a system using
Ubuntu Linux 14.04 LTS, Apache and MySQL, and installs Bugzilla as the default
home page. It requires a little familiarity with Linux and the command line.
Obtain Your Hardware
====================
Ubuntu 14.04 LTS Server requires a 64-bit processor.
Bugzilla itself has no prerequisites beyond that, although you should pick
reliable hardware. You can also probably use any 64-bit virtual machine
or cloud instance that you have root access on.
Install the OS
==============
Get `Ubuntu Server 14.04 LTS <http://www.ubuntu.com/download/server>`_
and follow the `installation instructions <http://www.ubuntu.com/download/server/install-ubuntu-server>`_.
Here are some tips:
* Choose any server name you like.
* When creating the initial Linux user, call it ``bugzilla``, give it a
strong password, and write that password down.
* You do not need an encrypted home directory.
* Choose all the defaults for the "partitioning" part (excepting of course
where the default is "No" and you need to press "Yes" to continue).
* Choose "install security updates automatically" unless you want to do
them manually.
* From the install options, choose "OpenSSH Server" and "LAMP Server".
* Set the password for the MySQL root user to a strong password, and write
that password down.
* Install the Grub boot loader to the Master Boot Record.
Reboot when the installer finishes.
Become root
===========
ssh to the machine as the 'bugzilla' user, or start a console. Then:
:command:`sudo su`
Install Prerequisites
=====================
:command:`apt-get install git nano`
:command:`apt-get install apache2 mysql-server libappconfig-perl libdate-calc-perl libtemplate-perl libmime-perl build-essential libdatetime-timezone-perl libdatetime-perl libemail-sender-perl libemail-mime-perl libemail-mime-modifier-perl libdbi-perl libdbd-mysql-perl libcgi-pm-perl libmath-random-isaac-perl libmath-random-isaac-xs-perl apache2-mpm-prefork libapache2-mod-perl2 libapache2-mod-perl2-dev libchart-perl libxml-perl libxml-twig-perl perlmagick libgd-graph-perl libtemplate-plugin-gd-perl libsoap-lite-perl libhtml-scrubber-perl libjson-rpc-perl libdaemon-generic-perl libtheschwartz-perl libtest-taint-perl libauthen-radius-perl libfile-slurp-perl libencode-detect-perl libmodule-build-perl libnet-ldap-perl libauthen-sasl-perl libtemplate-perl-doc libfile-mimeinfo-perl libhtml-formattext-withlinks-perl libgd-dev lynx-cur`
This will take a little while. It's split into two commands so you can do
the next steps (up to step 7) in another terminal while you wait for the
second command to finish. If you start another terminal, you will need to
:command:`sudo su` again.
Download Bugzilla
=================
Get it from our Git repository:
:command:`cd /var/www`
:command:`rm -rf html`
:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla html`
(where "X.X" is the 2-digit version number of the stable release of Bugzilla
that you want - e.g. 4.4)
:command:`cd html`
Configure MySQL
===============
The following instructions use the simple :file:`nano` editor, but feel
free to use any text editor you are comfortable with.
:command:`nano /etc/mysql/my.cnf`
Set the following values, which increase the maximum attachment size and
make it possible to search for short words and terms:
* Alter on Line 52: ``max_allowed_packet=100M``
* Add as new line 31, in the ``[mysqld]`` section: ``ft_min_word_len=2``
Save and exit.
Then, add a user to MySQL for Bugzilla to use:
:command:`mysql -u root -p -e "GRANT ALL PRIVILEGES ON bugs.* TO bugs@localhost IDENTIFIED BY '$db_pass'"`
Replace ``$db_pass`` with a strong password you have generated. Write it down.
When you run the above command, it will prompt you for the MySQL root password
that you configured when you installed Ubuntu. You should make ``$db_pass``
different to that password.
Restart MySQL:
:command:`service mysql restart`
Configure Apache
================
:command:`nano /etc/apache2/sites-available/bugzilla.conf`
Paste in the following and save:
.. code-block:: apache
ServerName localhost
<Directory /var/www/html>
AddHandler cgi-script .cgi
Options +ExecCGI
DirectoryIndex index.cgi index.html
AllowOverride Limit FileInfo Indexes Options
</Directory>
:command:`a2ensite bugzilla`
:command:`a2enmod cgi headers expires`
:command:`service apache2 restart`
Check Setup
===========
Bugzilla comes with a :file:`checksetup.pl` script which helps with the
installation process. It will need to be run twice. The first time, it
generates a config file (called :file:`localconfig`) for the database
access information, and the second time (step 10)
it uses the info you put in the config file to set up the database.
:command:`cd /var/www/html`
:command:`./checksetup.pl`
Edit :file:`localconfig`
========================
:command:`nano localconfig`
You will need to set the following values:
* Line 29: set ``$webservergroup`` to ``www-data``
* Line 67: set ``$db_pass`` to the password for the ``bugs`` user you created
in MySQL a few steps ago
Check Setup (again)
===================
Run the :file:`checksetup.pl` script again to set up the database.
:command:`./checksetup.pl`
It will ask you to give an email address, real name and password for the
first Bugzilla account to be created, which will be an administrator.
Write down the email address and password you set.
Test Server
===========
:command:`./testserver.pl http://localhost/`
All the tests should pass. You will get warnings about deprecation from
the ``Chart::Base`` Perl module; just ignore those.
.. todo:: Chart::Base gives confusing deprecation warnings :-|
https://rt.cpan.org/Public/Bug/Display.html?id=79658 , unfixed for
2 years. :bug:`1070117`.
Access Via Web Browser
======================
Access the front page:
:command:`lynx http://localhost/`
It's not really possible to use Bugzilla for real through Lynx, but you
can view the front page to validate visually that it's up and running.
You might well need to configure your DNS such that the server has, and
is reachable by, a name rather than IP address. Doing so is out of scope
of this document. In the mean time, it is available on your local network
at ``http://<ip address>/``, where ``<ip address>`` is (unless you have
a complex network setup) the "inet addr" value displayed when you run
:command:`ifconfig eth0`.
Configure Bugzilla
==================
Once you have worked out how to access your Bugzilla in a graphical
web browser, bring up the front page, click :guilabel:`Log In` in the
header, and log in as the admin user you defined in step 10.
Click the :guilabel:`Parameters` link on the page it gives you, and set
the following parameters in the :guilabel:`Required Settings` section:
* :param:`urlbase`:
:paramval:`http://<servername>/` or :paramval:`http://<ip address>/`
Click :guilabel:`Save Changes` at the bottom of the page.
There are several ways to get Bugzilla to send email. The easiest is to
use Gmail, so we do that here so you have it working. Visit
https://gmail.com and create a new Gmail account for your Bugzilla to use.
Then, open the :guilabel:`Email` section of the Parameters using the link
in the left column, and set the following parameter values:
* :param:`mail_delivery_method`: :paramval:`SMTP`
* :param:`mailfrom`: :paramval:`new_gmail_address@gmail.com`
* :param:`smtpserver`: :paramval:`smtp.gmail.com:465`
* :param:`smtp_username`: :paramval:`new_gmail_address@gmail.com`
* :param:`smtp_password`: :paramval:`new_gmail_password`
* :param:`smtp_ssl`: :paramval:`On`
Click :guilabel:`Save Changes` at the bottom of the page.
And you're all ready to go. :-)
docs/en/rst/installing/sanity-check.rst 0 → 100644
View file @ 06033dc9
.. _sanity-check:
Sanity Check
############
Over time it is possible for the Bugzilla database to become corrupt
or to have anomalies. This could happen through manual database
administration outside of the Bugzilla user interface, or from some
other unexpected event. Bugzilla includes a "Sanity Check" that
can perform several basic database checks, and repair certain problems or
inconsistencies.
To run a Sanity Check, log in as an Administrator and click the
:guilabel:`Sanity Check` link in the admin page. Any problems that are found
will be displayed in red letters. If the script is capable of fixing a
problem, it will present a link to initiate the fix. If the script cannot
fix the problem it will require manual database administration or recovery.
Sanity Check can also be run from the command line via the perl
script :file:`sanitycheck.pl`. The script can also be run as
a :command:`cron` job. Results will be delivered by email to an address
specified on the command line.
Sanity Check should be run on a regular basis as a matter of
best practice.
docs/en/rst/installing/sqlite.rst 0 → 100644
View file @ 06033dc9
.. _sqlite:
SQLite
######
.. warning:: Due to SQLite's `concurrency
limitations <http://sqlite.org/faq.html#q5>`_ we recommend SQLite only for
small and development Bugzilla installations.
Once you have SQLite installed, no additional configuration is required to
run Bugzilla.
The database will be stored in :file:`$BUGZILLA_HOME/data/db/$db_name`, where
``$db_name`` is the database name defined in :file:`localconfig`.
docs/en/rst/installing/upgrading-customizations.rst 0 → 100644
View file @ 06033dc9
.. _upgrading-customizations:
Upgrading a Customized or Extended Bugzilla
###########################################
If your Bugzilla has been customized or uses extensions, you will need to
make your customizations or extensions work with your new version of Bugzilla.
If this is the case, you are particularly strongly recommended to do a test
upgrade on a test system and use that to help you port forward your
customizations.
If your extension came from a third party, look to see if an updated version
is available for the version of Bugzilla you are upgrading to. If not, and
you want to continue using it, you'll need to port it forward yourself.
If you are upgrading from a version of Bugzilla earlier than 3.6 and have
extensions for which a newer version is not available from an upstream source,
then you need to convert them. This is because the extension format changed
in version 3.6. There is a file called :file:`extension-convert.pl` in the
:file:`contrib` directory which may be able to help you with that.
docs/en/rst/installing/upgrading-with-1.inc.rst 0 → 100644
View file @ 06033dc9
Before You Upgrade
==================
Before you start your upgrade, there are a few important
steps to take:
#. Read the
`Release Notes <http://www.bugzilla.org/releases/>`_ of the version you're
upgrading to and all intermediate versions, particularly the "Notes for
Upgraders" sections, if present. They may make you aware of additional
considerations.
#. Run the :ref:`sanity-check` on your installation. Attempt to fix all
warnings that the page produces before you start, or it's
possible that you may experience problems during your upgrade.
#. Work out how to :ref:`back up <backups>` your Bugzilla entirely, and
how to restore from a backup if need be.
Customized Bugzilla?
--------------------
If you have modified the code or templates of your Bugzilla,
then upgrading requires a bit more thought and effort than the simple process
below. See :ref:`template-method` for a discussion of the various methods of
code customization that may have been used.
The larger the jump you are trying to make, the more difficult it
is going to be to upgrade if you have made local code customizations.
Upgrading from 4.2 to 4.2.1 should be fairly painless even if
you are heavily customized, but going from 2.18 to 4.2 is going
to mean a fair bit of work re-writing your local changes to use
the new files, logic, templates, etc. If you have done no local
changes at all, however, then upgrading should be approximately
the same amount of work regardless of how long it has been since
your version was released.
If you have made customizations, you should do the upgrade on a test system
with the same configuration and make sure all your customizations still work.
If not, port and test them so you have them ready to reapply once you do
the upgrade for real.
docs/en/rst/installing/upgrading-with-2.inc.rst 0 → 100644
View file @ 06033dc9
Upgrading the Database
======================
Run :file:`checksetup.pl`. This will do everything required to convert
your existing database and settings to the new version.
:command:`cd $BUGZILLA_HOME`
:command:`./checksetup.pl`
.. warning:: For some upgrades, running :file:`checksetup.pl` on a large
installation (75,000 or more bugs) can take a long time,
possibly several hours, if e.g. indexes need to be rebuilt. If this
length of downtime would be a problem for you, you can determine
timings for your particular situation by doing a test upgrade on a
development server with the production data.
:file:`checksetup.pl` may also tell you that you need some additional
Perl modules, or newer versions of the ones you have. You will need to
install these, either system-wide or using the :file:`install-module.pl`
script that :file:`checksetup.pl` recommends.
Finishing The Upgrade
=====================
#. Reactivate Bugzilla by clear the text that you put into the
:param:`shutdownhtml` parameter.
#. Run another :ref:`sanity-check` on your
upgraded Bugzilla. It is recommended that you fix any problems
you see immediately. Failure to do this may mean that Bugzilla
may not work entirely correctly.
docs/en/rst/installing/upgrading-with-a-tarball.rst 0 → 100644
View file @ 06033dc9
.. _upgrading-with-a-tarball:
Upgrading with a Tarball
########################
If you are unable (or unwilling) to use Git, another option is to obtain a
tarball of the latest version from our website and upgrade your Bugzilla
installation using that.
Without a source code management system to help you, the process may be
trickier.
.. include:: upgrading-with-1.inc.rst
As you are using a tarball and not an SCM, it's not at all easy to see if
you've made local code customizations. You may have to use institutional
knowledge, or download a fresh copy of your *current* version of Bugzilla
and compare the two directories. If you find that you have, you'll need
to turn them into a patch file, perhaps by diffing the two directories,
and then reapply that patch file later. If you are customizing Bugzilla
locally, please consider
:ref:`rebasing your install on top of git <migrating-from-a-tarball>`.
.. _upgrade-files-tarball:
Getting The New Bugzilla
========================
Download a copy of the latest version of Bugzilla from the
`Download Page <http://www.bugzilla.org/download/>`_ into a separate
directory (which we will call :file:`bugzilla-new`) alongside your existing
Bugzilla installation (which we will assume is in a directory called
:file:`bugzilla`).
Copy Across Data and Modules
============================
Copy the contents of the following directories from your current installation
of Bugzilla into the corresponding directory in :file:`bugzilla-new/`:
.. code-block:: none
lib/
data/
template/en/custom (may or may not exist)
You also need to copy any extensions you have written or installed, which are
in the :file:`extensions/` directory. Bugzilla ships with some extensions,
so again if you want to know if any of the installed extensions are yours,
you may have to compare with a clean copy of your current version. You can
disregard any which have a :file:`disabled` file - those are not enabled.
Lastly, copy the following file from your current installation of Bugzilla
into the corresponding place in :file:`bugzilla-new/`:
.. code-block:: none
localconfig
This file contains your database password and access details.
Swap The New Version In
=======================
Now we swap the directories over. From the directory containing the
:file:`bugzilla` and :file:`bugzilla-new` directories, run:
:command:`mv bugzilla bugzilla-old`
:command:`mv bugzilla-new bugzilla`
:command:`cd bugzilla`
.. include:: upgrading-with-2.inc.rst
docs/en/rst/installing/upgrading-with-git.rst 0 → 100644
View file @ 06033dc9
.. _upgrading-with-git:
Upgrading with Git
##################
Upgrading to new Bugzilla releases is very simple, and you can upgrade
from any version to any later version in one go - there is no need for
intermediate steps. There is a script named :file:`checksetup.pl` included
with Bugzilla that will automatically do all of the database migration
for you.
.. include:: upgrading-with-1.inc.rst
You can see if you have local code customizations using:
:command:`git diff`
If that comes up empty, then run:
:command:`git log | head`
and see if the last commit looks like one made by the Bugzilla team, or
by you. If it looks like it was made by us, then you have made no local
code customizations.
.. _start-upgrade-git:
Starting the Upgrade
====================
When you are ready to go:
#. Shut down your Bugzilla installation by putting some explanatory text
in the :param:`shutdownhtml` parameter.
#. Make all necessary :ref:`backups <backups>`.
*THIS IS VERY IMPORTANT*. If anything goes wrong during the upgrade,
having a backup allows you to roll back to a known good state.
.. _upgrade-files-git:
Getting The New Bugzilla
========================
In the commands below, ``$BUGZILLA_HOME`` represents the directory
in which Bugzilla is installed. Assuming you followed the installation
instructions and your Bugzilla is a checkout of a stable branch,
you can get the latest point release of your current version by simply doing:
:command:`cd $BUGZILLA_HOME`
:command:`git pull`
If you want to upgrade to a newer release of Bugzilla, then you will
additionally need to do:
:command:`git checkout bugzilla-X.X-stable`
where "X.X" is the 2-digit version number of the stable version you want to
upgrade to (e.g. "4.4").
.. note:: Do not attempt to downgrade Bugzilla this way - it won't work.
If you have local code customizations, git will attempt to merge them. If
it fails, then you should implement the plan you came up with when you
detected these customizations in the step above, before you started the
upgrade.
.. include:: upgrading-with-2.inc.rst
docs/en/rst/installing/upgrading.rst 0 → 100644
View file @ 06033dc9
.. _upgrading:
Upgrading
#########
You can upgrade Bugzilla from any version to any later version in one go -
there is no need to pass through intermediate versions unless you are changing
the method by which you obtain the code along the way.
.. warning:: Upgrading is a one-way process. You cannot "downgrade" an
upgraded Bugzilla. If you wish to revert to the old Bugzilla
version for any reason, you will have to restore your system
from a backup. Those with critical data or large installations may wish
to test the upgrade on a development server first, using a copy of the
production data and configuration.
Bugzilla uses the Git version control system to store its code. A modern
Bugzilla installation consists of a checkout of a stable version of the code
from our Git repository. This makes upgrading much easier. If this is
already true of your installation, see :ref:`upgrading-with-git`.
Before Git, we used to use Bazaar and, before that, CVS. If your installation
of Bugzilla consists of a checkout from one of those two systems, you need to
upgrade in three steps:
1. Upgrade to the latest point release of your current Bugzilla version.
2. Move to Git while staying on exactly the same release.
3. Upgrade to the latest Bugzilla using the instructions for :ref:`upgrading-with-git`.
See :ref:`migrating-from-bazaar` or :ref:`migrating-from-cvs` as appropriate.
Some Bugzillas were installed simply by downloading a copy of the code as
an archive file ("tarball"). However, recent tarballs have included source
code management system information, so you may be able to use the Git, Bzr
or CVS instructions.
If you aren't sure which of these categories you fall into, to find out which
version control system your copy of Bugzilla recognizes, look for the
following subdirectories in your root Bugzilla directory:
* :file:`.git`: you installed using Git - follow :ref:`upgrading-with-git`.
* :file:`.bzr`: you installed using Bazaar - follow :ref:`migrating-from-bazaar`.
* :file:`CVS`: you installed using CVS - follow :ref:`migrating-from-cvs`.
* None of the above: you installed using an old tarball - follow
:ref:`migrating-from-a-tarball`.
It is also possible, particularly if your server machine does not have and
cannot be configured to have access to the public internet, to upgrade using
a tarball. See :ref:`upgrading-with-a-tarball`.
Whichever path you use, you may need help with
:ref:`upgrading-customizations`.
.. toctree::
:maxdepth: 1
upgrading-with-git
migrating-from-bzr
migrating-from-cvs
migrating-from-a-tarball
upgrading-with-a-tarball
upgrading-customizations
Bugzilla can automatically notify administrators when new releases are
available if the :param:`upgrade_notification` parameter is set.
Administrators will see these notifications when they access the Bugzilla home
page. Bugzilla will check once per day for new releases. If you are behind a
proxy, you may have to set the :param:`proxy_url` parameter accordingly. If
the proxy requires authentication, use the
:paramval:`http://user:pass@proxy_url/` syntax.
docs/en/rst/installing/windows.rst 0 → 100644
View file @ 06033dc9
.. _windows:
Windows
#######
Making Bugzilla work on Windows is more difficult than making it work on Unix,
fewer Bugzilla developers use it and so it's less well supported. We would
particularly recommend against doing it for a large site. However, if
you are still determined to go ahead, here's how.
.. windows-install-perl:
ActiveState Perl
================
ActiveState make a popular distribution of Perl for Windows.
Download the ActiveState Perl 5.12.4 or higher MSI installer from the
`ActiveState website <http://www.activestate.com/activeperl/downloads>`_.
ActiveState Perl uses a standard Windows Installer. Install, sticking with
the defaults, which will install Perl into :file:`C:\\Perl`. It is not
recommended to install Perl into a directory containing a space, such as
:file:`C:\\Program Files`.
Once the install has completed, log out and log in again to pick up the
changes to the ``PATH`` environment variable.
.. _windows-install-bzfiles:
Bugzilla
========
The best way to get Bugzilla is to check it out from git. Download and install
git from the `git website <http://git-scm.com/download>`_, and then run:
:command:`git clone --branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla C:\\bugzilla`
where "X.X" is the 2-digit version number of the stable release of Bugzilla
that you want (e.g. 4.4).
The rest of this documentation assumes you have installed Bugzilla into
:file:`C:\\bugzilla`. Adjust paths appropriately if not.
If it's not possible to use git (e.g. because your Bugzilla machine has no
internet access), you can
`download a tarball of Bugzilla <http://www.bugzilla.org/download/>`_ and
copy it across. Bugzilla comes as a 'tarball' (:file:`.tar.gz` extension),
which any competent Windows archiving tool should be able to open.
.. windows-install-perl-modules:
Perl Modules
============
Bugzilla requires a number of perl modules to be installed. They are
available in the ActiveState repository, and are installed with the
:file:`ppm` tool. You can either use it on the command line, as below,
or just type :command:`ppm`, and you will get a GUI.
If you use a proxy server or a firewall you may have trouble running PPM.
This is covered in the
`ActivePerl FAQ <http://aspn.activestate.com/ASPN/docs/ActivePerl/faq/ActivePerl-faq2.html#ppm_and_proxies>`_.
Install the following modules with:
:command:`ppm install <modulename>`
* CGI.pm
* Digest-SHA
* TimeDate
* DateTime
* DateTime-TimeZone
* DBI
* Template-Toolkit
* Email-Sender
* Email-MIME
* URI
* List-MoreUtils
* Math-Random-ISAAC
* File-Slurp
* JSON-XS
* Win32
* Win32-API
The following modules enable various optional Bugzilla features; try and
install them, but don't worry too much to begin with if you can't get them
installed:
* GD
* Chart
* Template-GD
* GDTextUtil
* GDGraph
* MIME-tools
* libwww-perl
* XML-Twig
* PatchReader
* perl-ldap
* Authen-SASL
* Net-SMTP-SSL
* RadiusPerl
* SOAP-Lite
* XMLRPC-Lite
* JSON-RPC
* Test-Taint
* HTML-Parser
* HTML-Scrubber
* Encode
* Encode-Detect
* Email-Reply
* HTML-FormatText-WithLinks
* TheSchwartz
* Daemon-Generic
* mod_perl
* Apache-SizeLimit
* File-MimeInfo
* IO-stringy
* Cache-Memcached
* Text-Markdown
* File-Copy-Recursive
* GraphViz
.. warning:: These lists have been extracted from Bugzilla's source code and
have not been tested. Please let us know if you find errors in it
of any sort.
.. note:: The :file:`install-module.pl` script doesn't work with ActivePerl
on Windows.
.. _windows-config-webserver:
Web Server
==========
Any web server that is capable of running CGI scripts can be made to work.
We have specific instructions for the following:
* :ref:`apache-windows`
* :ref:`iis`
.. windows-config-database:
Database Engine
===============
Bugzilla supports MySQL, PostgreSQL, Oracle and SQLite as database servers.
You only require one of these systems to make use of Bugzilla. MySQL is
most commonly used, and is the only one for which Windows instructions have
been tested. SQLite is good for trial installations as it requires no
setup. Configure your server according to the instructions below:
* :ref:`mysql`
* :ref:`postgresql`
* :ref:`oracle`
* :ref:`sqlite`
.. |checksetupcommand| replace:: :command:`checksetup.pl`
.. |testservercommand| replace:: :command:`testserver.pl http://<your-bugzilla-server>/`
.. include:: installing-end.inc.rst
If you don't see the main Bugzilla page, but instead see "It works!!!",
then somehow your Apache has not picked up your modifications to
:file:`httpd.conf`. If you are on Windows 7 or later, this could be due to a
new feature called "VirtualStore". `This blog post
<http://blog.netscraps.com/bugs/apache-httpd-conf-changes-ignored-in-windows-7.html>`_
may help to solve the problem.
If you get an "Internal Error..." message, it could be that
``ScriptInterpreterSource Registry-Strict`` is not set in your
:ref:`Apache configuration <apache-windows>`. Check again if it is set
properly.
Next, do the :ref:`essential-post-install-config`.
docs/en/rst/integrating/apis.rst 0 → 100644
View file @ 06033dc9
.. _api-list:
APIs
####
Bugzilla has a number of APIs that you can call in your code to extract
information from and put information into Bugzilla. Some are deprecated and
will soon be removed. Which one to use? Short answer: the
:ref:`REST WebService API v1 <apis>`
should be used for all new integrations, but keep an eye out for version 2,
coming soon.
The APIs currently available are as follows:
Ad-Hoc APIs
===========
Various pages on Bugzilla are available in machine-parseable formats as well
as HTML. For example, bugs can be downloaded as XML, and buglists as CSV.
CSV is useful for spreadsheet import. There should be links on the HTML page
to alternate data formats where they are available.
XML-RPC
=======
Bugzilla has an `XML-RPC API
<http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Server/XMLRPC.html>`_.
This will receive no further updates and will be removed in a future version
of Bugzilla.
Endpoint: :file:`/xmlrpc.cgi`
JSON-RPC
========
Bugzilla has a `JSON-RPC API
<http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Server/JSONRPC.html>`_.
This will receive no further updates and will be removed in a future version
of Bugzilla.
Endpoint: :file:`/jsonrpc.cgi`
REST
====
Bugzilla has a :ref:`REST API <apis>` which is the currently-recommended API
for integrating with Bugzilla. The current REST API is version 1. It is stable,
and so will not be changed in a backwardly-incompatible way.
**This is the currently-recommended API for new development.**
Endpoint: :file:`/rest`
BzAPI/BzAPI-Compatible REST
===========================
The first ever REST API for Bugzilla was implemented using an external proxy
called `BzAPI <https://wiki.mozilla.org/Bugzilla:BzAPI>`_. This became popular
enough that a BzAPI-compatible shim on top of the (native) REST API has been
written, to allow code which used the BzAPI API to take advantage of the
speed improvements of direct integration without needing to be rewritten.
The shim is an extension which you would need to install in your Bugzilla.
Neither BzAPI nor this BzAPI-compatible API shim will receive any further
updates, and they should not be used for new code.
REST v2
=======
The future of Bugzilla's APIs is version 2 of the REST API, which will take
the best of the current REST API and the BzAPI API. It is still under
development.
docs/en/rst/integrating/extensions.rst 0 → 100644
View file @ 06033dc9
.. _extensions:
Extensions
##########
One of the best ways to customize Bugzilla is by using a Bugzilla
Extension. Extensions can modify both the code and UI of Bugzilla in a way
that can be distributed to other Bugzilla users and ported forward to future
versions of Bugzilla with minimal effort. We maintain a
`list of available extensions <https://wiki.mozilla.org/Bugzilla:Addons>`_
written by other people on our wiki. You would need to
make sure that the extension in question works with your version of Bugzilla.
Or, you can write your own extension. See the `Bugzilla Extension
documentation <../html/api/Bugzilla/Extension.html>`_ for the core
documentation on how to do that. It would make sense to read
the section on :ref:`templates`. There is also a sample extension in
:file:`$BUGZILLA_HOME/extensions/Example/` which gives examples of how to
use all the code hooks.
This section explains how to achieve some common tasks using the Extension APIs.
Adding A New Page to Bugzilla
=============================
There are occasions where it's useful to add a new page to Bugzilla which
has little or no relation to other pages, and perhaps doesn't use very much
Bugzilla data. A help page, or a custom report for example. The best mechanism
for this is to use :file:`page.cgi` and the ``page_before_template`` hook.
Altering Data On An Existing Page
=================================
The ``template_before_process`` hook can be used to tweak the data displayed
on a particular existing page, if you know what template is used. It has
access to all the template variables before they are passed to the templating
engine.
Adding New Fields To Bugs
=========================
To add new fields to a bug, you need to do the following:
* Add an ``install_update_db`` hook to add the fields by calling
``Bugzilla::Field->create`` (only if the field doesn't already exist).
Here's what it might look like for a single field:
.. code-block:: perl
my $field = new Bugzilla::Field({ name => $name });
return if $field;
$field = Bugzilla::Field->create({
name => $name,
description => $description,
type => $type, # From list in Constants.pm
enter_bug => 0,
buglist => 0,
custom => 1,
});
* Push the name of the field onto the relevant arrays in the ``bug_columns``
and ``bug_fields`` hooks.
* If you want direct accessors, or other functions on the object, you need to
add a BEGIN block to your Extension.pm:
.. code-block:: perl
BEGIN {
*Bugzilla::Bug::is_foopy = \&_bug_is_foopy;
}
...
sub _bug_is_foopy {
return $_[0]->{'is_foopy'};
}
* You don't have to change ``Bugzilla/DB/Schema.pm``.
* You can use ``bug_end_of_create``, ``bug_end_of_create_validators``, and
``bug_end_of_update`` to create or update the values for your new field.
Adding New Fields To Other Things
=================================
If you are adding the new fields to an object other than a bug, you need to
go a bit lower-level. With reference to the instructions above:
* In ``install_update_db``, use ``bz_add_column`` instead
* Push on the columns in ``object_columns`` and ``object_update_columns``
instead of ``bug_columns``.
* Add validators for the values in ``object_validators``
The process for adding accessor functions is the same.
You can use the hooks ``object_end_of_create``,
``object_end_of_create_validators``, ``object_end_of_set_all``, and
``object_end_of_update`` to create or update the values for the new object
fields you have added. In the hooks you can check the object type being
operated on and skip any objects you don't care about. For example, if you
added a new field to the ``products`` table:
.. code-block:: perl
sub object_end_of_create {
my ($self, $args) = @_;
my $class = $args->{'class'};
my $object = $args->{'object'};
if ($class->isa('Bugzilla::Product') {
[...]
}
}
You will need to do this filtering for most of the hooks whose names begin with
``object_``.
Adding Admin Configuration Panels
=================================
If you add new functionality to Bugzilla, it may well have configurable
options or parameters. The way to allow an administrator to set those
is to add a new configuration panel.
As well as using the ``config_add_panels`` hook, you will need a template to
define the UI strings for the panel. See the templates in
:file:`template/en/default/admin/params` for examples, and put your own
template in :file:`template/en/default/admin/params` in your extension's
directory.
You can access param values from Templates using::
[% Param('param_name') %]
and from code using:
.. code-block:: perl
Bugzilla->params->{'param_name'}
Adding User Preferences
=======================
To add a new user preference:
* Call ``add_setting('setting_name', ['some_option', 'another_option'],
'some_option')`` in the ``install_before_final_checks`` hook. (The last
parameter is the name of the option which should be the default.)
* Add descriptions for the identifiers for your setting and choices
(setting_name, some_option etc.) to the hash defined in
:file:`global/setting-descs.none.tmpl`. Do this in a template hook:
:file:`hook/global/setting-descs-settings.none.tmpl`. Your code can see the
hash variable; just set more members in it.
* To change behaviour based on the setting, reference it in templates using
``[% user.settings.setting_name.value %]``. Reference it in code using
``$user->settings->{'setting_name'}->{'value'}``. The value will be one of
the option tag names (e.g. some_option).
.. _who-can-change-what:
Altering Who Can Change What
============================
Companies often have rules about which employees, or classes of employees,
are allowed to change certain things in the bug system. For example,
only the bug's designated QA Contact may be allowed to VERIFY the bug.
Bugzilla has been
designed to make it easy for you to write your own custom rules to define
who is allowed to make what sorts of value transition.
By default, assignees, QA owners and users
with *editbugs* privileges can edit all fields of bugs,
except group restrictions (unless they are members of the groups they
are trying to change). Bug reporters also have the ability to edit some
fields, but in a more restrictive manner. Other users, without
*editbugs* privileges, cannot edit
bugs, except to comment and add themselves to the CC list.
Because this kind of change is such a common request, we have added a
specific hook for it that :ref:`extensions` can call. It's called
``bug_check_can_change_field``, and it's documented `in the Hooks
documentation <http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/Hook.html#bug_check_can_change_field>`_.
Checking Syntax
===============
It's not immediately obvious how to check the syntax of your extension's
Perl modules, if it contains any. Running :command:`checksetup.pl` might do
some of it, but the errors aren't necessarily massively informative.
:command:`perl -Mlib=lib -MBugzilla -e 'BEGIN { Bugzilla->extensions; } use Bugzilla::Extension::ExtensionName::Class;'`
(run from ``$BUGZILLA_HOME``) is what you need.
docs/en/rst/integrating/faq.rst 0 → 100644
View file @ 06033dc9
.. _customization-faq:
Customization FAQ
=================
How do I...
...add a new field on a bug?
Use :ref:`custom-fields` or, if you just want new form fields on bug entry
but don't need Bugzilla to track the field seperately thereafter, you can
use a :ref:`custom bug entry form <custom-bug-entry>`.
...change the name of a built-in bug field?
:ref:`Edit <templates>` the relevant value in the template
:file:`template/en/default/global/field-descs.none.tmpl`.
...use a word other than 'bug' to describe bugs?
:ref:`Edit or override <templates>` the appropriate values in the template
:file:`template/en/default/global/variables.none.tmpl`.
...call the system something other than 'Bugzilla'?
:ref:`Edit or override <templates>` the appropriate value in the template
:file:`template/en/default/global/variables.none.tmpl`.
...alter who can change what field when?
See :ref:`who-can-change-what`.
docs/en/rst/integrating/index.rst 0 → 100644
View file @ 06033dc9
.. highlight:: perl
.. _integrating:
===================================
Integration and Customization Guide
===================================
You may find that Bugzilla already does what you want it to do, you just
need to configure it correctly. Read the :ref:`administering` sections
carefully to see if that's the case for you. If not, then this chapter
explains how to use the available mechanisms for integration and customization.
.. toctree::
:maxdepth: 2
faq
languages
skins
templates
extensions
apis
docs/en/rst/integrating/languages.rst 0 → 100644
View file @ 06033dc9
Languages
=========
Bugzilla's templates can be localized, although it's a `big job
<https://wiki.mozilla.org/Bugzilla:L10n:Guide>`_. If you have
a localized set of templates for your version of Bugzilla, Bugzilla can
support multiple languages at once. In that case, Bugzilla honours the user's
``Accept-Language`` HTTP header when deciding which language to serve. If
multiple languages are installed, a menu will display in the header allowing
the user to manually select a different language. If they do this, their
choice will override the ``Accept-Language`` header.
Many language templates can be obtained from
`the localization section of the Bugzilla website
<http://www.bugzilla.org/download.html#localizations>`_. Instructions
for submitting new languages are also available from that location. There's
also a `list of localization teams
<https://wiki.mozilla.org/Bugzilla:L10n:Localization_Teams>`_; you might
want to contact someone to ask about the status of their localization.
docs/en/rst/integrating/skins.rst 0 → 100644
View file @ 06033dc9
.. _skins:
Skins
=====
Bugzilla supports skins - ways of changing the look of the UI without altering
its underlying structure. It ships with two - "Classic" and "Dusk". You can
find some more listed
`on the wiki <https://wiki.mozilla.org/Bugzilla:Addons#Skins>`_, and there
are a couple more which are part of
`bugzilla.mozilla.org <http://git.mozilla.org/?p=webtools/bmo/bugzilla.git>`_.
However, in each
case you may need to check that the skin supports the version of Bugzilla
you have.
To create a new custom skin, make a directory that contains all the same CSS
file names as :file:`skins/standard/`, and put your directory in
:file:`skins/contrib/`. Then, add your CSS to the appropriate files.
After you put the directory there, make sure to run :file:`checksetup.pl` so
that it can set the file permissions correctly.
After you have installed the new skin, it will show up as an option in the
user's :guilabel:`Preferences`, on the :guilabel:`General` tab. If you would
like to force a particular skin on all users, just select that skin in the
:guilabel:`Default Preferences` in the :guilabel:`Administration` UI, and
then uncheck "Enabled" on the preference, so users cannot change it.
docs/en/rst/modules.rst deleted 100644 → 0
View file @ 8ebd893e
.. highlight:: console
.. _install-perlmodules-manual:
===================================
Manual Installation of Perl Modules
===================================
.. _modules-manual-instructions:
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:
::
# tar -xzvf <module>.tar.gz
# cd <module>
# perl Makefile.PL
# make
# make test
# make install
.. note:: In order to compile source code under Windows you will need to obtain
a 'make' utility. The :command:`nmake` utility provided with
Microsoft Visual C++ may be used. As an alternative, there is a
utility called :command:`dmake` available from CPAN which is
written entirely in Perl.
As described in :ref:`modules-manual-download`, however, most
packages already exist and are available from ActiveState or theory58S.
We highly recommend that you install them using the ppm GUI available with
ActiveState and to add the theory58S repository to your list of repositories.
.. _modules-manual-download:
Download Locations
##################
.. note:: Running Bugzilla on Windows requires the use of ActiveState
Perl |min-perl-ver| or higher. Many modules already exist in the core
distribution of ActiveState Perl. Additional modules can be downloaded
from `<http://cpan.uwinnipeg.ca/PPMPackages/10xx/>`_
if you use Perl |min-perl-ver|.
CGI:
* CPAN Download Page: `<http://search.cpan.org/dist/CGI.pm/>`_
* Documentation: `<http://perldoc.perl.org/CGI.html>`_
Data-Dumper:
* CPAN Download Page: `<http://search.cpan.org/dist/Data-Dumper/>`_
* Documentation: `<http://search.cpan.org/dist/Data-Dumper/Dumper.pm>`_
Date::Format (part of TimeDate):
* CPAN Download Page: `<http://search.cpan.org/dist/TimeDate/>`_
* Documentation: `<http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm>`_
DBI:
* CPAN Download Page: `<http://search.cpan.org/dist/DBI/>`_
* Documentation: `<http://dbi.perl.org/docs/>`_
DBD::mysql:
* CPAN Download Page: `<http://search.cpan.org/dist/DBD-mysql/>`_
* Documentation: `<http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm>`_
DBD::Pg:
* CPAN Download Page: `<http://search.cpan.org/dist/DBD-Pg/>`_
* Documentation: `<http://search.cpan.org/dist/DBD-Pg/Pg.pm>`_
Template-Toolkit:
* CPAN Download Page: `<http://search.cpan.org/dist/Template-Toolkit/>`_
* Documentation: `<http://www.template-toolkit.org/docs.html>`_
GD:
* CPAN Download Page: `<http://search.cpan.org/dist/GD/>`_
* Documentation: `<http://search.cpan.org/dist/GD/GD.pm>`_
Template::Plugin::GD:
* CPAN Download Page: `<http://search.cpan.org/dist/Template-GD/>`_
* Documentation: `<http://www.template-toolkit.org/docs/aqua/Modules/index.html>`_
MIME::Parser (part of MIME-tools):
* CPAN Download Page: `<http://search.cpan.org/dist/MIME-tools/>`_
* Documentation: `<http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm>`_
.. _modules-manual-optional:
Optional Modules
################
Chart::Lines:
* CPAN Download Page: `<http://search.cpan.org/dist/Chart/>`_
* Documentation: `<http://search.cpan.org/dist/Chart/Chart.pod>`_
GD::Graph:
* CPAN Download Page: `<http://search.cpan.org/dist/GDGraph/>`_
* Documentation: `<http://search.cpan.org/dist/GDGraph/Graph.pm>`_
GD::Text::Align (part of GD::Text::Util):
* CPAN Download Page: `<http://search.cpan.org/dist/GDTextUtil/>`_
* Documentation: `<http://search.cpan.org/dist/GDTextUtil/Text/Align.pm>`_
XML::Twig:
* CPAN Download Page: `<http://search.cpan.org/dist/XML-Twig/>`_
* Documentation: `<http://standards.ieee.org/resources/spasystem/twig/twig_stable.html>`_
PatchReader:
* CPAN Download Page: `<http://search.cpan.org/author/JKEISER/PatchReader/>`_
* Documentation: `<http://www.johnkeiser.com/mozilla/Patch_Viewer.html>`_
docs/en/rst/patches.rst deleted 100644 → 0
View file @ 8ebd893e
.. _patches:
=======
Contrib
=======
There are a number of unofficial Bugzilla add-ons in the
:file:`$BUGZILLA_ROOT/contrib/`
directory. This section documents them.
.. _cmdline:
Command-line Search Interface
#############################
There are a suite of Unix utilities for searching Bugzilla from the
command line. They live in the
:file:`contrib/cmdline` directory.
There are three files - :file:`query.conf`,
:file:`buglist` and :file:`bugs`.
.. warning:: These files pre-date the templatization work done as part of the
2.16 release, and have not been updated.
:file:`query.conf` contains the mapping from
options to field names and comparison types. Quoted option names
are ``grepped`` for, so it should be easy to edit this
file. Comments (#) have no effect; you must make sure these lines
do not contain any quoted ``option``.
:file:`buglist` is a shell script that submits a
Bugzilla query and writes the resulting HTML page to stdout.
It supports both short options, (such as ``-Afoo``
or ``-Rbar``) and long options (such
as ``--assignedto=foo`` or ``--reporter=bar``).
If the first character of an option is not ``-``, it is
treated as if it were prefixed with ``--default=``.
The column list is taken from the COLUMNLIST environment variable.
This is equivalent to the ``Change Columns`` option
that is available when you list bugs in buglist.cgi. If you have
already used Bugzilla, grep for COLUMNLIST in your cookies file
to see your current COLUMNLIST setting.
:file:`bugs` is a simple shell script which calls
:file:`buglist` and extracts the
bug numbers from the output. Adding the prefix
``http://bugzilla.mozilla.org/buglist.cgi?bug_id=``
turns the bug list into a working link if any bugs are found.
Counting bugs is easy. Pipe the results through
:command:`sed -e 's/,/ /g' | wc | awk '{printf $2 "\\n"}'`
Akkana Peck says she has good results piping
:file:`buglist` output through
:command:`w3m -T text/html -dump`
.. _cmdline-bugmail:
Command-line 'Send Unsent Bug-mail' tool
########################################
Within the :file:`contrib` directory
exists a utility with the descriptive (if compact) name
of :file:`sendunsentbugmail.pl`. The purpose of this
script is, simply, to send out any bug-related mail that should
have been sent by now, but for one reason or another has not.
To accomplish this task, :file:`sendunsentbugmail.pl` uses
the same mechanism as the :file:`sanitycheck.cgi` script;
it scans through the entire database looking for bugs with changes that
were made more than 30 minutes ago, but where there is no record of
anyone related to that bug having been sent mail. Having compiled a list,
it then uses the standard rules to determine who gets mail, and sends it
out.
As the script runs, it indicates the bug for which it is currently
sending mail; when it has finished, it gives a numerical count of how
many mails were sent and how many people were excluded. (Individual
user names are not recorded or displayed.) If the script produces
no output, that means no unsent mail was detected.
*Usage*: move the sendunsentbugmail.pl script
up into the main directory, ensure it has execute permission, and run it
from the command line (or from a cron job) with no parameters.
docs/en/rst/security.rst deleted 100644 → 0
View file @ 8ebd893e
.. _security:
=================
Bugzilla Security
=================
While some of the items in this chapter are related to the operating
system Bugzilla is running on or some of the support software required to
run Bugzilla, it is all related to protecting your data. This is not
intended to be a comprehensive guide to securing Linux, Apache, MySQL, or
any other piece of software mentioned. There is no substitute for active
administration and monitoring of a machine. The key to good security is
actually right in the middle of the word: *U R It*.
While programmers in general always strive to write secure code,
accidents can and do happen. The best approach to security is to always
assume that the program you are working with isn't 100% secure and restrict
its access to other parts of your machine as much as possible.
.. _security-os:
Operating System
################
.. _security-os-ports:
TCP/IP Ports
============
.. COMMENT: TODO: Get exact number of ports
The TCP/IP standard defines more than 65,000 ports for sending
and receiving traffic. Of those, Bugzilla needs exactly one to operate
(different configurations and options may require up to 3). You should
audit your server and make sure that you aren't listening on any ports
you don't need to be. It's also highly recommended that the server
Bugzilla resides on, along with any other machines you administer, be
placed behind some kind of firewall.
.. _security-os-accounts:
System User Accounts
====================
Many daemons, such
as Apache's :file:`httpd` or MySQL's
:file:`mysqld`, run as either ``root`` or
``nobody``. This is even worse on Windows machines where the
majority of services
run as ``SYSTEM``. While running as ``root`` or
``SYSTEM`` introduces obvious security concerns, the
problems introduced by running everything as ``nobody`` may
not be so obvious. Basically, if you run every daemon as
``nobody`` and one of them gets compromised it can
compromise every other daemon running as ``nobody`` on your
machine. For this reason, it is recommended that you create a user
account for each daemon.
.. note:: You will need to set the ``webservergroup`` option
in :file:`localconfig` to the group your web server runs
as. This will allow :file:`./checksetup.pl` to set file
permissions on Unix systems so that nothing is world-writable.
.. _security-os-chroot:
The :file:`chroot` Jail
=======================
If your system supports it, you may wish to consider running
Bugzilla inside of a :file:`chroot` jail. This option
provides unprecedented security by restricting anything running
inside the jail from accessing any information outside of it. If you
wish to use this option, please consult the documentation that came
with your system.
.. _security-webserver:
Web server
##########
.. _security-webserver-access:
Disabling Remote Access to Bugzilla Configuration Files
=======================================================
There are many files that are placed in the Bugzilla directory
area that should not be accessible from the web server. Because of the way
Bugzilla is currently layed out, the list of what should and should not
be accessible is rather complicated. A quick way is to run
:file:`testserver.pl` to check if your web server serves
Bugzilla files as expected. If not, you may want to follow the few
steps below.
.. note:: Bugzilla ships with the ability to create :file:`.htaccess`
files that enforce these rules. Instructions for enabling these
directives in Apache can be found in :ref:`http-apache`
- In the main Bugzilla directory, you should:
- Block: :file:`*.pl`, :file:`*localconfig*`
- In :file:`data`:
- Block everything
- In :file:`data/webdot`:
- If you use a remote webdot server:
- Block everything
- But allow :file:`*.dot`
only for the remote webdot server
- Otherwise, if you use a local GraphViz:
- Block everything
- But allow: :file:`*.png`, :file:`*.gif`, :file:`*.jpg`, :file:`*.map`
- And if you don't use any dot:
- Block everything
- In :file:`Bugzilla`:
- Block everything
- In :file:`template`:
- Block everything
Be sure to test that data that should not be accessed remotely is
properly blocked. Of particular interest is the localconfig file which
contains your database password. Also, be aware that many editors
create temporary and backup files in the working directory and that
those should also not be accessible. For more information, see
`bug 186383 <http://bugzilla.mozilla.org/show_bug.cgi?id=186383>`_
or
`Bugtraq ID 6501 <http://online.securityfocus.com/bid/6501>`_.
To test, simply run :file:`testserver.pl`, as said above.
.. note:: Be sure to check :ref:`http` for instructions
specific to the web server you use.
.. _security-bugzilla:
Bugzilla
########
.. _security-bugzilla-charset:
Prevent users injecting malicious Javascript
============================================
If you installed Bugzilla version 2.22 or later from scratch,
then the *utf8* parameter is switched on by default.
This makes Bugzilla explicitly set the character encoding, following
`a
CERT advisory <http://www.cert.org/tech_tips/malicious_code_mitigation.html#3>`_ recommending exactly this.
The following therefore does not apply to you; just keep
*utf8* turned on.
If you've upgraded from an older version, then it may be possible
for a Bugzilla user to take advantage of character set encoding
ambiguities to inject HTML into Bugzilla comments.
This could include malicious scripts.
This is because due to internationalization concerns, we are unable to
turn the *utf8* parameter on by default for upgraded
installations.
Turning it on manually will prevent this problem.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment