diff options
Diffstat (limited to 'docs')
82 files changed, 6936 insertions, 7092 deletions
@@ -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 diff --git a/docs/en/images/bugzilla.png b/docs/en/images/bugzilla.png new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/docs/en/images/bugzilla.png diff --git a/docs/en/rst/_static/bugzilla.css b/docs/en/rst/_static/bugzilla.css index c3d8ea781..06f5c8375 100644 --- a/docs/en/rst/_static/bugzilla.css +++ b/docs/en/rst/_static/bugzilla.css @@ -1,3 +1,21 @@ @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; +} diff --git a/docs/en/rst/about.rst b/docs/en/rst/about.rst deleted file mode 100644 index 3ebde939d..000000000 --- a/docs/en/rst/about.rst +++ /dev/null @@ -1,177 +0,0 @@ - - -.. _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. - diff --git a/docs/en/rst/about/index.rst b/docs/en/rst/about/index.rst new file mode 100644 index 000000000..239c6ecea --- /dev/null +++ b/docs/en/rst/about/index.rst @@ -0,0 +1,128 @@ +.. _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. diff --git a/docs/en/rst/administering/categorization.rst b/docs/en/rst/administering/categorization.rst new file mode 100644 index 000000000..8e0242980 --- /dev/null +++ b/docs/en/rst/administering/categorization.rst @@ -0,0 +1,416 @@ +.. _categorization: + +=============================================================== +Classifications, Products, Components, Versions, and Milestones +=============================================================== + +Bugs in Bugzilla are classified into one of a set of admin-defined Components. +Components are themselves each part of a single Product. Optionally, Products +can be part of a single Classification, adding a third level to the hierarchy. + +.. _classifications: + +Classifications +############### + +Classifications are used to group several related products into one +distinct entity. + +For example, if a company makes computer games, +they could have a classification of "Games", and a separate +product for each game. This company might also have a +``Common`` classification, containing products representing units of +technology used in multiple games, and perhaps an ``Other`` classification +containing a few special products that represent items that are not actually +shipping products (for example, "Website", or "Administration"). + +The classifications layer is disabled by default; it can be turned +on or off using the :param:`useclassification` parameter +in the *Bug Fields* section of :ref:`parameters`. + +Access to the administration of classifications is controlled using +the *editclassifications* system group, which defines +a privilege for creating, destroying, and editing classifications. + +When activated, classifications will introduce an additional +step when filling bugs (dedicated to classification selection), and they +will also appear in the advanced search form. + +.. _products: + +Products +######## + +Products usually represent real-world shipping products. +Many of Bugzilla's settings are configurable on a per-product basis. + +When creating or editing products the following options are +available: + +Product + The name of the product + +Description + A brief description of the product + +Open for bug entry + Deselect this box to prevent new bugs from being + entered against this product. + +Enable the UNCONFIRMED status in this product + Select this option if you want to use the UNCONFIRMED status + (see :ref:`workflow`) + +Default milestone + Select the default milestone for this product. + +Version + Specify the default version for this product. + +Create chart datasets for this product + Select to make chart datasets available for this product. + +It is compulsory to create at least one :ref:`component <components>` in a product, and +so you will be asked for the details of that too. + +When editing a product you can change all of the above, and there is also a +link to edit Group Access Controls; see :ref:`product-group-controls`. + +.. _create-product: + +Creating New Products +===================== + +To create a new product: + +#. Select ``Administration`` from the footer and then + choose ``Products`` from the main administration page. + +#. Select the ``Add`` link in the bottom right. + +#. Enter the details as outlined above. + +.. _edit-products: + +Editing Products +================ + +To edit an existing product, click the "Products" link from the +"Administration" page. If the :param:`useclassification` parameter is +turned on, a table of existing classifications is displayed, +including an "Unclassified" category. The table indicates how many products +are in each classification. Click on the classification name to see its +products. If the :param:`useclassification` parameter is not in use, the table +lists all products directly. The product table summarizes the information +defined when the product was created. Click on the product name to edit these +properties, and to access links to other product attributes such as the +product's components, versions, milestones, and group access controls. + +.. _comps-vers-miles-products: + +Adding or Editing Components, Versions and Target Milestones +============================================================ + +To add new or edit existing Components, Versions, or Target Milestones +to a Product, select the "Edit Components", "Edit Versions", or "Edit +Milestones" links from the "Edit Product" page. A table of existing +Components, Versions, or Milestones is displayed. Click on an item name +to edit the properties of that item. Below the table is a link to add +a new Component, Version, or Milestone. + +For more information on components, see :ref:`components`. + +For more information on versions, see :ref:`versions`. + +For more information on milestones, see :ref:`milestones`. + +.. _product-group-controls: + +Assigning Group Controls to Products +==================================== + +On the ``Edit Product`` page, there is a link called +``Edit Group Access Controls``. The settings on this page +control the relationship of the groups to the product being edited. + +Group Access Controls are an important aspect of using groups for +isolating products and restricting access to bugs filed against those +products. For more information on groups, including how to create, edit, +add users to, and alter permission of, see :ref:`groups`. + +After selecting the "Edit Group Access Controls" link from the "Edit +Product" page, a table containing all user-defined groups for this +Bugzilla installation is displayed. The system groups that are created +when Bugzilla is installed are not applicable to Group Access Controls. +Below is description of what each of these fields means. + +Groups may be applicable (i.e. bugs in this product can be associated +with this group), default (i.e. bugs in this product are in this group +by default), and mandatory (i.e. bugs in this product must be associated +with this group) for each product. Groups can also control access +to bugs for a given product, or be used to make bugs for a product +totally read-only unless the group restrictions are met. The best way to +understand these relationships is by example. See +:ref:`group-control-examples` for examples of +product and group relationships. + +.. note:: Products and Groups are not limited to a one-to-one relationship. + Multiple groups can be associated with the same product, and groups + can be associated with more than one product. + +If any group has *Entry* selected, then the +product will restrict bug entry to only those users +who are members of *all* the groups with +*Entry* selected. + +If any group has *Canedit* selected, +then the product will be read-only for any users +who are not members of *all* of the groups with +*Canedit* selected. *Only* users who +are members of all the *Canedit* groups +will be able to edit bugs for this product. This is an additional +restriction that enables finer-grained control over products rather +than just all-or-nothing access levels. + +The following settings let you +choose privileges on a *per-product basis*. +This is a convenient way to give privileges to +some users for some products only, without having +to give them global privileges which would affect +all products. + +Any group having *editcomponents* +selected allows users who are in this group to edit all +aspects of this product, including components, milestones, +and versions. + +Any group having *canconfirm* selected +allows users who are in this group to confirm bugs +in this product. + +Any group having *editbugs* selected allows +users who are in this group to edit all fields of +bugs in this product. + +The *MemberControl* and +*OtherControl* are used in tandem to determine which +bugs will be placed in this group. The only allowable combinations of +these two parameters are listed in a table on the "Edit Group Access Controls" +page. Consult this table for details on how these fields can be used. +Examples of different uses are described below. + +.. _group-control-examples: + +Common Applications of Group Controls +===================================== + +The use of groups is best explained by providing examples that illustrate +configurations for common use cases. The examples follow a common syntax: +*Group: Entry, MemberControl, OtherControl, CanEdit, +EditComponents, CanConfirm, EditBugs*, where "Group" is the name +of the group being edited for this product. The other fields all +correspond to the table on the "Edit Group Access Controls" page. If any +of these options are not listed, it means they are not checked. + +Basic Product/Group Restriction +------------------------------- + +Suppose there is a product called "Bar". You would like to make it so that only +users in the group "Foo" can enter bugs in the "Bar" product. Additionally, +bugs filed in product "Bar" must be visible only to users in "Foo" (plus, by +default, the reporter, assignee, and CC list of each bug) at all times. +Furthermore, only members of group "Foo" should be able to edit bugs filed +against product "Bar", even if other users could see the bug. This arrangement +would achieved by the following: + +:: + + Product Bar: + foo: ENTRY, MANDATORY/MANDATORY, CANEDIT + +Perhaps such strict restrictions are not needed for product "Bar". Instead, +you would like to make it so that only members of group "Foo" can +enter bugs in product "Bar", but bugs in "Bar" are not required to be +restricted in visibility to people in "Foo". Anyone with permission +to edit a particular bug in product "Bar" can put the bug in group "Foo", even +if they themselves are not in "Foo". + +Furthermore, anyone in group "Foo" can edit all aspects of the components of +product "Bar", can confirm bugs in product "Bar", and can edit all fields of +any bug in product "Bar". That would be done like this: + +:: + + Product Bar: + foo: ENTRY, SHOWN/SHOWN, EDITCOMPONENTS, CANCONFIRM, EDITBUGS + +General User Access With Security Group +--------------------------------------- + +To permit any user to file bugs against "Product A", +and to permit any user to submit those bugs into a +group called "Security": + +:: + + Product A: + security: SHOWN/SHOWN + +General User Access With A Security Product +------------------------------------------- + +To permit any user to file bugs against product called "Security" +while keeping those bugs from becoming visible to anyone +outside the group "SecurityWorkers" (unless a member of the +"SecurityWorkers" group removes that restriction): + +:: + + Product Security: + securityworkers: DEFAULT/MANDATORY + +Product Isolation With a Common Group +------------------------------------- + +To permit users of "Product A" to access the bugs for +"Product A", users of "Product B" to access the bugs for +"Product B", and support staff, who are members of the "Support +Group" to access both, three groups are needed: + +#. Support Group: Contains members of the support staff. + +#. AccessA Group: Contains users of product A and the Support group. + +#. AccessB Group: Contains users of product B and the Support group. + +Once these three groups are defined, the product group controls +can be set to: + +:: + + Product A: + AccessA: ENTRY, MANDATORY/MANDATORY + Product B: + AccessB: ENTRY, MANDATORY/MANDATORY + +Perhaps the "Support Group" wants more control. For example, +the "Support Group" could be permitted to make bugs inaccessible to +users of both groups "AccessA" and "AccessB". +Then, the "Support Group" could be permitted to publish +bugs relevant to all users in a third product (let's call it +"Product Common") that is read-only +to anyone outside the "Support Group". In this way the "Support Group" +could control bugs that should be seen by both groups. +That configuration would be: + +:: + + Product A: + AccessA: ENTRY, MANDATORY/MANDATORY + Support: SHOWN/NA + Product B: + AccessB: ENTRY, MANDATORY/MANDATORY + Support: SHOWN/NA + Product Common: + Support: ENTRY, DEFAULT/MANDATORY, CANEDIT + +Make a Product Read Only +------------------------ + +Sometimes a product is retired and should no longer have +new bugs filed against it (for example, an older version of a software +product that is no longer supported). A product can be made read-only +by creating a group called "readonly" and adding products to the +group as needed: + +:: + + Product A: + ReadOnly: ENTRY, NA/NA, CANEDIT + +.. note:: For more information on Groups outside of how they relate to products + see :ref:`groups`. + +.. _components: + +Components +########## + +Components are subsections of a Product. E.g. the computer game +you are designing may have a "UI" +component, an "API" component, a "Sound System" component, and a +"Plugins" component, each overseen by a different programmer. It +often makes sense to divide Components in Bugzilla according to the +natural divisions of responsibility within your Product or +company. + +Each component has a default assignee and, if you turned it on in the :ref:`parameters`, +a QA Contact. The default assignee should be the primary person who fixes bugs in +that component. The QA Contact should be the person who will ensure +these bugs are completely fixed. The Assignee, QA Contact, and Reporter +will get email when new bugs are created in this Component and when +these bugs change. Default Assignee and Default QA Contact fields only +dictate the *default assignments*; +these can be changed on bug submission, or at any later point in +a bug's life. + +To create a new Component: + +#. Select the ``Edit components`` link + from the ``Edit product`` page. + +#. Select the ``Add`` link in the bottom right. + +#. Fill out the ``Component`` field, a + short ``Description``, the + ``Default Assignee``, ``Default CC List``, + and ``Default QA Contact`` (if enabled). + The ``Component Description`` field may contain a + limited subset of HTML tags. The ``Default Assignee`` + field must be a login name already existing in the Bugzilla database. + +.. _versions: + +Versions +######## + +Versions are the revisions of the product, such as "Flinders +3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select +field; the usual practice is to select the earliest version known to have +the bug. + +To create and edit Versions: + +#. From the "Edit product" screen, select "Edit Versions". + +#. You will notice that the product already has the default + version "undefined". Click the "Add" link in the bottom right. + +#. Enter the name of the Version. This field takes text only. + Then click the "Add" button. + +.. _milestones: + +Milestones +########## + +Milestones are "targets" that you plan to get a bug fixed by. For +example, if you have a bug that you plan to fix for your 3.0 release, it +would be assigned the milestone of 3.0. + +.. note:: Milestone options will only appear for a Product if you turned + on the :param:`usetargetmilestone` parameter in the "Bug Fields" tab of the + :ref:`parameters` page. + +To create new Milestones and set Default Milestones: + +#. Select "Edit milestones" from the "Edit product" page. + +#. Select "Add" in the bottom right corner. + +#. Enter the name of the Milestone in the "Milestone" field. You + can optionally set the "sortkey", which is a positive or negative + number (-32768 to 32767) that defines where in the list this particular + milestone appears. This is because milestones often do not + occur in alphanumeric order; for example, "Future" might be + after "Release 1.2". Select "Add". diff --git a/docs/en/rst/administering/custom-fields.rst b/docs/en/rst/administering/custom-fields.rst new file mode 100644 index 000000000..29cc72e62 --- /dev/null +++ b/docs/en/rst/administering/custom-fields.rst @@ -0,0 +1,149 @@ +.. _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. + diff --git a/docs/en/rst/administering/extensions.rst b/docs/en/rst/administering/extensions.rst new file mode 100644 index 000000000..0d5a216af --- /dev/null +++ b/docs/en/rst/administering/extensions.rst @@ -0,0 +1,18 @@ +.. _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/* diff --git a/docs/en/rst/administering/field-values.rst b/docs/en/rst/administering/field-values.rst new file mode 100644 index 000000000..b7380cbdf --- /dev/null +++ b/docs/en/rst/administering/field-values.rst @@ -0,0 +1,45 @@ +.. _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. diff --git a/docs/en/rst/administering/flags.rst b/docs/en/rst/administering/flags.rst new file mode 100644 index 000000000..0b13690a3 --- /dev/null +++ b/docs/en/rst/administering/flags.rst @@ -0,0 +1,155 @@ +.. _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. diff --git a/docs/en/rst/administering/groups.rst b/docs/en/rst/administering/groups.rst new file mode 100644 index 000000000..a14bb689e --- /dev/null +++ b/docs/en/rst/administering/groups.rst @@ -0,0 +1,191 @@ +.. _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`. + diff --git a/docs/en/rst/administering/index.rst b/docs/en/rst/administering/index.rst new file mode 100644 index 000000000..c47819323 --- /dev/null +++ b/docs/en/rst/administering/index.rst @@ -0,0 +1,26 @@ +.. _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 diff --git a/docs/en/rst/administering/keywords.rst b/docs/en/rst/administering/keywords.rst new file mode 100644 index 000000000..245bcbe4c --- /dev/null +++ b/docs/en/rst/administering/keywords.rst @@ -0,0 +1,16 @@ +.. _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. + diff --git a/docs/en/rst/administering/parameters.rst b/docs/en/rst/administering/parameters.rst new file mode 100644 index 000000000..8e3e61231 --- /dev/null +++ b/docs/en/rst/administering/parameters.rst @@ -0,0 +1,798 @@ +.. _parameters: + +Parameters +########## + +Bugzilla is configured by changing various parameters, accessed +from the :guilabel:`Parameters` link, which is found on the Administration +page. The parameters are divided into several categories, +accessed via the menu on the left. + +.. _param-required-settings: + +Required Settings +================= + +The core required parameters for any Bugzilla installation are set +here. :param:`urlbase` is always required; the other parameters should be +set, or it must be explicitly decided not to +set them, before the new Bugzilla installation starts to be used. + +urlbase + Defines the fully qualified domain name and web + server path to this Bugzilla installation. + For example, if the Bugzilla query page is + :file:`http://www.foo.com/bugzilla/query.cgi`, + the :param:`urlbase` should be set + to :paramval:`http://www.foo.com/bugzilla/`. + +ssl_redirect + If enabled, Bugzilla will force HTTPS (SSL) connections, by + automatically redirecting any users who try to use a non-SSL + connection. Also, when this is enabled, Bugzilla will send out links + using :param:`sslbase` in emails instead of :param:`urlbase`. + +sslbase + Defines the fully qualified domain name and web + server path for HTTPS (SSL) connections to this Bugzilla installation. + For example, if the Bugzilla main page is + :file:`https://www.foo.com/bugzilla/index.cgi`, + the :param:`sslbase` should be set + to :paramval:`https://www.foo.com/bugzilla/`. + +cookiepath + Defines a path, relative to the web document root, that Bugzilla + cookies will be restricted to. For example, if the + :param:`urlbase` is set to + :file:`http://www.foo.com/bugzilla/`, the + :param:`cookiepath` should be set to + :paramval:`/bugzilla/`. Setting it to :paramval:`/` will allow all sites + served by this web server or virtual host to read Bugzilla cookies. + +.. _param-general: + +General +======= + +maintainer + Email address of the person + responsible for maintaining this Bugzilla installation. + The address need not be that of a valid Bugzilla account. + +docs_urlbase + The URL that is the common initial leading part of all Bugzilla documentation URLs. It may be an absolute URL, or a URL relative to the :param:`urlbase` parameter. Leave this empty to suppress links to the documentation. ``%lang%`` will be replaced by user's preferred language (if documentation is available in that language). + +utf8 + Use UTF-8 (Unicode) encoding for all text in Bugzilla. Installations where + this parameter is set to :paramval:`off` should set it to :paramval:`on` only + after the data has been converted from existing legacy character + encodings to UTF-8, using the + :file:`contrib/recode.pl` script. + + .. note:: If you turn this parameter from :paramval:`off` to :paramval:`on`, + you must re-run :file:`checksetup.pl` immediately afterward. + +shutdownhtml + If there is any text in this field, this Bugzilla installation will + be completely disabled and this text will appear instead of all + Bugzilla pages for all users, including Admins. Used in the event + of site maintenance or outage situations. + +announcehtml + Any text in this field will be displayed at the top of every HTML + page in this Bugzilla installation. The text is not wrapped in any + tags. For best results, wrap the text in a ``<div>`` + tag. Any style attributes from the CSS can be applied. For example, + to make the text green inside of a red box, add ``id=message`` + to the ``<div>`` tag. + +upgrade_notification + Enable or disable a notification on the homepage of this Bugzilla + installation when a newer version of Bugzilla is available. This + notification is only visible to administrators. Choose :paramval:`disabled` + to turn off the notification. Otherwise, choose which version of + Bugzilla you want to be notified about: :paramval:`development_snapshot` is the + latest release from the master branch, :paramval:`latest_stable_release` is the most + recent release available on the most recent stable branch, and + :paramval:`stable_branch_release` is the most recent release on the branch + this installation is based on. + +.. _param-administrative-policies: + +Administrative Policies +======================= + +This page contains parameters for basic administrative functions. +Options include whether to allow the deletion of bugs and users, +and whether to allow users to change their email address. + +allowbugdeletion + The pages to edit products and components can delete all associated bugs when you delete a product (or component). Since that is a pretty scary idea, you have to turn on this option before any such deletions will ever happen. + +allowemailchange + Users can change their own email address through the preferences. Note that the change is validated by emailing both addresses, so switching this option on will not let users use an invalid address. + +allowuserdeletion + The user editing pages are capable of letting you delete user accounts. Bugzilla will issue a warning in case you'd run into inconsistencies when you're about to do so, but such deletions still remain scary. So, you have to turn on this option before any such deletions will ever happen. + +last_visit_keep_days + This option controls how many days Bugzilla will remember that users have visited specific bugs. + +.. _param-user-authentication: + +User Authentication +=================== + +This page contains the settings that control how this Bugzilla +installation will do its authentication. Choose what authentication +mechanism to use (the Bugzilla database, or an external source such +as LDAP), and set basic behavioral parameters. For example, choose +whether to require users to login to browse bugs, the management +of authentication cookies, and the regular expression used to +validate email addresses. Some parameters are highlighted below. + +auth_env_id + Environment variable used by external authentication system to store a unique identifier for each user. Leave it blank if there isn't one or if this method of authentication is not being used. + +auth_env_email + Environment variable used by external authentication system to store each user's email address. This is a required field for environmental authentication. Leave it blank if you are not going to use this feature. + +auth_env_realname + Environment variable used by external authentication system to store the user's real name. Leave it blank if there isn't one or if this method of authentication is not being used. + +user_info_class + Mechanism(s) to be used for gathering a user's login information. More than one may be selected. If the first one returns nothing, the second is tried, and so on. The types are: + + * :paramval:`CGI`: asks for username and password via CGI form interface. + * :paramval:`Env`: info for a pre-authenticated user is passed in system environment variables. + +user_verify_class + Mechanism(s) to be used for verifying (authenticating) information gathered by user_info_class. More than one may be selected. If the first one cannot find the user, the second is tried, and so on. The types are: + + * :paramval:`DB`: Bugzilla's built-in authentication. This is the most common choice. + * :paramval:`RADIUS`: RADIUS authentication using a RADIUS server. Using this method requires additional parameters to be set. Please see :ref:`param-radius` for more information. + * :paramval:`LDAP`: LDAP authentication using an LDAP server. Using this method requires additional parameters to be set. Please see :ref:`param-ldap` for more information. + +rememberlogin + Controls management of session cookies. + + * :paramval:`on` - Session cookies never expire (the user has to login only once per browser). + * :paramval:`off` - Session cookies last until the users session ends (the user will have to login in each new browser session). + * :paramval:`defaulton`/:paramval:`defaultoff` - Default behavior as described above, but user can choose whether Bugzilla will remember their login or not. + +requirelogin + If this option is set, all access to the system beyond the front page will require a login. No anonymous users will be permitted. + +webservice_email_filter + Filter email addresses returned by the WebService API depending on if the user is logged in or not. This works similarly to how the web UI currently filters email addresses. If requirelogin is enabled, then this parameter has no effect as users must be logged in to use Bugzilla anyway. + +emailregexp + Defines the regular expression used to validate email addresses + used for login names. The default attempts to match fully + qualified email addresses (i.e. 'user\@example.com') in a slightly + more restrictive way than what is allowed in RFC 2822. + Another popular value to put here is :paramval:`^[^@]+`, which means 'local usernames, no @ allowed.' + +emailregexpdesc + This description is shown to the user to explain which email addresses are allowed by the :param:`emailregexp` param. + +emailsuffix + This is a string to append to any email addresses when actually sending mail to that address. It is useful if you have changed the :param:`emailregexp` param to only allow local usernames, but you want the mail to be delivered to username\@my.local.hostname. + +createemailregexp + This defines the (case-insensitive) regexp to use for email addresses that are permitted to self-register. The default (:paramval:`.*`) permits any account matching the emailregexp to be created. If this parameter is left blank, no users will be permitted to create their own accounts and all accounts will have to be created by an administrator. + +password_complexity + Set the complexity required for passwords. In all cases must the passwords be at least 6 characters long. + + * :paramval:`no_constraints` - No complexity required. + * :paramval:`mixed_letters` - Passwords must contain at least one UPPER and one lower case letter. + * :paramval:`letters_numbers` - Passwords must contain at least one UPPER and one lower case letter and a number. + * :paramval:`letters_numbers_specialchars` - Passwords must contain at least one letter, a number and a special character. + +password_check_on_login + If set, Bugzilla will check that the password meets the current complexity rules and minimum length requirements when the user logs into the Bugzilla web interface. If it doesn't, the user would not be able to log in, and will receive a message to reset their password. + +.. _param-attachments: + +Attachments +=========== + +This page allows for setting restrictions and other parameters +regarding attachments to bugs. For example, control size limitations +and whether to allow pointing to external files via a URI. + +allow_attachment_display + If this option is on, users will be able to view attachments from their browser, if their browser supports the attachment's MIME type. If this option is off, users are forced to download attachments, even if the browser is able to display them. + + If you do not trust your users (e.g. if your Bugzilla is public), you should either leave this option off, or configure and set the :param:`attachment_base` parameter (see below). Untrusted users may upload attachments that could be potentially damaging if viewed directly in the browser. + +attachment_base + When the :param:`allow_attachment_display` parameter is on, it is possible for a malicious attachment to steal your cookies or perform an attack on Bugzilla using your credentials. + + If you would like additional security on attachments to avoid this, set this parameter to an alternate URL for your Bugzilla that is not the same as :param:`urlbase` or :param:`sslbase`. That is, a different domain name that resolves to this exact same Bugzilla installation. + + Note that if you have set the :param:`cookiedomain` parameter, you should set :param:`attachment_base` to use a domain that would not be matched by :param:`cookiedomain`. + + For added security, you can insert ``%bugid%`` into the URL, which will be replaced with the ID of the current bug that the attachment is on, when you access an attachment. This will limit attachments to accessing only other attachments on the same bug. Remember, though, that all those possible domain names (such as 1234.your.domain.com) must point to this same Bugzilla instance. To set this up you need to investigate wildcard DNS. + +allow_attachment_deletion + If this option is on, administrators will be able to delete the contents + of attachments (i.e. replace the attached file with a 0 byte file), + leaving only the metadata. + +maxattachmentsize + The maximum size (in kilobytes) of attachments to be stored in the database. If a file larger than this size is attached to a bug, Bugzilla will look at the :param:`maxlocalattachment` parameter to determine if the file can be stored locally on the web server. If the file size exceeds both limits, then the attachment is rejected. Setting both parameters to 0 will prevent attaching files to bugs. + + Some databases have default limits which prevent storing larger attachments in the database. E.g. MySQL has a parameter called `max_allowed_packet <http://dev.mysql.com/doc/refman/5.1/en/packet-too-large.html>`_, whose default varies by distribution. Setting :param:`maxattachmentsize` higher than your current setting for this value will produce an error. + +maxlocalattachment + The maximum size (in megabytes) of attachments to be stored locally on the web server. If set to a value lower than the :param:`maxattachmentsize` parameter, attachments will never be kept on the local filesystem. + + Whether you use this feature or not depends on your environment. Reasons to store some or all attachments as files might include poor database performance for large binary blobs, ease of backup/restore/browsing, or even filesystem-level deduplication support. However, you need to be aware of any limits on how much data your webserver environment can store. If in doubt, leave the value at 0. + + Note that changing this value does not affect any already-submitted attachments. + +.. _param-bug-change-policies: + +Bug Change Policies +=================== + +Set policy on default behavior for bug change events. For example, +choose which status to set a bug to when it is marked as a duplicate, +and choose whether to allow bug reporters to set the priority or +target milestone. Also allows for configuration of what changes +should require the user to make a comment, described below. + +duplicate_or_move_bug_status + When a bug is marked as a duplicate of another one, use this bug status. + +letsubmitterchoosepriority + If this is on, then people submitting bugs can choose an initial priority for that bug. If off, then all bugs initially have the default priority selected here. + +letsubmitterchoosemilestone + If this is on, then people submitting bugs can choose the Target Milestone for that bug. If off, then all bugs initially have the default milestone for the product being filed in. + +musthavemilestoneonaccept + If you are using Target Milestone, do you want to require that the milestone be set in order for a user to set a bug's status to IN_PROGRESS? + +commenton* + All these fields allow you to dictate what changes can pass + without comment and which must have a comment from the + person who changed them. Often, administrators will allow + users to add themselves to the CC list, accept bugs, or + change the Status Whiteboard without adding a comment as to + their reasons for the change, yet require that most other + changes come with an explanation. + Set the "commenton" options according to your site policy. It + is a wise idea to require comments when users resolve, reassign, or + reopen bugs at the very least. + + .. note:: It is generally far better to require a developer comment + when resolving bugs than not. Few things are more annoying to bug + database users than having a developer mark a bug "fixed" without + any comment as to what the fix was (or even that it was truly + fixed!) + +noresolveonopenblockers + This option will prevent users from resolving bugs as FIXED if + they have unresolved dependencies. Only the FIXED resolution + is affected. Users will be still able to resolve bugs to + resolutions other than FIXED if they have unresolved dependent + bugs. + +.. _param-bugfields: + +Bug Fields +========== + +The parameters in this section determine the default settings of +several Bugzilla fields for new bugs and whether +certain fields are used. For example, choose whether to use the +:field:`Target Milestone` field or the :field:`Status Whiteboard` field. + +useclassification + If this is on, Bugzilla will associate each product with a specific + classification. But you must have :group:`editclassification` permissions + enabled in order to edit classifications. + +usetargetmilestone + Do you wish to use the :field:`Target Milestone` field? + +useqacontact + This allows you to define an email address for each component, + in addition to that of the default assignee, that will be sent + carbon copies of incoming bugs. + +usestatuswhiteboard + This defines whether you wish to have a free-form, overwritable field + associated with each bug. The advantage of the :field:`Status Whiteboard` + is that it can be deleted or modified with ease and provides an + easily searchable field for indexing bugs that have some trait in + common. + +use_see_also + Do you wish to use the :field:`See Also` field? It allows you mark bugs + in other bug tracker installations as being related. Disabling this field + prevents addition of new relationships, but existing ones will continue to + appear. + +defaultpriority + This is the priority that newly entered bugs are set to. + +defaultseverity + This is the severity that newly entered bugs are set to. + +defaultplatform + This is the platform that is preselected on the bug entry form. + You can leave this empty; Bugzilla will then use the platform that the + browser is running on as the default. + +defaultopsys + This is the operating system that is preselected on the bug entry form. + You can leave this empty; Bugzilla will then use the operating system + that the browser reports to be running on as the default. + +collapsed_comment_tags + A comma-separated list of tags which, when applied to comments, will + cause them to be collapsed by default. + +.. _param-dependency-graphs: + +Graphs +====== + +Bugzilla can draw graphs of bug-dependency relationships, using a tool called +:file:`dot` (from the `GraphViz project <http://graphviz.org/>`_) or a web +service called Web Dot. This page allows you to set the location of the binary +or service. If no Web Dot server or binary is specified, then dependency +graphs will be disabled. + +webdotbase + You may set this parameter to any of the following: + + * A complete file path to :command:`dot` (part of GraphViz), which will + generate the graphs locally. + * A URL prefix pointing to an installation of the Web Dot package, which + will generate the graphs remotely. + * A blank value, which will disable dependency graphing. + + The default value is blank. We recommend using a local install of + :file:`dot`. If you change this value to a web service, make certain that + the Web Dot server can read files from your Web Dot directory. On Apache + you do this by editing the :file:`.htaccess` file; for other systems the + needed measures may vary. You can run :command:`checksetup.pl` to + recreate the :file:`.htaccess` file if it has been lost. + +font_file + You can specify the full path to a TrueType font file which will be used + to display text (labels, legends, ...) in charts and graphical reports. + To support as many languages as possible, we recommend to specify a + TrueType font such as Unifont which supports all printable characters in + the Basic Multilingual Plane. If you leave this parameter empty, a default + font will be used, but its support is limited to English characters only + and so other characters will be displayed incorrectly. + +.. _param-group-security: + +Group Security +============== + +Bugzilla allows for the creation of different groups, with the +ability to restrict the visibility of bugs in a group to a set of +specific users. Specific products can also be associated with +groups, and users restricted to only see products in their groups. +Several parameters are described in more detail below. Most of the +configuration of groups and their relationship to products is done +on the :guilabel:`Groups` and :guilabel:`Product` pages of the +:guilabel:`Administration` area. +The options on this page control global default behavior. +For more information on Groups and Group Security, see +:ref:`groups`. + +makeproductgroups + Determines whether or not to automatically create groups + when new products are created. If this is on, the groups will be + used for querying bugs. + + .. todo:: This is spectacularly unclear. I have no idea what makeproductgroups + does - can someone explain it to me? Convert this item into a bug on checkin. + +chartgroup + The name of the group of users who can use the 'New Charts' feature. Administrators should ensure that the public categories and series definitions do not divulge confidential information before enabling this for an untrusted population. If left blank, no users will be able to use New Charts. + +insidergroup + The name of the group of users who can see/change private comments and attachments. + +timetrackinggroup + The name of the group of users who can see/change time tracking information. + +querysharegroup + The name of the group of users who are allowed to share saved + searches with one another. For more information on using + saved searches, see :ref:`saved-searches`. + +comment_taggers_group + The name of the group of users who can tag comments. Setting this to empty disables comment tagging. + +debug_group + The name of the group of users who can view the actual SQL query generated when viewing bug lists and reports. Do not expose this information to untrusted users. + +usevisibilitygroups + If selected, user visibility will be restricted to members of + groups, as selected in the group configuration settings. + Each user-defined group can be allowed to see members of selected + other groups. + For details on configuring groups (including the visibility + restrictions) see :ref:`edit-groups`. + +or_groups + Define the visibility of a bug which is in multiple groups. If + this is on (recommended), a user only needs to be a member of one + of the bug's groups in order to view it. If it is off, a user + needs to be a member of all the bug's groups. Note that in either + case, a user's role on the bug (e.g. reporter), if any, may also + affect their permissions. + +.. _param-ldap: + +LDAP +==== + +LDAP authentication is a module for Bugzilla's plugin +authentication architecture. This page contains all the parameters +necessary to configure Bugzilla for use with LDAP authentication. + +The existing authentication +scheme for Bugzilla uses email addresses as the primary user ID and a +password to authenticate that user. All places within Bugzilla that +require a user ID (e.g assigning a bug) use the email +address. The LDAP authentication builds on top of this scheme, rather +than replacing it. The initial log-in is done with a username and +password for the LDAP directory. Bugzilla tries to bind to LDAP using +those credentials and, if successful, tries to map this account to a +Bugzilla account. If an LDAP mail attribute is defined, the value of this +attribute is used; otherwise, the :param:`emailsuffix` parameter is appended to +the LDAP username to form a full email address. If an account for this address +already exists in the Bugzilla installation, it will log in to that account. +If no account for that email address exists, one is created at the time +of login. (In this case, Bugzilla will attempt to use the "displayName" +or "cn" attribute to determine the user's full name.) After +authentication, all other user-related tasks are still handled by email +address, not LDAP username. For example, bugs are still assigned by +email address and users are still queried by email address. + +.. warning:: Because the Bugzilla account is not created until the first time + a user logs in, a user who has not yet logged is unknown to Bugzilla. + This means they cannot be used as an assignee or QA contact (default or + otherwise), added to any CC list, or any other such operation. One + possible workaround is the :file:`bugzilla_ldapsync.rb` + script in the :file:`contrib` + directory. Another possible solution is fixing :bug:`201069`. + +Parameters required to use LDAP Authentication: + +user_verify_class (in the Authentication section) + If you want to list :paramval:`LDAP` here, + make sure to have set up the other parameters listed below. + Unless you have other (working) authentication methods listed as + well, you may otherwise not be able to log back in to Bugzilla once + you log out. + If this happens to you, you will need to manually edit + :file:`data/params.json` and set :param:`user_verify_class` to + :paramval:`DB`. + +LDAPserver + This parameter should be set to the name (and optionally the + port) of your LDAP server. If no port is specified, it assumes + the default LDAP port of 389. + For example: :paramval:`ldap.company.com` + or :paramval:`ldap.company.com:3268` + You can also specify a LDAP URI, so as to use other + protocols, such as LDAPS or LDAPI. If the port was not specified in + the URI, the default is either 389 or 636 for 'LDAP' and 'LDAPS' + schemes respectively. + + .. note:: In order to use SSL with LDAP, specify a URI with "ldaps://". + This will force the use of SSL over port 636. + For example, normal LDAP + :paramval:`ldap://ldap.company.com`, LDAP over SSL + :paramval:`ldaps://ldap.company.com`, or LDAP over a UNIX + domain socket :paramval:`ldapi://%2fvar%2flib%2fldap_sock`. + +LDAPstarttls + Whether to require encrypted communication once a normal LDAP connection + is achieved with the server. + +LDAPbinddn [Optional] + Some LDAP servers will not allow an anonymous bind to search + the directory. If this is the case with your configuration you + should set the :param:`LDAPbinddn` parameter to the user account Bugzilla + should use instead of the anonymous bind. + Ex. :paramval:`cn=default,cn=user:password` + +LDAPBaseDN + The location in + your LDAP tree that you would like to search for email addresses. + Your uids should be unique under the DN specified here. + Ex. :paramval:`ou=People,o=Company` + +LDAPuidattribute + The attribute + which contains the unique UID of your users. The value retrieved + from this attribute will be used when attempting to bind as the + user to confirm their password. + Ex. :paramval:`uid` + +LDAPmailattribute + The name of the + attribute which contains the email address your users will enter + into the Bugzilla login boxes. + Ex. :paramval:`mail` + +LDAPfilter + LDAP filter to AND with the LDAPuidattribute for filtering the list of + valid users. + +.. _param-radius: + +RADIUS +====== + +RADIUS authentication is a module for Bugzilla's plugin +authentication architecture. This page contains all the parameters +necessary for configuring Bugzilla to use RADIUS authentication. + +.. note:: Most caveats that apply to LDAP authentication apply to RADIUS + authentication as well. See :ref:`param-ldap` for details. + +Parameters required to use RADIUS Authentication: + +user_verify_class (in the Authentication section) + If you want to list :paramval:`RADIUS` here, + make sure to have set up the other parameters listed below. + Unless you have other (working) authentication methods listed as + well, you may otherwise not be able to log back in to Bugzilla once + you log out. + If this happens to you, you will need to manually edit + :file:`data/params.json` and set :param:`user_verify_class` to + :paramval:`DB`. + +RADIUS_server + The name (and optionally the port) of your RADIUS server. + +RADIUS_secret + The RADIUS server's secret. + +RADIUS_NAS_IP + The NAS-IP-Address attribute to be used when exchanging data with your + RADIUS server. If unspecified, 127.0.0.1 will be used. + +RADIUS_email_suffix + Bugzilla needs an email address for each user account. + Therefore, it needs to determine the email address corresponding + to a RADIUS user. + Bugzilla offers only a simple way to do this: it can concatenate + a suffix to the RADIUS user name to convert it into an email + address. + You can specify this suffix in the :param:`RADIUS_email_suffix` parameter. + If this simple solution does not work for you, you'll + probably need to modify + :file:`Bugzilla/Auth/Verify/RADIUS.pm` to match your + requirements. + +.. _param-email: + +Email +===== + +This page contains all of the parameters for configuring how +Bugzilla deals with the email notifications it sends. See below +for a summary of important options. + +mail_delivery_method + This is used to specify how email is sent, or if it is sent at + all. There are several options included for different MTAs, + along with two additional options that disable email sending. + :paramval:`Test` does not send mail, but instead saves it in + :file:`data/mailer.testfile` for later review. + :paramval:`None` disables email sending entirely. + +mailfrom + This is the email address that will appear in the "From" field + of all emails sent by this Bugzilla installation. Some email + servers require mail to be from a valid email address; therefore, + it is recommended to choose a valid email address here. + +use_mailer_queue + In a large Bugzilla installation, updating bugs can be very slow because Bugzilla sends all email at once. If you enable this parameter, Bugzilla will queue all mail and then send it in the background. This requires that you have installed certain Perl modules (as listed by :file:`checksetup.pl` for this feature), and that you are running the :file:`jobqueue.pl` daemon (otherwise your mail won't get sent). This affects all mail sent by Bugzilla, not just bug updates. + +smtpserver + The SMTP server address, if the :param:`mail_delivery_method` + parameter is set to :paramval:`SMTP`. Use :paramval:`localhost` if you have a local MTA + running; otherwise, use a remote SMTP server. Append ":" and the port + number if a non-default port is needed. + +smtp_username + Username to use for SASL authentication to the SMTP server. Leave + this parameter empty if your server does not require authentication. + +smtp_password + Password to use for SASL authentication to the SMTP server. This + parameter will be ignored if the :param:`smtp_username` + parameter is left empty. + +smtp_ssl + Enable SSL support for connection to the SMTP server. + +smtp_debug + This parameter allows you to enable detailed debugging output. + Log messages are printed the web server's error log. + +whinedays + Set this to the number of days you want to let bugs go + in the CONFIRMED state before notifying people they have + untouched new bugs. If you do not plan to use this feature, simply + do not set up the :ref:`whining cron job <installation-whining>` described + in the installation instructions, or set this value to "0" (never whine). + +globalwatchers + This allows you to define specific users who will + receive notification each time any new bug in entered, or when + any existing bug changes, subject to the normal groupset + permissions. It may be useful for sending notifications to a + mailing list, for instance. + +.. _param-querydefaults: + +Query Defaults +============== + +This page controls the default behavior of Bugzilla in regards to +several aspects of querying bugs. Options include what the default +query options are, what the "My Bugs" page returns, whether users +can freely add bugs to the quip list, and how many duplicate bugs are +needed to add a bug to the "most frequently reported" list. + +quip_list_entry_control + Controls how easily users can add entries to the quip list. + + * :paramval:`open` - Users may freely add to the quip list, and their entries will immediately be available for viewing. + * :paramval:`moderated` - Quips can be entered but need to be approved by a moderator before they will be shown. + * :paramval:`closed` - No new additions to the quips list are allowed. + +mybugstemplate + This is the URL to use to bring up a simple 'all of my bugs' list + for a user. %userid% will get replaced with the login name of a + user. Special characters must be URL encoded. + +defaultquery + This is the default query that initially comes up when you access + the advanced query page. It's in URL-parameter format. + +search_allow_no_criteria + When turned off, a query must have some criteria specified to limit the number of bugs returned to the user. When turned on, a user is allowed to run a query with no criteria and get all bugs in the entire installation that they can see. Turning this parameter on is not recommended on large installations. + +default_search_limit + By default, Bugzilla limits searches done in the web interface to returning only this many results, for performance reasons. (This only affects the HTML format of search results—CSV, XML, and other formats are exempted.) Users can click a link on the search result page to see all the results. + + Usually you should not have to change this—the default value should be acceptable for most installations. + +max_search_results + The maximum number of bugs that a search can ever return. Tabular and graphical reports are exempted from this limit, however. + + + +.. _param-shadowdatabase: + +Shadow Database +=============== + +This page controls whether a shadow database is used. If your Bugzilla is +not large, you will not need these options. + +A standard large database setup involves a single master server and a pool of +read-only slaves (which Bugzilla calls the "shadowdb"). Queries which are not +updating data can be directed to the slave pool, removing the load/locking +from the master, freeing it up to handle writes. Bugzilla will switch to the +shadowdb when it knows it doesn't need to update the database (e.g. when +searching, or displaying a bug to a not-logged-in user). + +Bugzilla does not make sure the shadowdb is kept up to date, so, if you use +one, you will need to set up replication in your database server. + +If your shadowdb is on a different machine, specify :param:`shadowdbhost` +and :param:`shadowdbport`. If it's on the same machine, specify +:param:`shadowdbsock`. + +shadowdbhost + The host the shadow database is on. + +shadowdbport + The port the shadow database is on. + +shadowdbsock + The socket used to connect to the shadow database, if the host is the + local machine. + +shadowdb + The database name of the shadow database. + +.. _admin-memcached: + +Memcached +========= + +memcached_servers + If this option is set, Bugzilla will integrate with `Memcached + <http://www.memcached.org/>`_. Specify one or more servers, separated by + spaces, using hostname:port notation (for example: + :paramval:`127.0.0.1:11211`). + +memcached_namespace + Specify a string to prefix each key on Memcached. + +.. _admin-usermatching: + +User Matching +============= + +The settings on this page control how users are selected and queried +when adding a user to a bug. For example, users need to be selected +when assigning the bug, adding to the CC list, or +selecting a QA contact. With the :param:`usemenuforusers` parameter, it is +possible to configure Bugzilla to +display a list of users in the fields instead of an empty text field. +If users are selected via a text box, this page also +contains parameters for how user names can be queried and matched +when entered. + +usemenuforusers + If this option is set, Bugzilla will offer you a list to select from (instead of a text entry field) where a user needs to be selected. This option should not be enabled on sites where there are a large number of users. + +ajax_user_autocompletion + If this option is set, typing characters in a certain user fields + will display a list of matches that can be selected from. It is + recommended to only turn this on if you are using mod_perl; + otherwise, the response will be irritatingly slow. + +maxusermatches + Provide no more than this many matches when a user is searched for. + If set to '1', no users will be displayed on ambiguous + matches. This is useful for user-privacy purposes. A value of zero + means no limit. + +confirmuniqueusermatch + Whether a confirmation screen should be displayed when only one user matches a search entry. + +.. _admin-advanced: + +Advanced +======== + +cookiedomain + Defines the domain for Bugzilla cookies. This is typically left blank. + If there are multiple hostnames that point to the same webserver, which + require the same cookie, then this parameter can be utilized. For + example, If your website is at + ``https://bugzilla.example.com/``, setting this to + :paramval:`.example.com/` will also allow + ``attachments.example.com/`` to access Bugzilla cookies. + +inbound_proxies + When inbound traffic to Bugzilla goes through a proxy, Bugzilla thinks that the IP address of the proxy is the IP address of every single user. If you enter a comma-separated list of IPs in this parameter, then Bugzilla will trust any ``X-Forwarded-For`` header sent from those IPs, and use the value of that header as the end user's IP address. + +proxy_url + If this Bugzilla installation is behind a proxy, enter the proxy + information here to enable Bugzilla to access the Internet. Bugzilla + requires Internet access to utilize the + :param:`upgrade_notification` parameter. If the + proxy requires authentication, use the syntax: + :paramval:`http://user:pass@proxy_url/`. + +strict_transport_security + Enables the sending of the Strict-Transport-Security header along with HTTP responses on SSL connections. This adds greater security to your SSL connections by forcing the browser to always access your domain over SSL and never accept an invalid certificate. However, it should only be used if you have the :param:`ssl_redirect` parameter turned on, Bugzilla is the only thing running on its domain (i.e., your :param:`urlbase` is something like :paramval:`http://bugzilla.example.com/`), and you never plan to stop supporting SSL. + + * :paramval:`off` - Don't send the Strict-Transport-Security header with requests. + * :paramval:`this_domain_only` - Send the Strict-Transport-Security header with all requests, but only support it for the current domain. + * :paramval:`include_subdomains` - Send the Strict-Transport-Security header along with the includeSubDomains flag, which will apply the security change to all subdomains. This is especially useful when combined with an :param:`attachment_base` that exists as (a) subdomain(s) under the main Bugzilla domain. diff --git a/docs/en/rst/administering/preferences.rst b/docs/en/rst/administering/preferences.rst new file mode 100644 index 000000000..0b89c7b13 --- /dev/null +++ b/docs/en/rst/administering/preferences.rst @@ -0,0 +1,10 @@ +.. _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. + diff --git a/docs/en/rst/administering/quips.rst b/docs/en/rst/administering/quips.rst new file mode 100644 index 000000000..789304a33 --- /dev/null +++ b/docs/en/rst/administering/quips.rst @@ -0,0 +1,38 @@ +.. _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". + diff --git a/docs/en/rst/administering/users.rst b/docs/en/rst/administering/users.rst new file mode 100644 index 000000000..b8657e5d9 --- /dev/null +++ b/docs/en/rst/administering/users.rst @@ -0,0 +1,244 @@ +.. _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. + diff --git a/docs/en/rst/administering/whining.rst b/docs/en/rst/administering/whining.rst new file mode 100644 index 000000000..dc101ab9b --- /dev/null +++ b/docs/en/rst/administering/whining.rst @@ -0,0 +1,145 @@ +.. _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. diff --git a/docs/en/rst/administering/workflow.rst b/docs/en/rst/administering/workflow.rst new file mode 100644 index 000000000..7ce5b7a87 --- /dev/null +++ b/docs/en/rst/administering/workflow.rst @@ -0,0 +1,34 @@ +.. _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. diff --git a/docs/en/rst/administration.rst b/docs/en/rst/administration.rst deleted file mode 100644 index df7631fdb..000000000 --- a/docs/en/rst/administration.rst +++ /dev/null @@ -1,2149 +0,0 @@ - - -.. _administration: - -====================== -Administering Bugzilla -====================== - -.. _parameters: - -Bugzilla Configuration -###################### - -Bugzilla is configured by changing various parameters, accessed -from the "Parameters" link in the Administration page (the -Administration page can be found by clicking the "Administration" -link in the footer). The parameters are divided into several categories, -accessed via the menu on the left. Following is a description of the -different categories and important parameters within those categories. - -.. _param-requiredsettings: - -Required Settings -================= - -The core required parameters for any Bugzilla installation are set -here. These parameters must be set before a new Bugzilla installation -can be used. Administrators should review this list before -deploying a new Bugzilla installation. - -maintainer - Email address of the person - responsible for maintaining this Bugzilla installation. - The address need not be that of a valid Bugzilla account. - -urlbase - Defines the fully qualified domain name and web - server path to this Bugzilla installation. - For example, if the Bugzilla query page is - :file:`http://www.foo.com/bugzilla/query.cgi`, - the ``urlbase`` should be set - to :file:`http://www.foo.com/bugzilla/`. - -docs_urlbase - Defines path to the Bugzilla documentation. This can be a fully - qualified domain name, or a path relative to "urlbase". - For example, if the "Bugzilla Configuration" page - of the documentation is - :file:`http://www.foo.com/bugzilla/docs/html/parameters.html`, - set the ``docs_urlbase`` - to :file:`http://www.foo.com/bugzilla/docs/html/`. - -sslbase - Defines the fully qualified domain name and web - server path for HTTPS (SSL) connections to this Bugzilla installation. - For example, if the Bugzilla main page is - :file:`https://www.foo.com/bugzilla/index.cgi`, - the ``sslbase`` should be set - to :file:`https://www.foo.com/bugzilla/`. - -ssl_redirect - If enabled, Bugzilla will force HTTPS (SSL) connections, by - automatically redirecting any users who try to use a non-SSL - connection. - -cookiedomain - Defines the domain for Bugzilla cookies. This is typically left blank. - If there are multiple hostnames that point to the same webserver, which - require the same cookie, then this parameter can be utilized. For - example, If your website is at - :file:`https://www.foo.com/`, setting this to - :file:`.foo.com/` will also allow - :file:`bar.foo.com/` to access Bugzilla cookies. - -cookiepath - Defines a path, relative to the web server root, that Bugzilla - cookies will be restricted to. For example, if the - :command:`urlbase` is set to - :file:`http://www.foo.com/bugzilla/`, the - :command:`cookiepath` should be set to - :file:`/bugzilla/`. Setting it to "/" will allow all sites - served by this web server or virtual host to read Bugzilla cookies. - -utf8 - Determines whether to use UTF-8 (Unicode) encoding for all text in - Bugzilla. New installations should set this to true to avoid character - encoding problems. Existing databases should set this to true only - after the data has been converted from existing legacy character - encoding to UTF-8, using the - :file:`contrib/recode.pl` script. - - .. note:: If you turn this parameter from "off" to "on", you must - re-run :file:`checksetup.pl` immediately afterward. - -shutdownhtml - If there is any text in this field, this Bugzilla installation will - be completely disabled and this text will appear instead of all - Bugzilla pages for all users, including Admins. Used in the event - of site maintenance or outage situations. - - .. note:: Although regular log-in capability is disabled - while :command:`shutdownhtml` - is enabled, safeguards are in place to protect the unfortunate - admin who loses connection to Bugzilla. Should this happen to you, - go directly to the :file:`editparams.cgi` (by typing - the URL in manually, if necessary). Doing this will prompt you to - log in, and your name/password will be accepted here (but nowhere - else). - -announcehtml - Any text in this field will be displayed at the top of every HTML - page in this Bugzilla installation. The text is not wrapped in any - tags. For best results, wrap the text in a ``<div>`` - tag. Any style attributes from the CSS can be applied. For example, - to make the text green inside of a red box, add ``id=message`` - to the ``<div>`` tag. - -proxy_url - If this Bugzilla installation is behind a proxy, enter the proxy - information here to enable Bugzilla to access the Internet. Bugzilla - requires Internet access to utilize the - :command:`upgrade_notification` parameter (below). If the - proxy requires authentication, use the syntax: - :file:`http://user:pass@proxy_url/`. - -upgrade_notification - Enable or disable a notification on the homepage of this Bugzilla - installation when a newer version of Bugzilla is available. This - notification is only visible to administrators. Choose "disabled", - to turn off the notification. Otherwise, choose which version of - Bugzilla you want to be notified about: "development_snapshot" is the - latest release on the trunk; "latest_stable_release" is the most - recent release available on the most recent stable branch; - "stable_branch_release" the most recent release on the branch - this installation is based on. - -.. _param-admin-policies: - -Administrative Policies -======================= - -This page contains parameters for basic administrative functions. -Options include whether to allow the deletion of bugs and users, -and whether to allow users to change their email address. - -.. _param-user-authentication: - -User Authentication -=================== - -This page contains the settings that control how this Bugzilla -installation will do its authentication. Choose what authentication -mechanism to use (the Bugzilla database, or an external source such -as LDAP), and set basic behavioral parameters. For example, choose -whether to require users to login to browse bugs, the management -of authentication cookies, and the regular expression used to -validate email addresses. Some parameters are highlighted below. - -emailregexp - Defines the regular expression used to validate email addresses - used for login names. The default attempts to match fully - qualified email addresses (i.e. 'user@example.com') in a slightly - more restrictive way than what is allowed in RFC 2822. - Some Bugzilla installations allow only local user names (i.e 'user' - instead of 'user@example.com'). In that case, this parameter - should be used to define the email domain. - -emailsuffix - This string is appended to login names when actually sending - email to a user. For example, - If :command:`emailregexp` has been set to allow - local usernames, - then this parameter would contain the email domain for all users - (i.e. '@example.com'). - -.. _param-attachments: - -Attachments -=========== - -This page allows for setting restrictions and other parameters -regarding attachments to bugs. For example, control size limitations -and whether to allow pointing to external files via a URI. - -.. _param-bug-change-policies: - -Bug Change Policies -=================== - -Set policy on default behavior for bug change events. For example, -choose which status to set a bug to when it is marked as a duplicate, -and choose whether to allow bug reporters to set the priority or -target milestone. Also allows for configuration of what changes -should require the user to make a comment, described below. - -commenton* - All these fields allow you to dictate what changes can pass - without comment, and which must have a comment from the - person who changed them. Often, administrators will allow - users to add themselves to the CC list, accept bugs, or - change the Status Whiteboard without adding a comment as to - their reasons for the change, yet require that most other - changes come with an explanation. - Set the "commenton" options according to your site policy. It - is a wise idea to require comments when users resolve, reassign, or - reopen bugs at the very least. - - .. note:: It is generally far better to require a developer comment - when resolving bugs than not. Few things are more annoying to bug - database users than having a developer mark a bug "fixed" without - any comment as to what the fix was (or even that it was truly - fixed!) - -noresolveonopenblockers - This option will prevent users from resolving bugs as FIXED if - they have unresolved dependencies. Only the FIXED resolution - is affected. Users will be still able to resolve bugs to - resolutions other than FIXED if they have unresolved dependent - bugs. - -.. _param-bugfields: - -Bug Fields -========== - -The parameters in this section determine the default settings of -several Bugzilla fields for new bugs, and also control whether -certain fields are used. For example, choose whether to use the -"target milestone" field or the "status whiteboard" field. - -useqacontact - This allows you to define an email address for each component, - in addition to that of the default assignee, who will be sent - carbon copies of incoming bugs. - -usestatuswhiteboard - This defines whether you wish to have a free-form, overwritable field - associated with each bug. The advantage of the Status Whiteboard is - that it can be deleted or modified with ease, and provides an - easily-searchable field for indexing some bugs that have some trait - in common. - -.. _param-bugmoving: - -Bug Moving -========== - -This page controls whether this Bugzilla installation allows certain -users to move bugs to an external database. If bug moving is enabled, -there are a number of parameters that control bug moving behaviors. -For example, choose which users are allowed to move bugs, the location -of the external database, and the default product and component that -bugs moved *from* other bug databases to this -Bugzilla installation are assigned to. - -.. _param-dependency-graphs: - -Dependency Graphs -================= - -This page has one parameter that sets the location of a Web Dot -server, or of the Web Dot binary on the local system, that is used -to generate dependency graphs. Web Dot is a CGI program that creates -images from :file:`.dot` graphic description files. If -no Web Dot server or binary is specified, then dependency graphs will -be disabled. - -.. _param-group-security: - -Group Security -============== - -Bugzilla allows for the creation of different groups, with the -ability to restrict the visibility of bugs in a group to a set of -specific users. Specific products can also be associated with -groups, and users restricted to only see products in their groups. -Several parameters are described in more detail below. Most of the -configuration of groups and their relationship to products is done -on the "Groups" and "Product" pages of the "Administration" area. -The options on this page control global default behavior. -For more information on Groups and Group Security, see -:ref:`groups` - -makeproductgroups - Determines whether or not to automatically create groups - when new products are created. If this is on, the groups will be - used for querying bugs. - -usevisibilitygroups - If selected, user visibility will be restricted to members of - groups, as selected in the group configuration settings. - Each user-defined group can be allowed to see members of selected - other groups. - For details on configuring groups (including the visibility - restrictions) see :ref:`edit-groups`. - -querysharegroup - The name of the group of users who are allowed to share saved - searches with one another. For more information on using - saved searches, see :ref:`savedsearches`. - -.. _bzldap: - -LDAP Authentication -=================== - -LDAP authentication is a module for Bugzilla's plugin -authentication architecture. This page contains all the parameters -necessary to configure Bugzilla for use with LDAP authentication. - -The existing authentication -scheme for Bugzilla uses email addresses as the primary user ID, and a -password to authenticate that user. All places within Bugzilla that -require a user ID (e.g assigning a bug) use the email -address. The LDAP authentication builds on top of this scheme, rather -than replacing it. The initial log-in is done with a username and -password for the LDAP directory. Bugzilla tries to bind to LDAP using -those credentials and, if successful, tries to map this account to a -Bugzilla account. If an LDAP mail attribute is defined, the value of this -attribute is used, otherwise the "emailsuffix" parameter is appended to LDAP -username to form a full email address. If an account for this address -already exists in the Bugzilla installation, it will log in to that account. -If no account for that email address exists, one is created at the time -of login. (In this case, Bugzilla will attempt to use the "displayName" -or "cn" attribute to determine the user's full name.) After -authentication, all other user-related tasks are still handled by email -address, not LDAP username. For example, bugs are still assigned by -email address and users are still queried by email address. - -.. warning:: Because the Bugzilla account is not created until the first time - a user logs in, a user who has not yet logged is unknown to Bugzilla. - This means they cannot be used as an assignee or QA contact (default or - otherwise), added to any CC list, or any other such operation. One - possible workaround is the :file:`bugzilla_ldapsync.rb` - script in the :file:`contrib` - directory. Another possible solution is fixing - `bug - 201069 <https://bugzilla.mozilla.org/show_bug.cgi?id=201069>`_. - -Parameters required to use LDAP Authentication: - -user_verify_class - If you want to list ``LDAP`` here, - make sure to have set up the other parameters listed below. - Unless you have other (working) authentication methods listed as - well, you may otherwise not be able to log back in to Bugzilla once - you log out. - If this happens to you, you will need to manually edit - :file:`data/params.json` and set user_verify_class to - ``DB``. - -LDAPserver - This parameter should be set to the name (and optionally the - port) of your LDAP server. If no port is specified, it assumes - the default LDAP port of 389. - For example: ``ldap.company.com`` - or ``ldap.company.com:3268`` - You can also specify a LDAP URI, so as to use other - protocols, such as LDAPS or LDAPI. If port was not specified in - the URI, the default is either 389 or 636 for 'LDAP' and 'LDAPS' - schemes respectively. - - .. note:: In order to use SSL with LDAP, specify a URI with "ldaps://". - This will force the use of SSL over port 636. - For example, normal LDAP: - ``ldap://ldap.company.com``, LDAP over SSL: - ``ldaps://ldap.company.com`` or LDAP over a UNIX - domain socket ``ldapi://%2fvar%2flib%2fldap_sock``. - -LDAPbinddn \[Optional] - Some LDAP servers will not allow an anonymous bind to search - the directory. If this is the case with your configuration you - should set the LDAPbinddn parameter to the user account Bugzilla - should use instead of the anonymous bind. - Ex. ``cn=default,cn=user:password`` - -LDAPBaseDN - The LDAPBaseDN parameter should be set to the location in - your LDAP tree that you would like to search for email addresses. - Your uids should be unique under the DN specified here. - Ex. ``ou=People,o=Company`` - -LDAPuidattribute - The LDAPuidattribute parameter should be set to the attribute - which contains the unique UID of your users. The value retrieved - from this attribute will be used when attempting to bind as the - user to confirm their password. - Ex. ``uid`` - -LDAPmailattribute - The LDAPmailattribute parameter should be the name of the - attribute which contains the email address your users will enter - into the Bugzilla login boxes. - Ex. ``mail`` - -.. _bzradius: - -RADIUS Authentication -===================== - -RADIUS authentication is a module for Bugzilla's plugin -authentication architecture. This page contains all the parameters -necessary for configuring Bugzilla to use RADIUS authentication. - -.. note:: Most caveats that apply to LDAP authentication apply to RADIUS - authentication as well. See :ref:`bzldap` for details. - -Parameters required to use RADIUS Authentication: - -user_verify_class - If you want to list ``RADIUS`` here, - make sure to have set up the other parameters listed below. - Unless you have other (working) authentication methods listed as - well, you may otherwise not be able to log back in to Bugzilla once - you log out. - If this happens to you, you will need to manually edit - :file:`data/params.json` and set user_verify_class to - ``DB``. - -RADIUS_server - This parameter should be set to the name (and optionally the - port) of your RADIUS server. - -RADIUS_secret - This parameter should be set to the RADIUS server's secret. - -RADIUS_email_suffix - Bugzilla needs an e-mail address for each user account. - Therefore, it needs to determine the e-mail address corresponding - to a RADIUS user. - Bugzilla offers only a simple way to do this: it can concatenate - a suffix to the RADIUS user name to convert it into an e-mail - address. - You can specify this suffix in the RADIUS_email_suffix parameter. - If this simple solution does not work for you, you'll - probably need to modify - :file:`Bugzilla/Auth/Verify/RADIUS.pm` to match your - requirements. - -.. _param-email: - -Email -===== - -This page contains all of the parameters for configuring how -Bugzilla deals with the email notifications it sends. See below -for a summary of important options. - -mail_delivery_method - This is used to specify how email is sent, or if it is sent at - all. There are several options included for different MTAs, - along with two additional options that disable email sending. - "Test" does not send mail, but instead saves it in - :file:`data/mailer.testfile` for later review. - "None" disables email sending entirely. - -mailfrom - This is the email address that will appear in the "From" field - of all emails sent by this Bugzilla installation. Some email - servers require mail to be from a valid email address, therefore - it is recommended to choose a valid email address here. - -smtpserver - This is the SMTP server address, if the ``mail_delivery_method`` - parameter is set to SMTP. Use "localhost" if you have a local MTA - running, otherwise use a remote SMTP server. Append ":" and the port - number, if a non-default port is needed. - -smtp_username - Username to use for SASL authentication to the SMTP server. Leave - this parameter empty if your server does not require authentication. - -smtp_password - Password to use for SASL authentication to the SMTP server. This - parameter will be ignored if the ``smtp_username`` - parameter is left empty. - -smtp_ssl - Enable SSL support for connection to the SMTP server. - -smtp_debug - This parameter allows you to enable detailed debugging output. - Log messages are printed the web server's error log. - -whinedays - Set this to the number of days you want to let bugs go - in the CONFIRMED state before notifying people they have - untouched new bugs. If you do not plan to use this feature, simply - do not set up the whining cron job described in the installation - instructions, or set this value to "0" (never whine). - -globalwatcher - This allows you to define specific users who will - receive notification each time a new bug in entered, or when - an existing bug changes, according to the normal groupset - permissions. It may be useful for sending notifications to a - mailing-list, for instance. - -.. _param-patchviewer: - -Patch Viewer -============ - -This page contains configuration parameters for the CVS server, -Bonsai server and LXR server that Bugzilla will use to enable the -features of the Patch Viewer. Bonsai is a tool that enables queries -to a CVS tree. LXR is a tool that can cross reference and index source -code. - -.. _param-querydefaults: - -Query Defaults -============== - -This page controls the default behavior of Bugzilla in regards to -several aspects of querying bugs. Options include what the default -query options are, what the "My Bugs" page returns, whether users -can freely add bugs to the quip list, and how many duplicate bugs are -needed to add a bug to the "most frequently reported" list. - -.. _param-shadowdatabase: - -Shadow Database -=============== - -This page controls whether a shadow database is used, and all the -parameters associated with the shadow database. Versions of Bugzilla -prior to 3.2 used the MyISAM table type, which supports -only table-level write locking. With MyISAM, any time someone is making a change to -a bug, the entire table is locked until the write operation is complete. -Locking for write also blocks reads until the write is complete. - -The ``shadowdb`` parameter was designed to get around -this limitation. While only a single user is allowed to write to -a table at a time, reads can continue unimpeded on a read-only -shadow copy of the database. - -.. note:: As of version 3.2, Bugzilla no longer uses the MyISAM table type. - Instead, InnoDB is used, which can do transaction-based locking. - Therefore, the limitations the Shadow Database feature was designed - to workaround no longer exist. - -.. _admin-usermatching: - -User Matching -============= - -The settings on this page control how users are selected and queried -when adding a user to a bug. For example, users need to be selected -when choosing who the bug is assigned to, adding to the CC list or -selecting a QA contact. With the "usemenuforusers" parameter, it is -possible to configure Bugzilla to -display a list of users in the fields instead of an empty text field. -This should only be used in Bugzilla installations with a small number -of users. If users are selected via a text box, this page also -contains parameters for how user names can be queried and matched -when entered. - -Another setting called 'ajax_user_autocompletion' enables certain -user fields to display a list of matched user names as a drop down after typing -a few characters. Note that it is recommended to use mod_perl when -enabling 'ajax_user_autocompletion'. - -.. _useradmin: - -User Administration -################### - -.. _defaultuser: - -Creating the Default User -========================= - -When you first run checksetup.pl after installing Bugzilla, it -will prompt you for the administrative username (email address) and -password for this "super user". If for some reason you delete -the "super user" account, re-running checksetup.pl will again prompt -you for this username and password. - -.. note:: If you wish to add more administrative users, add them to - the "admin" group and, optionally, edit the tweakparams, editusers, - creategroups, editcomponents, and editkeywords groups to add the - entire admin group to those groups (which is the case by default). - -.. _manageusers: - -Managing Other Users -==================== - -.. _user-account-search: - -Searching for existing users ----------------------------- - -If you have ``editusers`` privileges or if you are allowed -to grant privileges for some groups, the ``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 "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. - -.. _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 his -own user account, you have to edit the ``createemailregexp`` -parameter in the ``Configuration`` page, see -:ref:`parameters`. - -.. _user-account-creation: - -Accounts created by an administrator -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -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. - -.. _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 ``emailsuffix`` parameter, this may - just be the user's login name. Note that users can now 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, or 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 e-mail gateway, if one exists. - The e-mail 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, - as well as modify 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. As always, - the keywords for existing bugs containing the keyword the user - wishes to destroy must be changed before Bugzilla will allow it - to die. - -- *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 - ``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 ``editbugs`` - privilege to edit bugs in these products. - -.. _user-account-deletion: - -Deleting Users --------------- - -If the ``allowuserdeletion`` parameter is turned on, see -:ref:`parameters`, then you can also delete user accounts. -Note that this is most of the time 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. - -.. _classifications: - -Classifications -############### - -Classifications tend to be used in order to group several related -products into one distinct entity. - -The classifications layer is disabled by default; it can be turned -on or off using the useclassification parameter, -in the *Bug Fields* section of the edit parameters screen. - -Access to the administration of classifications is controlled using -the *editclassifications* system group, which defines -a privilege for creating, destroying, and editing classifications. - -When activated, classifications will introduce an additional -step when filling bugs (dedicated to classification selection), and they -will also appear in the advanced search form. - -.. _products: - -Products -######## - -Products typically represent real-world -shipping products. Products can be given -:ref:`classifications`. -For example, if a company makes computer games, -they could have a classification of "Games", and a separate -product for each game. This company might also have a -``Common`` product for units of technology used -in multiple games, and perhaps a few special products that -represent items that are not actually shipping products -(for example, "Website", or "Administration"). - -Many of Bugzilla's settings are configurable on a per-product -basis. The number of ``votes`` available to -users is set per-product, as is the number of votes -required to move a bug automatically from the UNCONFIRMED -status to the CONFIRMED status. - -When creating or editing products the following options are -available: - -Product - The name of the product - -Description - A brief description of the product - -Default milestone - Select the default milestone for this product. - -Closed for bug entry - Select this box to prevent new bugs from being - entered against this product. - -Maximum votes per person - Maximum votes a user is allowed to give for this - product - -Maximum votes a person can put on a single bug - Maximum votes a user is allowed to give for this - product in a single bug - -Confirmation threshold - Number of votes needed to automatically remove any - bug against this product from the UNCONFIRMED state - -Version - Specify which version of the product bugs will be - entered against. - -Create chart datasets for this product - Select to make chart datasets available for this product. - -When editing a product there is also a link to edit Group Access Controls, -see :ref:`product-group-controls`. - -.. _create-product: - -Creating New Products -===================== - -To create a new product: - -#. Select ``Administration`` from the footer and then - choose ``Products`` from the main administration page. - -#. Select the ``Add`` link in the bottom right. - -#. Enter the name of the product and a description. The - Description field may contain HTML. - -#. When the product is created, Bugzilla will give a message - stating that a component must be created before any bugs can - be entered against the new product. Follow the link to create - a new component. See :ref:`components` for more - information. - -.. _edit-products: - -Editing Products -================ - -To edit an existing product, click the "Products" link from the -"Administration" page. If the 'useclassification' parameter is -turned on, a table of existing classifications is displayed, -including an "Unclassified" category. The table indicates how many products -are in each classification. Click on the classification name to see its -products. If the 'useclassification' parameter is not in use, the table -lists all products directly. The product table summarizes the information -about the product defined -when the product was created. Click on the product name to edit these -properties, and to access links to other product attributes such as the -product's components, versions, milestones, and group access controls. - -.. _comps-vers-miles-products: - -Adding or Editing Components, Versions and Target Milestones -============================================================ - -To edit existing, or add new, Components, Versions or Target Milestones -to a Product, select the "Edit Components", "Edit Versions" or "Edit -Milestones" links from the "Edit Product" page. A table of existing -Components, Versions or Milestones is displayed. Click on a item name -to edit the properties of that item. Below the table is a link to add -a new Component, Version or Milestone. - -For more information on components, see :ref:`components`. - -For more information on versions, see :ref:`versions`. - -For more information on milestones, see :ref:`milestones`. - -.. _product-group-controls: - -Assigning Group Controls to Products -==================================== - -On the ``Edit Product`` page, there is a link called -``Edit Group Access Controls``. The settings on this page -control the relationship of the groups to the product being edited. - -Group Access Controls are an important aspect of using groups for -isolating products and restricting access to bugs filed against those -products. For more information on groups, including how to create, edit -add users to, and alter permission of, see :ref:`groups`. - -After selecting the "Edit Group Access Controls" link from the "Edit -Product" page, a table containing all user-defined groups for this -Bugzilla installation is displayed. The system groups that are created -when Bugzilla is installed are not applicable to Group Access Controls. -Below is description of what each of these fields means. - -Groups may be applicable (e.g bugs in this product can be associated -with this group) , default (e.g. bugs in this product are in this group -by default), and mandatory (e.g. bugs in this product must be associated -with this group) for each product. Groups can also control access -to bugs for a given product, or be used to make bugs for a product -totally read-only unless the group restrictions are met. The best way to -understand these relationships is by example. See -:ref:`group-control-examples` for examples of -product and group relationships. - -.. note:: Products and Groups are not limited to a one-to-one relationship. - Multiple groups can be associated with the same product, and groups - can be associated with more than one product. - -If any group has *Entry* selected, then the -product will restrict bug entry to only those users -who are members of *all* the groups with -*Entry* selected. - -If any group has *Canedit* selected, -then the product will be read-only for any users -who are not members of *all* of the groups with -*Canedit* selected. *Only* users who -are members of all the *Canedit* groups -will be able to edit bugs for this product. This is an additional -restriction that enables finer-grained control over products rather -than just all-or-nothing access levels. - -The following settings let you -choose privileges on a *per-product basis*. -This is a convenient way to give privileges to -some users for some products only, without having -to give them global privileges which would affect -all products. - -Any group having *editcomponents* -selected allows users who are in this group to edit all -aspects of this product, including components, milestones -and versions. - -Any group having *canconfirm* selected -allows users who are in this group to confirm bugs -in this product. - -Any group having *editbugs* selected allows -users who are in this group to edit all fields of -bugs in this product. - -The *MemberControl* and -*OtherControl* are used in tandem to determine which -bugs will be placed in this group. The only allowable combinations of -these two parameters are listed in a table on the "Edit Group Access Controls" -page. Consult this table for details on how these fields can be used. -Examples of different uses are described below. - -.. _group-control-examples: - -Common Applications of Group Controls -===================================== - -The use of groups is best explained by providing examples that illustrate -configurations for common use cases. The examples follow a common syntax: -*Group: Entry, MemberControl, OtherControl, CanEdit, -EditComponents, CanConfirm, EditBugs*. Where "Group" is the name -of the group being edited for this product. The other fields all -correspond to the table on the "Edit Group Access Controls" page. If any -of these options are not listed, it means they are not checked. - -Basic Product/Group Restriction -------------------------------- - -Suppose there is a product called "Bar". The -"Bar" product can only have bugs entered against it by users in the -group "Foo". Additionally, bugs filed against product "Bar" must stay -restricted to users to "Foo" at all times. Furthermore, only members -of group "Foo" can edit bugs filed against product "Bar", even if other -users could see the bug. This arrangement would achieved by the -following: - -:: - - Product Bar: - foo: ENTRY, MANDATORY/MANDATORY, CANEDIT - -Perhaps such strict restrictions are not needed for product "Bar". A -more lenient way to configure product "Bar" and group "Foo" would be: - -:: - - Product Bar: - foo: ENTRY, SHOWN/SHOWN, EDITCOMPONENTS, CANCONFIRM, EDITBUGS - -The above indicates that for product "Bar", members of group "Foo" can -enter bugs. Any one with permission to edit a bug against product "Bar" -can put the bug -in group "Foo", even if they themselves are not in "Foo". Anyone in group -"Foo" can edit all aspects of the components of product "Bar", can confirm -bugs against product "Bar", and can edit all fields of any bug against -product "Bar". - -General User Access With Security Group ---------------------------------------- - -To permit any user to file bugs against "Product A", -and to permit any user to submit those bugs into a -group called "Security": - -:: - - Product A: - security: SHOWN/SHOWN - -General User Access With A Security Product -------------------------------------------- - -To permit any user to file bugs against product called "Security" -while keeping those bugs from becoming visible to anyone -outside the group "SecurityWorkers" (unless a member of the -"SecurityWorkers" group removes that restriction): - -:: - - Product Security: - securityworkers: DEFAULT/MANDATORY - -Product Isolation With a Common Group -------------------------------------- - -To permit users of "Product A" to access the bugs for -"Product A", users of "Product B" to access the bugs for -"Product B", and support staff, who are members of the "Support -Group" to access both, three groups are needed: - -#. Support Group: Contains members of the support staff. - -#. AccessA Group: Contains users of product A and the Support group. - -#. AccessB Group: Contains users of product B and the Support group. - -Once these three groups are defined, the product group controls -can be set to: - -:: - - Product A: - AccessA: ENTRY, MANDATORY/MANDATORY - Product B: - AccessB: ENTRY, MANDATORY/MANDATORY - -Perhaps the "Support Group" wants more control. For example, -the "Support Group" could be permitted to make bugs inaccessible to -users of both groups "AccessA" and "AccessB". -Then, the "Support Group" could be permitted to publish -bugs relevant to all users in a third product (let's call it -"Product Common") that is read-only -to anyone outside the "Support Group". In this way the "Support Group" -could control bugs that should be seen by both groups. -That configuration would be: - -:: - - Product A: - AccessA: ENTRY, MANDATORY/MANDATORY - Support: SHOWN/NA - Product B: - AccessB: ENTRY, MANDATORY/MANDATORY - Support: SHOWN/NA - Product Common: - Support: ENTRY, DEFAULT/MANDATORY, CANEDIT - -Make a Product Read Only ------------------------- - -Sometimes a product is retired and should no longer have -new bugs filed against it (for example, an older version of a software -product that is no longer supported). A product can be made read-only -by creating a group called "readonly" and adding products to the -group as needed: - -:: - - Product A: - ReadOnly: ENTRY, NA/NA, CANEDIT - -.. note:: For more information on Groups outside of how they relate to products - see :ref:`groups`. - -.. _components: - -Components -########## - -Components are subsections of a Product. E.g. the computer game -you are designing may have a "UI" -component, an "API" component, a "Sound System" component, and a -"Plugins" component, each overseen by a different programmer. It -often makes sense to divide Components in Bugzilla according to the -natural divisions of responsibility within your Product or -company. - -Each component has a default assignee and (if you turned it on in the parameters), -a QA Contact. The default assignee should be the primary person who fixes bugs in -that component. The QA Contact should be the person who will ensure -these bugs are completely fixed. The Assignee, QA Contact, and Reporter -will get email when new bugs are created in this Component and when -these bugs change. Default Assignee and Default QA Contact fields only -dictate the -*default assignments*; -these can be changed on bug submission, or at any later point in -a bug's life. - -To create a new Component: - -#. Select the ``Edit components`` link - from the ``Edit product`` page - -#. Select the ``Add`` link in the bottom right. - -#. Fill out the ``Component`` field, a - short ``Description``, the - ``Default Assignee``, ``Default CC List`` - and ``Default QA Contact`` (if enabled). - The ``Component Description`` field may contain a - limited subset of HTML tags. The ``Default Assignee`` - field must be a login name already existing in the Bugzilla database. - -.. _versions: - -Versions -######## - -Versions are the revisions of the product, such as "Flinders -3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select -field; the usual practice is to select the earliest version known to have -the bug. - -To create and edit Versions: - -#. From the "Edit product" screen, select "Edit Versions" - -#. You will notice that the product already has the default - version "undefined". Click the "Add" link in the bottom right. - -#. Enter the name of the Version. This field takes text only. - Then click the "Add" button. - -.. _milestones: - -Milestones -########## - -Milestones are "targets" that you plan to get a bug fixed by. For -example, you have a bug that you plan to fix for your 3.0 release, it -would be assigned the milestone of 3.0. - -.. note:: Milestone options will only appear for a Product if you turned - on the "usetargetmilestone" parameter in the "Bug Fields" tab of the - "Parameters" page. - -To create new Milestones, and set Default Milestones: - -#. Select "Edit milestones" from the "Edit product" page. - -#. Select "Add" in the bottom right corner. - -#. Enter the name of the Milestone in the "Milestone" field. You - can optionally set the "sortkey", which is a positive or negative - number (-32768 to 32767) that defines where in the list this particular - milestone appears. This is because milestones often do not - occur in alphanumeric order For example, "Future" might be - after "Release 1.2". Select "Add". - -.. _flags-overview: - -Flags -##### - -Flags are a way to attach a specific status to a bug or attachment, -either ``+`` or ``-``. The meaning of these symbols depends on the text -the flag itself, but contextually they could mean pass/fail, -accept/reject, approved/denied, or even a simple yes/no. If your site -allows requestable flags, then users may set a flag to ``?`` as a -request to another user that they look at the bug/attachment, and set -the flag to its correct status. - -.. _flags-simpleexample: - -A Simple Example -================ - -A developer might want to ask their manager, -``Should we fix this bug before we release version 2.0?`` -They might want to do this for a *lot* of bugs, -so it would be nice to streamline the process... - -In Bugzilla, it would work this way: - -#. The Bugzilla administrator creates a flag type called - ``blocking2.0`` that shows up on all bugs in - your product. - It shows up on the ``Show Bug`` screen - as the text ``blocking2.0`` with a drop-down box next - to it. The drop-down box contains four values: an empty space, - ``?``, ``-``, and ``+``. - -#. The developer sets the flag to ``?``. - -#. The manager sees the ``blocking2.0`` - flag with a ``?`` value. - -#. If the manager thinks the feature should go into the product - before version 2.0 can be released, he sets the flag to - ``+``. Otherwise, he sets it to ``-``. - -#. Now, every Bugzilla user who looks at the bug knows whether or - not the bug needs to be fixed before release of version 2.0. - -.. _flags-about: - -About Flags -=========== - -.. _flag-values: - -Values ------- - -Flags can have three values: - -``?`` - A user is requesting that a status be set. (Think of it as 'A question is being asked'.) - -``-`` - The status has been set negatively. (The question has been answered ``no``.) - -``+`` - The status has been set positively. - (The question has been answered ``yes``.) - -Actually, there's a fourth value a flag can have -- -``unset`` -- which shows up as a blank space. This -just means that nobody has expressed an opinion (or asked -someone else to express an opinion) about this bug or attachment. - -.. _flag-askto: - -Using flag requests -=================== - -If a flag has been defined as 'requestable', and a user has enough privileges -to request it (see below), the user can set the flag's status to ``?``. -This status indicates that someone (a.k.a. ``the requester``) is asking -someone else to set the flag to either ``+`` or ``-``. - -If a flag has been defined as 'specifically requestable', -a text box will appear next to the flag into which the requester may -enter a Bugzilla username. That named person (a.k.a. ``the requestee``) -will receive an email notifying them of the request, and pointing them -to the bug/attachment in question. - -If a flag has *not* been defined as 'specifically requestable', -then no such text-box will appear. A request to set this flag cannot be made of -any specific individual, but must be asked ``to the wind``. -A requester may ``ask the wind`` on any flag simply by leaving the text-box blank. - -.. _flag-types: - -Two Types of Flags -================== - -Flags can go in two places: on an attachment, or on a bug. - -.. _flag-type-attachment: - -Attachment Flags ----------------- - -Attachment flags are used to ask a question about a specific -attachment on a bug. - -Many Bugzilla installations use this to -request that one developer ``review`` another -developer's code before they check it in. They attach the code to -a bug report, and then set a flag on that attachment called -``review`` to -``review?boss@domain.com``. -boss@domain.com is then notified by email that -he has to check out that attachment and approve it or deny it. - -For a Bugzilla user, attachment flags show up in three places: - -#. On the list of attachments in the ``Show Bug`` - screen, you can see the current state of any flags that - have been set to ?, +, or -. You can see who asked about - the flag (the requester), and who is being asked (the - requestee). - -#. When you ``Edit`` an attachment, you can - see any settable flag, along with any flags that have - already been set. This ``Edit Attachment`` - screen is where you set flags to ?, -, +, or unset them. - -#. Requests are listed in the ``Request Queue``, which - is accessible from the ``My Requests`` link (if you are - logged in) or ``Requests`` link (if you are logged out) - visible in the footer of all pages. - -.. _flag-type-bug: - -Bug Flags ---------- - -Bug flags are used to set a status on the bug itself. You can -see Bug Flags in the ``Show Bug`` and ``Requests`` -screens, as described above. - -Only users with enough privileges (see below) may set flags on bugs. -This doesn't necessarily include the assignee, reporter, or users with the -``editbugs`` permission. - -.. _flags-admin: - -Administering Flags -=================== - -If you have the ``editcomponents`` permission, you can -edit Flag Types from the main administration page. Clicking the -``Flags`` link will bring you to the ``Administer -Flag Types`` page. Here, you can select whether you want -to create (or edit) a Bug flag, or an Attachment flag. - -No matter which you choose, the interface is the same, so we'll -just go over it once. - -.. _flags-edit: - -Editing a Flag --------------- - -To edit a flag's properties, just click the flag's name. -That will take you to the same -form as described below (:ref:`flags-create`). - -.. _flags-create: - -Creating a Flag ---------------- - -When you click on the ``Create a Flag Type for...`` -link, you will be presented with a form. Here is what the fields in -the form mean: - -.. _flags-create-field-name: - -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. - -.. _flags-create-field-description: - -Description -~~~~~~~~~~~ - -The description describes the flag in more detail. It is visible -in a tooltip when hovering over a flag either in the ``Show Bug`` -or ``Edit Attachment`` pages. This field can be as -long as you like, and can contain any character you want. - -.. _flags-create-field-category: - -Category -~~~~~~~~ - -Default behaviour for a newly-created flag is to appear on -products and all components, which is why ``__Any__:__Any__`` -is already entered in the ``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 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 ``Include``, and your -Product/Component pairing will show up in the ``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 -``Exclude``. The Product/Component pairing will show up in the -``Exclusions`` box on the right. - -This flag *will* and *can* be set for any -products/components that appearing in the ``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 ``Exclusions`` box. -*IMPORTANT: Exclusions override inclusions.* - -You may select a Product without selecting a specific Component, -but you can't select a Component without a Product, or to select a -Component that does not belong to the named Product. If you do so, -Bugzilla will display an error message, even if all your products -have a component by that name. - -*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``. -But, there's one component in ``Jet Plane,`` -called ``Pilot.`` 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``. - -.. _flags-create-field-sortkey: - -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, -but they will still be after flags with a lower sort key, and before flags -with a higher sort key. - -*Example:* I have AFlag (Sort Key 100), BFlag (Sort Key 10), -CFlag (Sort Key 10), and DFlag (Sort Key 1). These show up in -the order: DFlag, BFlag, CFlag, AFlag. - -.. _flags-create-field-active: - -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 ``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. - -.. _flags-create-field-requestable: - -Requestable -~~~~~~~~~~~ - -New flags are, by default, ``requestable``, meaning that they -offer users the ``?`` option, as well as ``+`` -and ``-``. -To remove the ? option, uncheck ``requestable``. - -.. _flags-create-field-specific: - -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 may -only be made ``to the wind.`` 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). - -.. _flags-create-field-multiplicable: - -Multiplicable -~~~~~~~~~~~~~ - -Any flag with ``Multiplicable`` 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. - -.. _flags-create-field-cclist: - -CC List -~~~~~~~ - -If you want certain users to be notified every time this flag is -set to ?, -, +, or unset, add them here. This is a comma-separated -list of email addresses that need not be restricted to Bugzilla usernames. - -.. _flags-create-grant-group: - -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 ``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. - -.. _flags-create-request-group: - -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 ``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. - -.. COMMENT: flags-create - -.. _flags-delete: - -Deleting a Flag ---------------- - -When you are at the ``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 ``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 ``active`` in the flag Edit form. - -.. COMMENT: flags-admin - -.. COMMENT: XXX We should add a "Uses of Flags" section, here, with examples. - -.. COMMENT: flags - -.. _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. If the administrator changes -a keyword currently applied to any bugs, the keyword cache must be rebuilt -using the :ref:`sanitycheck` script. Currently keywords cannot -be marked obsolete to prevent future usage. - -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. Once created, keywords can be selected -and applied to individual bugs in that bug's "Details" section. - -.. _custom-fields: - -Custom Fields -############# - -The release of Bugzilla 3.0 added the ability to create Custom Fields. -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 which is used as the label for this Custom Field. - That is the string that users will see, and 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:`bugreports` - 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, and 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 which 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 which are marked as obsolete, and which never -have 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. But marking the field as obsolete is sufficient -to hide it from the user interface entirely. - -.. _edit-values: - -Legal Values -############ - -Legal values for the operating system, platform, bug priority and -severity, 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 values which 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 fields and Custom Fields, 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 used by 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. - -.. _bug_status_workflow: - -Bug Status Workflow -################### - -The bug status workflow is no longer hardcoded but can be freely customized -from the web interface. Only one bug status cannot be renamed nor deleted, -UNCONFIRMED, but the workflow involving it is free. The configuration -page displays all existing bug statuses twice, first on the left for bug -statuses we come from and on the top for bug statuses we move to. -If the checkbox is checked, then the transition between the two bug statuses -is legal, else it's forbidden independently of your privileges. The bug status -used for the "duplicate_or_move_bug_status" parameter must be part of the -workflow as that is the bug status which will be used when duplicating or -moving a bug, so it must be available from each bug status. - -When the workflow is set, the "View Current Triggers" link below the table -lets you set which transitions require a comment from the user. - -.. _voting: - -Voting -###### - -All of the code for voting in Bugzilla has been moved into an -extension, called "Voting", in the :file:`extensions/Voting/` -directory. To enable it, you must remove the :file:`disabled` -file from that directory, and run :file:`checksetup.pl`. - -Voting allows users to be given a pot of votes which they can allocate -to bugs, to indicate that they'd like them fixed. -This allows developers to gauge -user need for a particular enhancement or bugfix. By allowing bugs with -a certain number of votes to automatically move from "UNCONFIRMED" to -"CONFIRMED", users of the bug system can help high-priority bugs garner -attention so they don't sit for a long time awaiting triage. - -To modify Voting settings: - -#. Navigate to the "Edit product" screen for the Product you - wish to modify - -#. *Maximum Votes per person*: - Setting this field to "0" disables voting. - -#. *Maximum Votes a person can put on a single - bug*: - It should probably be some number lower than the - "Maximum votes per person". Don't set this field to "0" if - "Maximum votes per person" is non-zero; that doesn't make - any sense. - -#. *Number of votes a bug in this product needs to - automatically get out of the UNCONFIRMED state*: - Setting this field to "0" disables the automatic move of - bugs from UNCONFIRMED to CONFIRMED. - -#. Once you have adjusted the values to your preference, click - "Update". - -.. _quips: - -Quips -##### - -Quips are small text messages that can be configured to appear -next to search results. A Bugzilla installation can have 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 the *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, it is enough to click -on a quip when it is displayed together with the search results. Or -it can be seen directly in the browser by visiting the quips.cgi URL -(prefixed with the usual web location of the Bugzilla installation). -Once the quip interface is displayed, it is enough to click the -"view and edit the whole quip list" in order to see the administration -page. A page with all the quips available in the database will -be displayed. - -Next to each quip there is a checkbox, under the -"Approved" column. Quips who 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 they 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". - -.. _groups: - -Groups and Group 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 - by 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 who's 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 '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 '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 '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:`useradmin`. - -#. 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`. - -.. _sanitycheck: - -Checking and Maintaining Database Integrity -########################################### - -Over time it is possible for the Bugzilla database to become corrupt -or to have anomalies. -This could happen through normal usage of Bugzilla, manual database -administration outside of the Bugzilla user interface, or from some -other unexpected event. Bugzilla includes a "Sanity Check" script that -can perform several basic database checks, and repair certain problems or -inconsistencies. - -To run the "Sanity Check" script, log in as an Administrator and click the -"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. - -The "Sanity Check" script 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. - -The "Sanity Check" script should be run on a regular basis as a matter of -best practice. - -.. warning:: The "Sanity Check" script is no substitute for a competent database - administrator. It is only designed to check and repair basic database - problems. - - diff --git a/docs/en/rst/api.rst b/docs/en/rst/api/index.rst index 99cb94c6d..55c997a68 100644 --- a/docs/en/rst/api.rst +++ b/docs/en/rst/api/index.rst @@ -1,5 +1,7 @@ -WebService API -============== +.. _apis: + +WebService API Reference +======================== This Bugzilla installation has the following WebService APIs available (as of the last time you compiled the documentation): @@ -7,5 +9,5 @@ This Bugzilla installation has the following WebService APIs available .. toctree:: :glob: - api/core/v*/index* - api/extensions/*/v*/index* + core/v*/index* + extensions/*/v*/index* diff --git a/docs/en/rst/conf.py b/docs/en/rst/conf.py index e55874a67..b371d8393 100644 --- a/docs/en/rst/conf.py +++ b/docs/en/rst/conf.py @@ -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 = True + +extlinks = {'bug': ('https://bugzilla.mozilla.org/show_bug.cgi?id=%s', 'bug ')} diff --git a/docs/en/rst/customization.rst b/docs/en/rst/customization.rst deleted file mode 100644 index 01f7fce1d..000000000 --- a/docs/en/rst/customization.rst +++ /dev/null @@ -1,481 +0,0 @@ -.. highlight:: perl - -.. _customization: - -==================== -Customizing Bugzilla -==================== - -.. _extensions: - -Bugzilla Extensions -################### - -One of the best ways to customize Bugzilla is by writing a Bugzilla -Extension. Bugzilla Extensions let you 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. - -See the `Bugzilla Extension -documentation <../html/api/Bugzilla/Extension.html>`_ for information on how to write an Extension. - -.. _cust-skins: - -Custom Skins -############ - -Bugzilla allows you to have multiple skins. These are custom CSS and possibly -also custom images for Bugzilla. To create a new custom skin, you have two -choices: - -- Make a single CSS file, and put it in the - :file:`skins/contrib` directory. - -- Make a directory that contains all the same CSS file - names as :file:`skins/standard/`, and put - your directory in :file:`skins/contrib/`. - -After you put the file or the directory there, make sure to run checksetup.pl -so that it can reset the file permissions correctly. - -After you have installed the new skin, it will show up as an option in the -user's General Preferences. If you would like to force a particular skin on all -users, just select it in the Default Preferences and then uncheck "Enabled" on -the preference. - -.. _cust-templates: - -Template Customization -###################### - -Administrators can configure the look and feel of Bugzilla without -having to edit Perl files or face the nightmare of massive merge -conflicts when they upgrade to a newer version in the future. - -Templatization also makes localized versions of Bugzilla possible, -for the first time. It's possible to have Bugzilla's UI language -determined by the user's browser. More information is available in -:ref:`template-http-accept`. - -.. _template-directory: - -Template Directory Structure -============================ - -The template directory structure starts with top level directory -named :file:`template`, which contains a directory -for each installed localization. The next level defines the -language used in the templates. Bugzilla comes with English -templates, so the directory name is :file:`en`, -and we will discuss :file:`template/en` throughout -the documentation. Below :file:`template/en` is the -:file:`default` directory, which contains all the -standard templates shipped with Bugzilla. - -.. warning:: A directory :file:`data/templates` also exists; - this is where Template Toolkit puts the compiled versions of - the templates from either the default or custom directories. - *Do not* directly edit the files in this - directory, or all your changes will be lost the next time - Template Toolkit recompiles the templates. - -.. _template-method: - -Choosing a Customization Method -=============================== - -If you want to edit Bugzilla's templates, the first decision -you must make is how you want to go about doing so. There are two -choices, and which you use depends mainly on the scope of your -modifications, and the method you plan to use to upgrade Bugzilla. - -The first method of making customizations is to directly edit the -templates found in :file:`template/en/default`. -This is probably the best way to go about it if you are going to -be upgrading Bugzilla through Bzr, because if you then execute -a :command:`bzr update`, any changes you have made will -be merged automagically with the updated versions. - -.. note:: If you use this method, and Bzr conflicts occur during an - update, the conflicted templates (and possibly other parts - of your installation) will not work until they are resolved. - -The second method is to copy the templates to be modified -into a mirrored directory structure under -:file:`template/en/custom`. Templates in this -directory structure automatically override any identically-named -and identically-located templates in the -:file:`default` directory. - -.. note:: The :file:`custom` directory does not exist - at first and must be created if you want to use it. - -The second method of customization should be used if you -use the overwriting method of upgrade, because otherwise -your changes will be lost. This method may also be better if -you are using the Bzr method of upgrading and are going to make major -changes, because it is guaranteed that the contents of this directory -will not be touched during an upgrade, and you can then decide whether -to continue using your own templates, or make the effort to merge your -changes into the new versions by hand. - -Using this method, your installation may break if incompatible -changes are made to the template interface. Such changes should -be documented in the release notes, provided you are using a -stable release of Bugzilla. If you use using unstable code, you will -need to deal with this one yourself, although if possible the changes -will be mentioned before they occur in the deprecations section of the -previous stable release's release notes. - -.. note:: Regardless of which method you choose, it is recommended that - you run :command:`./checksetup.pl` after - editing any templates in the :file:`template/en/default` - directory, and after creating or editing any templates in - the :file:`custom` directory. - -.. warning:: It is *required* that you run :command:`./checksetup.pl` after - creating a new - template in the :file:`custom` directory. Failure - to do so will raise an incomprehensible error message. - -.. _template-edit: - -How To Edit Templates -===================== - -.. note:: If you are making template changes that you intend on submitting back - for inclusion in standard Bugzilla, you should read the relevant - sections of the - `Developers' - Guide <http://www.bugzilla.org/docs/developer.html>`_. - -The syntax of the Template Toolkit language is beyond the scope of -this guide. It's reasonably easy to pick up by looking at the current -templates; or, you can read the manual, available on the -`Template Toolkit home -page <http://www.template-toolkit.org>`_. - -One thing you should take particular care about is the need -to properly HTML filter data that has been passed into the template. -This means that if the data can possibly contain special HTML characters -such as <, and the data was not intended to be HTML, they need to be -converted to entity form, i.e. <. You use the 'html' filter in the -Template Toolkit to do this (or the 'uri' filter to encode special -characters in URLs). If you forget, you may open up your installation -to cross-site scripting attacks. - -Editing templates is a good way of doing a ``poor man's custom -fields``. -For example, if you don't use the Status Whiteboard, but want to have -a free-form text entry box for ``Build Identifier``, -then you can just -edit the templates to change the field labels. It's still be called -status_whiteboard internally, but your users don't need to know that. - -.. _template-formats: - -Template Formats and Types -========================== - -Some CGI's have the ability to use more than one template. For example, -:file:`buglist.cgi` can output itself as RDF, or as two -formats of HTML (complex and simple). The mechanism that provides this -feature is extensible. - -Bugzilla can support different types of output, which again can have -multiple formats. In order to request a certain type, you can append -the &ctype=<contenttype> (such as rdf or html) to the -:file:`<cginame>.cgi` URL. If you would like to -retrieve a certain format, you can use the &format=<format> -(such as simple or complex) in the URL. - -To see if a CGI supports multiple output formats and types, grep the -CGI for ``get_format``. If it's not present, adding -multiple format/type support isn't too hard - see how it's done in -other CGIs, e.g. config.cgi. - -To make a new format template for a CGI which supports this, -open a current template for -that CGI and take note of the INTERFACE comment (if present.) This -comment defines what variables are passed into this template. If -there isn't one, I'm afraid you'll have to read the template and -the code to find out what information you get. - -Write your template in whatever markup or text style is appropriate. - -You now need to decide what content type you want your template -served as. The content types are defined in the -:file:`Bugzilla/Constants.pm` file in the -:file:`contenttypes` -constant. If your content type is not there, add it. Remember -the three- or four-letter tag assigned to your content type. -This tag will be part of the template filename. - -.. note:: After adding or changing a content type, it's suitable to - edit :file:`Bugzilla/Constants.pm` in order to reflect - the changes. Also, the file should be kept up to date after an - upgrade if content types have been customized in the past. - -Save the template as :file:`<stubname>-<formatname>.<contenttypetag>.tmpl`. -Try out the template by calling the CGI as -:file:`<cginame>.cgi?format=<formatname>&ctype=<type>` . - -.. _template-specific: - -Particular Templates -==================== - -There are a few templates you may be particularly interested in -customizing for your installation. - -:command:`index.html.tmpl`: -This is the Bugzilla front page. - -:command:`global/header.html.tmpl`: -This defines the header that goes on all Bugzilla pages. -The header includes the banner, which is what appears to users -and is probably what you want to edit instead. However the -header also includes the HTML HEAD section, so you could for -example add a stylesheet or META tag by editing the header. - -:command:`global/banner.html.tmpl`: -This contains the ``banner``, the part of the header -that appears -at the top of all Bugzilla pages. The default banner is reasonably -barren, so you'll probably want to customize this to give your -installation a distinctive look and feel. It is recommended you -preserve the Bugzilla version number in some form so the version -you are running can be determined, and users know what docs to read. - -:command:`global/footer.html.tmpl`: -This defines the footer that goes on all Bugzilla pages. Editing -this is another way to quickly get a distinctive look and feel for -your Bugzilla installation. - -:command:`global/variables.none.tmpl`: -This defines a list of terms that may be changed in order to -``brand`` the Bugzilla instance In this way, terms -like ``bugs`` can be replaced with ``issues`` -across the whole Bugzilla installation. The name -``Bugzilla`` and other words can be customized as well. - -:command:`list/table.html.tmpl`: -This template controls the appearance of the bug lists created -by Bugzilla. Editing this template allows per-column control of -the width and title of a column, the maximum display length of -each entry, and the wrap behaviour of long entries. -For long bug lists, Bugzilla inserts a 'break' every 100 bugs by -default; this behaviour is also controlled by this template, and -that value can be modified here. - -:command:`bug/create/user-message.html.tmpl`: -This is a message that appears near the top of the bug reporting page. -By modifying this, you can tell your users how they should report -bugs. - -:command:`bug/process/midair.html.tmpl`: -This is the page used if two people submit simultaneous changes to the -same bug. The second person to submit their changes will get this page -to tell them what the first person did, and ask if they wish to -overwrite those changes or go back and revisit the bug. The default -title and header on this page read "Mid-air collision detected!" If -you work in the aviation industry, or other environment where this -might be found offensive (yes, we have true stories of this happening) -you'll want to change this to something more appropriate for your -environment. - -:command:`bug/create/create.html.tmpl` and -:command:`bug/create/comment.txt.tmpl`: -You may not wish to go to the effort of creating custom fields in -Bugzilla, yet you want to make sure that each bug report contains -a number of pieces of important information for which there is not -a special field. The bug entry system has been designed in an -extensible fashion to enable you to add arbitrary HTML widgets, -such as drop-down lists or textboxes, to the bug entry page -and have their values appear formatted in the initial comment. -A hidden field that indicates the format should be added inside -the form in order to make the template functional. Its value should -be the suffix of the template filename. For example, if the file -is called :file:`create-cust.html.tmpl`, then - -:: - - <input type="hidden" name="format" value="cust"> - -should be used inside the form. - -An example of this is the mozilla.org -`guided -bug submission form <http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi?product=WorldControl;format=guided>`_. The code for this comes with the Bugzilla -distribution as an example for you to copy. It can be found in the -files -:file:`create-guided.html.tmpl` and -:file:`comment-guided.html.tmpl`. - -So to use this feature, create a custom template for -:file:`enter_bug.cgi`. The default template, on which you -could base it, is -:file:`custom/bug/create/create.html.tmpl`. -Call it :file:`create-<formatname>.html.tmpl`, and -in it, add widgets for each piece of information you'd like -collected - such as a build number, or set of steps to reproduce. - -Then, create a template like -:file:`custom/bug/create/comment.txt.tmpl`, and call it -:file:`comment-<formatname>.txt.tmpl`. This -template should reference the form fields you have created using -the syntax :file:`[% form.<fieldname> %]`. When a -bug report is -submitted, the initial comment attached to the bug report will be -formatted according to the layout of this template. - -For example, if your custom enter_bug template had a field - -:: - - <input type="text" name="buildid" size="30"> - -and then your comment.txt.tmpl had - -:: - - BuildID: \[% form.buildid %] - -then something like - -:: - - BuildID: 20020303 - -would appear in the initial comment. - -.. _template-http-accept: - -Configuring Bugzilla to Detect the User's Language -================================================== - -Bugzilla honours the user's Accept: HTTP header. You can install -templates in other languages, and Bugzilla will pick the most appropriate -according to a priority order defined by you. Many -language templates can be obtained from `<http://www.bugzilla.org/download.html#localizations>`_. Instructions -for submitting new languages are also available from that location. - -.. _cust-change-permissions: - -Customizing Who Can Change What -############################### - -.. warning:: This feature should be considered experimental; the Bugzilla code you - will be changing is not stable, and could change or move between - versions. Be aware that if you make modifications as outlined here, - you may have - to re-make them or port them if Bugzilla changes internally between - versions, and you upgrade. - -Companies often have rules about which employees, or classes of employees, -are allowed to change certain things in the bug system. For example, -only the bug's designated QA Contact may be allowed to VERIFY the bug. -Bugzilla has been -designed to make it easy for you to write your own custom rules to define -who is allowed to make what sorts of value transition. - -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. - -For maximum flexibility, customizing this means editing Bugzilla's Perl -code. This gives the administrator complete control over exactly who is -allowed to do what. The relevant method is called -:file:`check_can_change_field()`, -and is found in :file:`Bug.pm` in your -Bugzilla/ directory. If you open that file and search for -``sub check_can_change_field``, you'll find it. - -This function has been carefully commented to allow you to see exactly -how it works, and give you an idea of how to make changes to it. -Certain marked sections should not be changed - these are -the ``plumbing`` which makes the rest of the function work. -In between those sections, you'll find snippets of code like: - -:: - - # Allow the assignee to change anything. - if ($ownerid eq $whoid) { - return 1; - } - -It's fairly obvious what this piece of code does. - -So, how does one go about changing this function? Well, simple changes -can be made just by removing pieces - for example, if you wanted to -prevent any user adding a comment to a bug, just remove the lines marked -``Allow anyone to change comments.`` If you don't want the -Reporter to have any special rights on bugs they have filed, just -remove the entire section that deals with the Reporter. - -More complex customizations are not much harder. Basically, you add -a check in the right place in the function, i.e. after all the variables -you are using have been set up. So, don't look at $ownerid before -$ownerid has been obtained from the database. You can either add a -positive check, which returns 1 (allow) if certain conditions are true, -or a negative check, which returns 0 (deny.) E.g.: - -:: - - if ($field eq "qacontact") { - if (Bugzilla->user->in_group("quality_assurance")) { - return 1; - } - else { - return 0; - } - } - -This says that only users in the group "quality_assurance" can change -the QA Contact field of a bug. - -Getting more weird: - -:: - - if (($field eq "priority") && - (Bugzilla->user->email =~ /.*\\@example\\.com$/)) - { - if ($oldvalue eq "P1") { - return 1; - } - else { - return 0; - } - } - -This says that if the user is trying to change the priority field, -and their email address is @example.com, they can only do so if the -old value of the field was "P1". Not very useful, but illustrative. - -.. warning:: If you are modifying :file:`process_bug.cgi` in any - way, do not change the code that is bounded by DO_NOT_CHANGE blocks. - Doing so could compromise security, or cause your installation to - stop working entirely. - -For a list of possible field names, look at the bugs table in the -database. If you need help writing custom rules for your organization, -ask in the newsgroup. - -.. _integration: - -Integrating Bugzilla with Third-Party Tools -########################################### - -Many utilities and applications can integrate with Bugzilla, -either on the client- or server-side. None of them are maintained -by the Bugzilla community, nor are they tested during our -QA tests, so use them at your own risk. They are listed at -`<https://wiki.mozilla.org/Bugzilla:Addons>`_. - - diff --git a/docs/en/rst/extensions.rst b/docs/en/rst/extensions.rst deleted file mode 100644 index fa444a052..000000000 --- a/docs/en/rst/extensions.rst +++ /dev/null @@ -1,10 +0,0 @@ -Extensions -========== - -Your Bugzilla installation has the following extensions available (as of the -last time you compiled the documentation): - -.. toctree:: - :glob: - - extensions/*/* diff --git a/docs/en/rst/gfdl.rst b/docs/en/rst/gfdl.rst deleted file mode 100644 index 4c831a1d4..000000000 --- a/docs/en/rst/gfdl.rst +++ /dev/null @@ -1,408 +0,0 @@ - - -.. _gfdl: - -============================== -GNU Free Documentation License -============================== - -.. COMMENT: - GNU Project - Free Software Foundation (FSF) - -.. COMMENT: LINK REV="made" HREF="mailto:webmasters@gnu.org" - -.. COMMENT: section> - <title>GNU Free Documentation License</title - -Version 1.1, March 2000 - - Copyright (C) 2000 Free Software Foundation, Inc. 51 Franklin Street, - Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and - distribute verbatim copies of this license document, but changing it is - not allowed. - -.. _gfdl-0: - -Preamble -######## - -The purpose of this License is to make a manual, textbook, or other -written document "free" in the sense of freedom: to assure everyone the -effective freedom to copy and redistribute it, with or without modifying -it, either commercially or noncommercially. Secondarily, this License -preserves for the author and publisher a way to get credit for their -work, while not being considered responsible for modifications made by -others. - -This License is a kind of "copyleft", which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft license -designed for free software. - -We have designed this License in order to use it for manuals for -free software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; it -can be used for any textual work, regardless of subject matter or whether -it is published as a printed book. We recommend this License principally -for works whose purpose is instruction or reference. - -.. _gfdl-1: - -Applicability and Definition -############################ - -This License applies to any manual or other work that contains a -notice placed by the copyright holder saying it can be distributed under -the terms of this License. The "Document", below, refers to any such -manual or work. Any member of the public is a licensee, and is addressed -as "you". - -A "Modified Version" of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A "Secondary Section" is a named appendix or a front-matter section -of the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall subject -(or to related matters) and contains nothing that could fall directly -within that overall subject. (For example, if the Document is in part a -textbook of mathematics, a Secondary Section may not explain any -mathematics.) The relationship could be a matter of historical connection -with the subject or with related matters, or of legal, commercial, -philosophical, ethical or political position regarding them. - -The "Invariant Sections" are certain Secondary Sections whose -titles are designated, as being those of Invariant Sections, in the -notice that says that the Document is released under this License. - -The "Cover Texts" are certain short passages of text that are -listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says -that the Document is released under this License. - -A "Transparent" copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the general -public, whose contents can be viewed and edited directly and -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or for -automatic translation to a variety of formats suitable for input to text -formatters. A copy made in an otherwise Transparent file format whose -markup has been designed to thwart or discourage subsequent modification -by readers is not Transparent. A copy that is not "Transparent" is called -"Opaque". - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input format, SGML or -XML using a publicly available DTD, and standard-conforming simple HTML -designed for human modification. Opaque formats include PostScript, PDF, -proprietary formats that can be read and edited only by proprietary word -processors, SGML or XML for which the DTD and/or processing tools are not -generally available, and the machine-generated HTML produced by some word -processors for output purposes only. - -The "Title Page" means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in formats -which do not have any title page as such, "Title Page" means the text -near the most prominent appearance of the work's title, preceding the -beginning of the body of the text. - -.. _gfdl-2: - -Verbatim Copying -################ - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies to -the Document are reproduced in all copies, and that you add no other -conditions whatsoever to those of this License. You may not use technical -measures to obstruct or control the reading or further copying of the -copies you make or distribute. However, you may accept compensation in -exchange for copies. If you distribute a large enough number of copies -you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, -and you may publicly display copies. - -.. _gfdl-3: - -Copying in Quantity -################### - -If you publish printed copies of the Document numbering more than -100, and the Document's license notice requires Cover Texts, you must -enclose the copies in covers that carry, clearly and legibly, all these -Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts -on the back cover. Both covers must also clearly and legibly identify you -as the publisher of these copies. The front cover must present the full -title with all words of the title equally prominent and visible. You may -add other material on the covers in addition. Copying with changes -limited to the covers, as long as they preserve the title of the Document -and satisfy these conditions, can be treated as verbatim copying in other -respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit reasonably) -on the actual cover, and continue the rest onto adjacent pages. - -If you publish or distribute Opaque copies of the Document -numbering more than 100, you must either include a machine-readable -Transparent copy along with each Opaque copy, or state in or with each -Opaque copy a publicly-accessible computer-network location containing a -complete Transparent copy of the Document, free of added material, which -the general network-using public has access to download anonymously at no -charge using public-standard network protocols. If you use the latter -option, you must take reasonably prudent steps, when you begin -distribution of Opaque copies in quantity, to ensure that this -Transparent copy will remain thus accessible at the stated location until -at least one year after the last time you distribute an Opaque copy -(directly or through your agents or retailers) of that edition to the -public. - -It is requested, but not required, that you contact the authors of -the Document well before redistributing any large number of copies, to -give them a chance to provide you with an updated version of the -Document. - -.. _gfdl-4: - -Modifications -############# - -You may copy and distribute a Modified Version of the Document -under the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution and -modification of the Modified Version to whoever possesses a copy of it. -In addition, you must do these things in the Modified Version: - -#. Use in the Title Page (and on the covers, if any) a title - distinct from that of the Document, and from those of previous - versions (which should, if there were any, be listed in the History - section of the Document). You may use the same title as a previous - version if the original publisher of that version gives - permission. - -#. List on the Title Page, as authors, one or more persons or - entities responsible for authorship of the modifications in the - Modified Version, together with at least five of the principal - authors of the Document (all of its principal authors, if it has less - than five). - -#. State on the Title page the name of the publisher of the - Modified Version, as the publisher. - -#. Preserve all the copyright notices of the Document. - -#. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. - -#. Include, immediately after the copyright notices, a license - notice giving the public permission to use the Modified Version under - the terms of this License, in the form shown in the Addendum - below. - -#. Preserve in that license notice the full lists of Invariant - Sections and required Cover Texts given in the Document's license - notice. - -#. Include an unaltered copy of this License. - -#. Preserve the section entitled "History", and its title, and add - to it an item stating at least the title, year, new authors, and - publisher of the Modified Version as given on the Title Page. If - there is no section entitled "History" in the Document, create one - stating the title, year, authors, and publisher of the Document as - given on its Title Page, then add an item describing the Modified - Version as stated in the previous sentence. - -#. Preserve the network location, if any, given in the Document - for public access to a Transparent copy of the Document, and likewise - the network locations given in the Document for previous versions it - was based on. These may be placed in the "History" section. You may - omit a network location for a work that was published at least four - years before the Document itself, or if the original publisher of the - version it refers to gives permission. - -#. In any section entitled "Acknowledgements" or "Dedications", - preserve the section's title, and preserve in the section all the - substance and tone of each of the contributor acknowledgements and/or - dedications given therein. - -#. Preserve all the Invariant Sections of the Document, unaltered - in their text and in their titles. Section numbers or the equivalent - are not considered part of the section titles. - -#. Delete any section entitled "Endorsements". Such a section may - not be included in the Modified Version. - -#. Do not retitle any existing section as "Endorsements" or to - conflict in title with any Invariant Section. - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all of -these sections as invariant. To do this, add their titles to the list of -Invariant Sections in the Modified Version's license notice. These titles -must be distinct from any other section titles. - -You may add a section entitled "Endorsements", provided it contains -nothing but endorsements of your Modified Version by various parties--for -example, statements of peer review or that the text has been approved by -an organization as the authoritative definition of a standard. - -You may add a passage of up to five words as a Front-Cover Text, -and a passage of up to 25 words as a Back-Cover Text, to the end of the -list of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or through -arrangements made by) any one entity. If the Document already includes a -cover text for the same cover, previously added by you or by arrangement -made by the same entity you are acting on behalf of, you may not add -another; but you may replace the old one, on explicit permission from the -previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this -License give permission to use their names for publicity for or to assert -or imply endorsement of any Modified Version. - -.. _gfdl-5: - -Combining Documents -################### - -You may combine the Document with other documents released under -this License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and list -them all as Invariant Sections of your combined work in its license -notice. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single copy. -If there are multiple Invariant Sections with the same name but different -contents, make the title of each such section unique by adding at the end -of it, in parentheses, the name of the original author or publisher of -that section if known, or else a unique number. Make the same adjustment -to the section titles in the list of Invariant Sections in the license -notice of the combined work. - -In the combination, you must combine any sections entitled -"History" in the various original documents, forming one section entitled -"History"; likewise combine any sections entitled "Acknowledgements", and -any sections entitled "Dedications". You must delete all sections -entitled "Endorsements." - -.. _gfdl-6: - -Collections of Documents -######################## - -You may make a collection consisting of the Document and other -documents released under this License, and replace the individual copies -of this License in the various documents with a single copy that is -included in the collection, provided that you follow the rules of this -License for verbatim copying of each of the documents in all other -respects. - -You may extract a single document from such a collection, and -distribute it individually under this License, provided you insert a copy -of this License into the extracted document, and follow this License in -all other respects regarding verbatim copying of that document. - -.. _gfdl-7: - -Aggregation with Independent Works -################################## - -A compilation of the Document or its derivatives with other -separate and independent documents or works, in or on a volume of a -storage or distribution medium, does not as a whole count as a Modified -Version of the Document, provided no compilation copyright is claimed for -the compilation. Such a compilation is called an "aggregate", and this -License does not apply to the other self-contained works thus compiled -with the Document, on account of their being thus compiled, if they are -not themselves derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one quarter of -the entire aggregate, the Document's Cover Texts may be placed on covers -that surround only the Document within the aggregate. Otherwise they must -appear on covers around the whole aggregate. - -.. _gfdl-8: - -Translation -########### - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include translations -of some or all Invariant Sections in addition to the original versions of -these Invariant Sections. You may include a translation of this License -provided that you also include the original English version of this -License. In case of a disagreement between the translation and the -original English version of this License, the original English version -will prevail. - -.. _gfdl-9: - -Termination -########### - -You may not copy, modify, sublicense, or distribute the Document -except as expressly provided for under this License. Any other attempt to -copy, modify, sublicense or distribute the Document is void, and will -automatically terminate your rights under this License. However, parties -who have received copies, or rights, from you under this License will not -have their licenses terminated so long as such parties remain in full -compliance. - -.. _gfdl-10: - -Future Revisions of this License -################################ - -The Free Software Foundation may publish new, revised versions of -the GNU Free Documentation License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in -detail to address new problems or concerns. See -`<http://www.gnu.org/copyleft/>`_. - -Each version of the License is given a distinguishing version -number. If the Document specifies that a particular numbered version of -this License "or any later version" applies to it, you have the option of -following the terms and conditions either of that specified version or of -any later version that has been published (not as a draft) by the Free -Software Foundation. If the Document does not specify a version number of -this License, you may choose any version ever published (not as a draft) -by the Free Software Foundation. - -.. _gfdl-howto: - -How to use this License for your documents -########################################## - -To use this License in a document you have written, include a copy -of the License in the document and put the following copyright and -license notices just after the title page: - - Copyright (c) YEAR YOUR NAME. 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 the Invariant Sections being LIST - THEIR TITLES, with the Front-Cover Texts being LIST, and with the - Back-Cover Texts being LIST. A copy of the license is included in the - section entitled "GNU Free Documentation License". - -If you have no Invariant Sections, write "with no Invariant -Sections" instead of saying which ones are invariant. If you have no -Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover -Texts being LIST"; likewise for Back-Cover Texts. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of free -software license, such as the GNU General Public License, to permit their -use in free software. - diff --git a/docs/en/rst/index.rst b/docs/en/rst/index.rst index 2da16e223..b877920c6 100644 --- a/docs/en/rst/index.rst +++ b/docs/en/rst/index.rst @@ -1,24 +1,31 @@ -.. 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:: diff --git a/docs/en/rst/installation.rst b/docs/en/rst/installation.rst deleted file mode 100644 index 5c0aa2de5..000000000 --- a/docs/en/rst/installation.rst +++ /dev/null @@ -1,1813 +0,0 @@ -.. highlight:: console - -.. _installing-bugzilla: - -=================== -Installing Bugzilla -=================== - -.. _installation: - -Installation -############ - -.. 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. - -The Bugzilla server software is usually installed on Linux or -Solaris. -If you are installing on another OS, check :ref:`os-specific` -before you start your installation to see if there are any special -instructions. - -This guide assumes that you have administrative access to the -Bugzilla machine. It not possible to -install and run Bugzilla itself without administrative access except -in the very unlikely event that every single prerequisite is -already installed. - -.. warning:: The installation process may make your machine insecure for - short periods of time. Make sure there is a firewall between you - and the Internet. - -You are strongly recommended to make a backup of your system -before installing Bugzilla (and at regular intervals thereafter :-). - -In outline, the installation proceeds as follows: - -#. :ref:`Install Perl <install-perl>` - (|min-perl-ver| or above) - -#. :ref:`Install a Database Engine <install-database>` - -#. :ref:`Install a Webserver <install-webserver>` - -#. :ref:`Install Bugzilla <install-bzfiles>` - -#. :ref:`Install Perl modules <install-perlmodules>` - -#. :ref:`Install a Mail Transfer Agent <install-MTA>` - (Sendmail 8.7 or above, or an MTA that is Sendmail-compatible with at least this version) - -#. Configure all of the above. - -.. _install-perl: - -Perl -==== - -Installed Version Test: -:: - - $ perl -v - -Any machine that doesn't have Perl on it is a sad machine indeed. -If you don't have it and your OS doesn't provide official packages, -visit `<http://www.perl.org>`_. -Although Bugzilla runs with Perl |min-perl-ver|, -it's a good idea to be using the latest stable version. - -.. _install-database: - -Database Engine -=============== - -Bugzilla supports MySQL, PostgreSQL and Oracle as database servers. -You only require one of these systems to make use of Bugzilla. - -.. _install-mysql: - -MySQL ------ - -Installed Version Test: -:: - - $ mysql -V - -If you don't have it and your OS doesn't provide official packages, -visit `<http://www.mysql.com>`_. You need MySQL version -5.0.15 or higher. - -.. note:: Many of the binary - versions of MySQL store their data files in :file:`/var`. - On some Unix systems, this is part of a smaller root partition, - and may not have room for your bug database. To change the data - directory, you have to build MySQL from source yourself, and - set it as an option to :file:`configure`. - -If you install from something other than a packaging/installation -system, such as .rpm (RPM Package Manager), .deb (Debian Package), .exe -(Windows Executable), or .msi (Windows Installer), make sure the MySQL -server is started when the machine boots. - -.. _install-pg: - -PostgreSQL ----------- - -Installed Version Test: -:: - - $ psql -V - -If you don't have it and your OS doesn't provide official packages, -visit `<http://www.postgresql.org/>`_. You need PostgreSQL -version 8.03.0000 or higher. - -If you install from something other than a packaging/installation -system, such as .rpm (RPM Package Manager), .deb (Debian Package), .exe -(Windows Executable), or .msi (Windows Installer), make sure the -PostgreSQL server is started when the machine boots. - -.. _install-oracle: - -Oracle ------- - -Installed Version Test: - -.. code-block:: sql - - SELECT * FROM v$version - -(you first have to log in into your DB) - -If you don't have it and your OS doesn't provide official packages, -visit `<http://www.oracle.com/>`_. You need Oracle -version 10.02.0 or higher. - -If you install from something other than a packaging/installation -system, such as .rpm (RPM Package Manager), .deb (Debian Package), .exe -(Windows Executable), or .msi (Windows Installer), make sure the -Oracle server is started when the machine boots. - -.. _install-webserver: - -Web Server -========== - -Installed Version Test: view the default welcome page at -`http://<your-machine>/` . - -You have freedom of choice here, pretty much any web server that -is capable of running CGI -scripts will work. -However, we strongly recommend using the Apache web server -(either 1.3.x or 2.x), and the installation instructions usually assume -you are using it. If you have got Bugzilla working using another web server, -please share your experiences with us by filing a bug in -`Bugzilla Documentation <http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla;component=Documentation>`_. - -If you don't have Apache and your OS doesn't provide official packages, -visit `<http://httpd.apache.org/>`_. - -.. _install-bzfiles: - -Bugzilla -======== - -`Download a Bugzilla tarball <http://www.bugzilla.org/download/>`_ -(or `check it out from Bzr <https://wiki.mozilla.org/Bugzilla:Bzr>`_) -and place it in a suitable directory, accessible by the default web server user -(probably ``apache`` or ``www``). -Good locations are either directly in the web server's document directories or -in :file:`/usr/local` with a symbolic link to the web server's -document directories 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. - -Once all the files are in a web accessible directory, make that -directory writable by your web server's user. This is a temporary step -until you run the -:file:`checksetup.pl` -script, which locks down your installation. - -.. _install-perlmodules: - -Perl Modules -============ - -Bugzilla's installation process is based -on a script called :file:`checksetup.pl`. -The first thing it checks is whether you have appropriate -versions of all the required -Perl modules. The aim of this section is to pass this check. -When it passes, proceed to :ref:`configuration`. - -At this point, you need to :file:`su` to root. You should -remain as root until the end of the install. To check you have the -required modules, run: - -:: - - # ./checksetup.pl --check-modules - -:file:`checksetup.pl` will print out a list of the -required and optional Perl modules, together with the versions -(if any) installed on your machine. -The list of required modules is reasonably long; however, you -may already have several of them installed. - -The preferred way to install missing Perl modules is to use the package -manager provided by your operating system (e.g ``rpm``, ``apt-get`` or -``yum`` on Linux distros, or ``ppm`` on Windows -if using ActivePerl, see :ref:`win32-perl-modules`). -If some Perl modules are still missing or are too old, then we recommend -using the :file:`install-module.pl` script (doesn't work -with ActivePerl on Windows). For instance, on Unix, -you invoke :file:`install-module.pl` as follows: - -:: - - # perl install-module.pl <modulename> - -.. note:: Many people complain that Perl modules will not install for - them. Most times, the error messages complain that they are missing a - file in - ``@INC``. - Virtually every time, this error is due to permissions being set too - restrictively for you to compile Perl modules or not having the - necessary Perl development libraries installed on your system. - Consult your local UNIX systems administrator for help solving these - permissions issues; if you - *are* - the local UNIX sysadmin, please consult the newsgroup/mailing list - for further assistance or hire someone to help you out. - -.. note:: If you are using a package-based system, and attempting to install the - Perl modules from CPAN, 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`. - -If for some reason you really need to install the Perl modules manually, see -:ref:`install-perlmodules-manual`. - -.. _install-MTA: - -Mail Transfer Agent (MTA) -========================= - -Bugzilla is dependent on the availability of an e-mail system for its -user authentication and for other tasks. - -.. note:: This is not entirely true. It is possible to completely disable - email sending, or to have Bugzilla store email messages in a - file instead of sending them. However, this is mainly intended - for testing, as disabling or diverting email on a production - machine would mean that users could miss important events (such - as bug changes or the creation of new accounts). - For more information, see the ``mail_delivery_method`` parameter - in :ref:`parameters`. - -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 congruent with -at least version 8.7 of Sendmail. - -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 'mail' program -succeeds, then Bugzilla should also be fine. - -.. _using-mod_perl-with-bugzilla: - -Installing Bugzilla on mod_perl -=============================== - -It is now possible to run the Bugzilla software under ``mod_perl`` on -Apache. ``mod_perl`` has some additional requirements to that of running -Bugzilla under ``mod_cgi`` (the standard and previous way). - -Bugzilla requires ``mod_perl`` to be installed, which can be -obtained from `<http://perl.apache.org>`_ - Bugzilla requires -version 1.999022 (AKA 2.0.0-RC5) to be installed. - -.. _configuration: - -Configuration -############# - -.. warning:: Poorly-configured MySQL and Bugzilla installations have - given attackers full access to systems in the past. Please take the - security parts of these guidelines seriously, even for Bugzilla - machines hidden away behind your firewall. Be certain to - read :ref:`security` for some important security tips. - -.. _localconfig: - -localconfig -=========== - -You should now run :file:`checksetup.pl` again, this time -without the ``--check-modules`` switch. - -:: - - # ./checksetup.pl - -This time, :file:`checksetup.pl` should tell you that all -the correct modules are installed and will display a message about, and -write out a file called, :file:`localconfig`. This file -contains the default settings for a number of Bugzilla parameters. - -Load this file in your editor. The only two values you -*need* to change are $db_driver and $db_pass, -respectively the type of the database and the password for -the user you will create for your database. Pick a strong -password (for simplicity, it should not contain single quote -characters) and put it here. $db_driver can be either 'mysql', -'Pg', 'Oracle' or 'Sqlite'. - -.. note:: In Oracle, ``$db_name`` should actually be - the SID name of your database (e.g. "XE" if you are using Oracle XE). - -You may need to change the value of -*webservergroup* if your web server does not -run in the "apache" group. On Debian, for example, Apache runs in -the "www-data" group. If you are going to run Bugzilla on a -machine where you do not have root access (such as on a shared web -hosting account), you will need to leave -*webservergroup* empty, ignoring the warnings -that :file:`checksetup.pl` will subsequently display -every time it is run. - -.. warning:: If you are using suexec, you should use your own primary group - for *webservergroup* rather than leaving it - empty, and see the additional directions in the suexec section :ref:`suexec`. - -The other options in the :file:`localconfig` file -are documented by their accompanying comments. If you have a slightly -non-standard database setup, you may wish to change one or more of -the other "$db_*" parameters. - -.. _database-engine: - -Database Server -=============== - -This section deals with configuring your database server for use -with Bugzilla. Currently, MySQL (:ref:`mysql`), -PostgreSQL (:ref:`postgresql`), Oracle (:ref:`oracle`) -and SQLite (:ref:`sqlite`) are available. - -.. _database-schema: - -Bugzilla Database Schema ------------------------- - -The Bugzilla database schema is available at -`Ravenbrook <http://www.ravenbrook.com/project/p4dti/tool/cgi/bugzilla-schema/>`_. -This very valuable tool can generate a written description of -the Bugzilla database schema for any version of Bugzilla. It -can also generate a diff between two versions to help someone -see what has changed. - -.. _mysql: - -MySQL ------ - -.. warning:: MySQL's default configuration is insecure. - We highly recommend to run :file:`mysql_secure_installation` - on Linux or the MySQL installer on Windows, and follow the instructions. - Important points to note are: - -#. Be sure that the root account has a secure password set. -#. Do not create an anonymous account, and if it exists, say "yes" - to remove it. -#. If your web server and MySQL server are on the same machine, - you should disable the network access. - -.. _mysql-max-allowed-packet: - -Allow large attachments and many comments -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -By default, MySQL will only allow you to insert things -into the database that are smaller than 1MB. 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. - -To change MySQL's default, you need to edit your MySQL -configuration file, which is usually :file:`/etc/my.cnf` -on Linux. We recommend that you allow at least 4MB packets by -adding the "max_allowed_packet" parameter to your MySQL -configuration in the "\[mysqld]" section, like this: - -:: - - [mysqld] - # Allow packets up to 4MB - max_allowed_packet=4M - -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. -This can be done by modifying the :file:`/etc/my.cnf` -according to the example below: - -:: - - [mysqld] - # Allow small words in full-text indexes - ft_min_word_len=2 - -Rebuilding the indexes can be done based on documentation found at -`<http://www.mysql.com/doc/en/Fulltext_Fine-tuning.html>`_. - -.. _install-setupdatabase-adduser: - -Add a user to MySQL -~~~~~~~~~~~~~~~~~~~ - -You need to add a new MySQL user for Bugzilla to use. -(It's not safe to have Bugzilla use the MySQL root account.) -The following instructions assume the defaults in -:file:`localconfig`; if you changed those, -you need to modify the SQL command appropriately. You will -need the $db_pass password you -set in :file:`localconfig` in -:ref:`localconfig`. - -We use an SQL :command:`GRANT` command to create -a ``bugs`` user. This also restricts the -``bugs`` user to operations within a database -called ``bugs``, and only allows the account -to connect from ``localhost``. Modify it to -reflect your setup if you will be connecting from another -machine or as a different user. - -Run the :file:`mysql` command-line client and enter: - -.. code-block:: sql - - 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; - -Permit attachments table to grow beyond 4GB -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -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, follow these -instructions. - -After you have completed the rest of the installation (or at least the -database setup parts), you should run the :file:`MySQL` -command-line client and enter the following, replacing ``$bugs_db`` -with your Bugzilla database name (*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. Ideally, -you should do this when your attachments table is still small. - -.. note:: This does not affect Big Files, attachments that are stored directly - on disk instead of in the database. - -.. _postgresql: - -PostgreSQL ----------- - -Add a User to PostgreSQL -~~~~~~~~~~~~~~~~~~~~~~~~ - -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. You will -need the $db_pass password you -set in :file:`localconfig` in -:ref:`localconfig`. - -On most systems, to create the user in PostgreSQL, you will need to -login as the root user, and then - -:: - - # su - postgres - -As the postgres user, you then need to create a new user: - -:: - - $ createuser -U postgres -dRSP bugs - -When asked for a password, provide the password which will be set as -$db_pass in :file:`localconfig`. -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). - -Configure PostgreSQL -~~~~~~~~~~~~~~~~~~~~ - -Now, you will need to edit :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 restart PostgreSQL, but you will need to fully -stop and start the server rather than just restarting due to the possibility -of a change to :file:`postgresql.conf`. After the server has -restarted, you will need to edit :file:`localconfig`, finding -the ``$db_driver`` variable and setting it to -``Pg`` and changing the password in ``$db_pass`` -to the one you picked previously, while setting up the account. - -.. _oracle: - -Oracle ------- - -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: - -.. code-block:: sql - - 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. - -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. - -.. code-block:: sql - - 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; - -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. - -.. _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. - -No special configuration is required to run Bugzilla on SQLite. -The database will be stored in :file:`data/db/$db_name`, -where ``$db_name`` is the database name defined -in :file:`localconfig`. - -checksetup.pl -============= - -Next, rerun :file:`checksetup.pl`. It reconfirms -that all the modules are present, and notices the altered -localconfig file, which it assumes you have edited to your -satisfaction. It compiles the UI templates, -connects to the database using the 'bugs' -user you created and the password you defined, and creates the -'bugs' database and the tables therein. - -After that, it asks for details of an administrator account. Bugzilla -can have multiple administrators - you can create more later - but -it needs one to start off with. -Enter the email address of an administrator, his or her full name, -and a suitable Bugzilla password. - -:file:`checksetup.pl` will then finish. You may rerun -:file:`checksetup.pl` at any time if you wish. - -.. _http: - -Web server -========== - -Configure your web server according to the instructions in the -appropriate section. (If it makes a difference in your choice, -the Bugzilla Team recommends Apache.) To check whether your web server -is correctly configured, try to access :file:`testagent.cgi` -from your web server. If "OK" is displayed, then your configuration -is successful. Regardless of which web server -you are using, however, ensure that sensitive information is -not remotely available by properly applying the access controls in -:ref:`security-webserver-access`. You can run -:file:`testserver.pl` to check if your web server serves -Bugzilla files as expected. - -.. _http-apache: - -Bugzilla using Apache ---------------------- - -You have two options for running Bugzilla under Apache - -:ref:`mod_cgi <http-apache-mod_cgi>` (the default) and -:ref:`mod_perl <http-apache-mod_perl>` (new in Bugzilla -2.23) - -.. _http-apache-mod_cgi: - -Apache *httpd* with mod_cgi -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To configure your Apache web server to work with Bugzilla while using -mod_cgi, do the following: - -#. Load :file:`httpd.conf` in your editor. - In Fedora and Red Hat Linux, this file is found in - :file:`/etc/httpd/conf`. - -#. Apache uses ``<Directory>`` - directives to permit fine-grained permission setting. Add the - following lines to a directive that applies to the location - of your Bugzilla installation. (If such a section does not - exist, you'll want to add one.) In this example, Bugzilla has - been installed at :file:`/var/www/html/bugzilla`. - -.. code-block:: apache - - <Directory /var/www/html/bugzilla> - AddHandler cgi-script .cgi - Options +ExecCGI - 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. - -.. note:: It is possible to make these changes globally, or to the - directive controlling Bugzilla's parent directory (e.g. - ``<Directory /var/www/html/>``). - Such changes would also apply to the Bugzilla directory... - but they would also apply to many other places where they - may or may not be appropriate. In most cases, including - this one, it is better to be as restrictive as possible - when granting extra access. - -.. note:: On Windows, you may have to also add the - ``ScriptInterpreterSource Registry-Strict`` - line, see :ref:`Windows specific notes <win32-http>`. - -#. :file:`checksetup.pl` can set tighter permissions - on Bugzilla's files and directories if it knows what group the - web server runs as. Find the ``Group`` - line in :file:`httpd.conf`, place the value found - there in the *$webservergroup* variable - in :file:`localconfig`, then rerun :file:`checksetup.pl`. - -#. Optional: If Bugzilla does not actually reside in the webspace - directory, but instead has been symbolically linked there, you - will need to add the following to the - ``Options`` line of the Bugzilla - ``<Directory>`` directive - (the same one as in the step above): - -.. code-block:: apache - - +FollowSymLinks - -Without this directive, Apache will not follow symbolic links -to places outside its own directory structure, and you will be -unable to run Bugzilla. - -Apache *httpd* log files with bugzilla -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For security reasons it is recommended to prevent Apache from logging -query strings. - -For example: -When external systems interact with Bugzilla via webservices (REST/XMLRPC/JSONRPC) -they include the user's credentials as part of the URL (query-string). For security -reasons we recommend configuring Apache to not include the query-string in its log -files to avoid storing passwords in clear text on the server. - -#. Load :file:`httpd.conf` or :file:`apache2.conf` in your editor. - In most of the Linux distributions this file is found in :folder:`/etc/httpd/conf/httpd.conf` - or in :folder:`/etc/apache2/apache2.conf`. - -#. Find the following line in the above mentioned file. - LogFormat "%v:%p %h %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"" vhost_combined. - -#. Replace \"%r\" with \"%m %U\". - -#. Now restart Apache. - -.. _http-apache-mod_perl: - -Apache *httpd* with mod_perl -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Some configuration is required to make Bugzilla work with Apache -and mod_perl - -#. Load :file:`httpd.conf` in your editor. - In Fedora and Red Hat Linux, this file is found in :file:`/etc/httpd/conf`. - -#. Add the following information to your httpd.conf file, substituting - where appropriate with your own local paths. - - .. 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 must be specified - in the order as below. - - .. warning:: You should also ensure that you have disabled ``KeepAlive`` - support in your Apache install when utilizing Bugzilla under mod_perl - -.. code-block:: apache - - PerlSwitches -w -T - PerlConfigRequire /var/www/html/bugzilla/mod_perl.pl - -#. :file:`checksetup.pl` can set tighter permissions - on Bugzilla's files and directories if it knows what group the - web server runs as. Find the ``Group`` - line in :file:`httpd.conf`, place the value found - there in the *$webservergroup* variable - in :file:`localconfig`, then rerun :file:`checksetup.pl`. - -On restarting Apache, Bugzilla should now be running within the -mod_perl environment. Please ensure you have run checksetup.pl to set -permissions before you restart Apache. - -.. note:: Please bear the following points in mind when looking at using - Bugzilla under mod_perl: - - - mod_perl support in Bugzilla can take up a HUGE amount of RAM. You could be - looking at 30MB per httpd child, easily. Basically, you just need a lot of RAM. - 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 localconfig and the 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. - -.. _http-iis: - -Microsoft *Internet Information Services* ------------------------------------------ - -If you are running Bugzilla on Windows and choose to use -Microsoft's *Internet Information Services* -or *Personal Web Server* you will need -to perform a number of other configuration steps as explained below. -You may also want to refer to the following Microsoft Knowledge -Base articles: -`245225 - HOW TO: Configure and Test a PERL Script with IIS 4.0, -5.0, and 5.1 <http://support.microsoft.com/default.aspx?scid=kb;en-us;245225>`_ -(for *Internet Information Services*) and -`231998 - HOW TO: FP2000: How to Use Perl with Microsoft Personal Web -Server on Windows 95/98 <http://support.microsoft.com/default.aspx?scid=kb;en-us;231998>`_ -(for *Personal Web Server*). - -You will need to create a virtual directory for the Bugzilla -install. Put the Bugzilla files in a directory that is named -something *other* than what you want your -end-users accessing. That is, if you want your users to access -your Bugzilla installation through -``http://<yourdomainname>/Bugzilla``, then do -*not* put your Bugzilla files in a directory -named ``Bugzilla``. Instead, place them in a different -location, and then use the IIS Administration tool to create a -Virtual Directory named "Bugzilla" that acts as an alias for the -actual location of the files. When creating that virtual directory, -make sure you add the ``Execute (such as ISAPI applications or -CGI)`` access permission. - -You will also need to tell IIS how to handle Bugzilla's -.cgi files. Using the IIS Administration tool again, open up -the properties for the new virtual directory and select the -Configuration option to access the Script Mappings. Create an -entry mapping .cgi to: - -:: - - <full path to perl.exe >\perl.exe -x<full path to Bugzilla> -wT "%s" %s - -For example: - -:: - - c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s - -.. note:: The ActiveState install 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. - -IIS will also need to know that the index.cgi should be treated -as a default document. On the Documents tab page of the virtual -directory properties, you need to add index.cgi as a default -document type. If you wish, you may remove the other default -document types for this particular virtual directory, since Bugzilla -doesn't use any of them. - -Also, and this can't be stressed enough, make sure that files -such as :file:`localconfig` and your -:file:`data` directory are -secured as described in :ref:`security-webserver-access`. - -.. _install-config-bugzilla: - -Bugzilla -======== - -Your Bugzilla should now be working. Access -:file:`http://<your-bugzilla-server>/` - -you should see the Bugzilla -front page. If not, consult the Troubleshooting section, -:ref:`troubleshooting`. - -.. note:: The URL above may be incorrect if you installed Bugzilla into a - subdirectory or used a symbolic link from your web site root to - the Bugzilla directory. - -Log in with the administrator account you defined in the last -:file:`checksetup.pl` run. You should go through -the Parameters page and see if there are any you wish to change. -They key parameters are documented in :ref:`parameters`; -you should certainly alter -:command:`maintainer` and :command:`urlbase`; -you may also want to alter -:command:`cookiepath` or :command:`requirelogin`. - -Bugzilla has several optional features which require extra -configuration. You can read about those in -:ref:`extraconfig`. - -.. _extraconfig: - -Optional Additional Configuration -################################# - -Bugzilla has a number of optional features. This section describes how -to configure or enable them. - -Bug Graphs -========== - -If you have installed the necessary Perl modules you -can start collecting statistics for the nifty Bugzilla -graphs. - -:: - - # crontab -e - -This should bring up the crontab file in your editor. -Add a cron entry like this to run -:file:`collectstats.pl` -daily at 5 after midnight: - -.. code-block:: none - - 5 0 * * * cd <your-bugzilla-directory> && ./collectstats.pl - -After two days have passed you'll be able to view bug graphs from -the Reports page. - -.. note:: Windows does not have 'cron', but it does have the Task - Scheduler, which performs the same duties. There are also - third-party tools that can be used to implement cron, such as - `nncron <http://www.nncron.ru/>`_. - -.. _installation-whining-cron: - -The Whining Cron -================ - -What good are -bugs if they're not annoying? To help make them more so you -can set up Bugzilla's automatic whining system to complain at engineers -which leave their bugs in the CONFIRMED state without triaging them. - -This can be done by adding the following command as a daily -crontab entry, in the same manner as explained above for bug -graphs. This example runs it at 12.55am. - -.. code-block:: none - - 55 0 * * * cd <your-bugzilla-directory> && ./whineatnews.pl - -.. note:: Windows does not have 'cron', but it does have the Task - Scheduler, which performs the same duties. There are also - third-party tools that can be used to implement cron, such as - `nncron <http://www.nncron.ru/>`_. - -.. _installation-whining: - -Whining -======= - -As of Bugzilla 2.20, users can configure Bugzilla to regularly 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 process of configuring Whining is described -in :ref:`whining`, but for it to work a Perl script must be -executed at regular intervals. - -This can be done by adding the following command as a daily -crontab entry, in the same manner as explained above for bug -graphs. This example runs it every 15 minutes. - -.. code-block:: none - - */15 * * * * cd <your-bugzilla-directory> && ./whine.pl - -.. note:: Whines can be executed as often as every 15 minutes, so if you specify - longer intervals between executions of whine.pl, some users may not - be whined at as often as they would expect. Depending on the person, - this can either be a very Good Thing or a very Bad Thing. - -.. note:: Windows does not have 'cron', but it does have the Task - Scheduler, which performs the same duties. There are also - third-party tools that can be used to implement cron, such as - `nncron <http://www.nncron.ru/>`_. - -.. _apache-addtype: - -Serving Alternate Formats with the right MIME type -================================================== - -Some Bugzilla pages have alternate formats, other than just plain -HTML. In particular, a few Bugzilla pages can -output their contents as either XUL (a special -Mozilla format, that looks like a program GUI) -or RDF (a type of structured XML -that can be read by various programs). - -In order for your users to see these pages correctly, Apache must -send them with the right MIME type. To do this, -add the following lines to your Apache configuration, either in the -``<VirtualHost>`` section for your -Bugzilla, or in the ``<Directory>`` -section for your Bugzilla: - -.. code-block:: apache - - AddType application/vnd.mozilla.xul+xml .xul - AddType application/rdf+xml .rdf - -.. _multiple-bz-dbs: - -Multiple Bugzilla databases with a single installation -###################################################### - -The previous instructions referred to a standard installation, with -one unique Bugzilla database. However, you may want to host several -distinct installations, without having several copies of the code. 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 212.85.153.228:80> - ServerName foo.bar.baz - SetEnv PROJECT foo - Alias /bugzilla /var/www/bugzilla - </VirtualHost> - -Don't forget to also export this variable before accessing Bugzilla -by other means, such as cron tasks for instance. - -.. _os-specific: - -OS-Specific Installation Notes -############################## - -Many aspects of the Bugzilla installation can be affected by the -operating system you choose to install it on. Sometimes it can be made -easier and others more difficult. This section will attempt to help you -understand both the difficulties of running on specific operating systems -and the utilities available to make it easier. - -If you have anything to add or notes for an operating system not covered, -please file a bug in `Bugzilla Documentation <http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla;component=Documentation>`_. - -.. _os-win32: - -Microsoft Windows -================= - -Making Bugzilla work on Windows is more difficult than making it -work on Unix. For that reason, we still recommend doing so on a Unix -based system such as GNU/Linux. That said, if you do want to get -Bugzilla running on Windows, you will need to make the following -adjustments. A detailed step-by-step -`installation guide for Windows <https://wiki.mozilla.org/Bugzilla:Win32Install>`_ is also available -if you need more help with your installation. - -.. _win32-perl: - -Win32 Perl ----------- - -Perl for Windows can be obtained from -`ActiveState <http://www.activestate.com/>`_. -You should be able to find a compiled binary at `<http://aspn.activestate.com/ASPN/Downloads/ActivePerl/>`_. -The following instructions assume that you are using version -|min-perl-ver| of ActiveState. - -.. note:: These instructions are for 32-bit versions of Windows. If you are - using a 64-bit version of Windows, you will need to install 32-bit - Perl in order to install the 32-bit modules as described below. - -.. _win32-perl-modules: - -Perl Modules on Win32 ---------------------- - -Bugzilla on Windows requires the same perl modules found in -:ref:`install-perlmodules`. The main difference is that -windows uses PPM instead -of CPAN. ActiveState provides a GUI to manage Perl modules. We highly -recommend that you use it. If you prefer to use ppm from the -command-line, type: - -:: - - C:\perl> ppm install <module name> - -If you are using Perl |min-perl-ver|, the best source for the Windows PPM modules -needed for Bugzilla is probably the theory58S website, which you can add -to your list of repositories as follows: - -:: - - ppm repo add theory58S http://cpan.uwinnipeg.ca/PPMPackages/10xx/ - -If you are using Perl 5.12 or newer, you no longer need to add -this repository. All modules you need are already available from -the ActiveState repository. - -.. note:: The PPM repository stores modules in 'packages' that may have - a slightly different name than the module. If retrieving these - modules from there, you will need to pay attention to the information - provided when you run :command:`checksetup.pl` as it will - tell you what package you'll need to install. - -.. note:: If you are behind a corporate firewall, you will need to let the - ActiveState PPM utility know how to get through it to access - the repositories by setting the HTTP_proxy system environmental - variable. For more information on setting that variable, see - the ActiveState documentation. - -.. _win32-http: - -Serving the web pages ---------------------- - -As is the case on Unix based systems, any web server should -be able to handle Bugzilla; however, the Bugzilla Team still -recommends Apache whenever asked. No matter what web server -you choose, be sure to pay attention to the security notes -in :ref:`security-webserver-access`. More -information on configuring specific web servers can be found -in :ref:`http`. - -.. note:: The web server looks at :file:`/usr/bin/perl` to - call Perl. If you are using Apache on windows, you can set the - `ScriptInterpreterSource <http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource>`_ - directive in your Apache config file to make it look at the - right place: insert the line - - :: - ScriptInterpreterSource Registry-Strict - - into your :file:`httpd.conf` file, and create the key - - :: - HKEY_CLASSES_ROOT\\.cgi\\Shell\\ExecCGI\\Command - - with ``C:\\Perl\\bin\\perl.exe -T`` as value (adapt to your - path if needed) in the registry. When this is done, restart Apache. - -.. _win32-email: - -Sending Email -------------- - -To enable Bugzilla to send email on Windows, the server running the -Bugzilla code must be able to connect to, or act as, an SMTP server. - -.. _os-macosx: - -*Mac OS X* -========== - -Making Bugzilla work on Mac OS X requires the following -adjustments. - -.. _macosx-sendmail: - -Sendmail --------- - -In 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 fool Bugzilla, as long as Bugzilla can -find it. Bugzilla is able to find the fake sendmail executable without -any assistance. - -.. _macosx-libraries: - -Libraries & Perl Modules on Mac OS X ------------------------------------- - -Apple does not include the GD library with Mac OS X. Bugzilla -needs this for bug graphs. - -You can use MacPorts (`<http://www.macports.org/>`_) -or Fink (`<http://sourceforge.net/projects/fink/>`_), both -of which are similar in nature to the CPAN installer, but install -common unix programs. - -Follow the instructions for setting up MacPorts or Fink. -Once you have one installed, you'll want to use it to install the -:file:`gd2` package. - -Fink will prompt you for a number of dependencies, type 'y' and hit -enter to install all of the dependencies and then watch it work. You will -then be able to use CPAN to -install the GD Perl module. - -.. 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 asks where your :file:`libgd` - is, be sure to tell it :file:`/sw/lib`. - -Also available via MacPorts and Fink is -:file:`expat`. After installing the expat package, you -will be able to install XML::Parser using CPAN. If you use fink, there -is one caveat. Unlike recent versions of -the GD module, XML::Parser doesn't prompt for the location of the -required libraries. When using CPAN, you will need to use the following -command sequence: - -:: - - # perl -MCPAN -e'look XML::Parser' - # perl Makefile.PL EXPATLIBPATH=/sw/lib EXPATINCPATH=/sw/include - # make; make test; make install - # exit - -The :command:`look` command will download the module and spawn -a new shell with the extracted files as the current working directory. - -You should watch the output from these :command:`make` commands, -especially ``make test`` as errors may prevent -XML::Parser from functioning correctly with Bugzilla. - -The :command:`exit` command will return you to your original shell. - -.. _os-linux: - -Linux Distributions -=================== - -Many Linux distributions include Bugzilla and its -dependencies in their native package management systems. -Installing Bugzilla with root access on any Linux system -should be as simple as finding the Bugzilla package in the -package management application and installing it using the -normal command syntax. Several distributions also perform -the proper web server configuration automatically on installation. - -Please consult the documentation of your Linux -distribution for instructions on how to install packages, -or for specific instructions on installing Bugzilla with -native package management tools. There is also a -`Bugzilla Wiki Page <http://wiki.mozilla.org/Bugzilla:Linux_Distro_Installation>`_ for distro-specific installation -notes. - -.. _nonroot: - -UNIX (non-root) Installation Notes -################################## - -Introduction -============ - -If you are running a \*NIX OS as non-root, either due -to lack of access (web hosts, for example) or for security -reasons, this will detail how to install Bugzilla on such -a setup. It is recommended that you read through the -:ref:`installation` -first to get an idea on the installation steps required. -(These notes will reference to steps in that guide.) - -MySQL -===== - -You may have MySQL installed as root. If you're -setting up an account with a web host, a MySQL account -needs to be set up for you. From there, you can create -the bugs account, or use the account given to you. - -.. warning:: You may have problems trying to set up :command:`GRANT` - permissions to the database. - If you're using a web host, chances are that you have a - separate database which is already locked down (or one big - database with limited/no access to the other areas), but you - may want to ask your system administrator what the security - settings are set to, and/or run the :command:`GRANT` - command for you. - Also, you will probably not be able to change the MySQL - root user password (for obvious reasons), so skip that - step. - -Running MySQL as Non-Root -------------------------- - -The Custom Configuration Method -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Create a file .my.cnf in your -home directory (using /home/foo in this example) -as follows.... - -:: - - [mysqld] - datadir=/home/foo/mymysql - socket=/home/foo/mymysql/thesock - port=8081 - [mysql] - socket=/home/foo/mymysql/thesock - port=8081 - [mysql.server] - user=mysql - basedir=/var/lib - [safe_mysqld] - err-log=/home/foo/mymysql/the.log - pid-file=/home/foo/mymysql/the.pid - -The Custom Built Method -~~~~~~~~~~~~~~~~~~~~~~~ - -You can install MySQL as a not-root, if you really need to. -Build it with PREFIX set to :file:`/home/foo/mysql`, -or use pre-installed executables, specifying that you want -to put all of the data files in :file:`/home/foo/mysql/data`. -If there is another MySQL server running on the system that you -do not own, use the -P option to specify a TCP port that is not -in use. - -Starting the Server -~~~~~~~~~~~~~~~~~~~ - -After your mysqld program is built and any .my.cnf file is -in place, you must initialize the databases (ONCE). - -:: - - $ mysql_install_db - -Then start the daemon with - -:: - - $ safe_mysql & - -After you start mysqld the first time, you then connect to -it as "root" and :command:`GRANT` permissions to other -users. (Again, the MySQL root account has nothing to do with -the \*NIX root account.) - -.. note:: You will need to start the daemons yourself. You can either - ask your system administrator to add them to system startup files, or - add a crontab entry that runs a script to check on these daemons - and restart them if needed. - -.. warning:: Do NOT run daemons or other services on a server without first - consulting your system administrator! Daemons use up system resources - and running one may be in violation of your terms of service for any - machine on which you are a user! - -Perl -==== - -On the extremely rare chance that you don't have Perl on -the machine, you will have to build the sources -yourself. The following commands should get your system -installed with your own personal version of Perl: - -:: - - $ wget http://perl.org/CPAN/src/stable.tar.gz - $ tar zvxf stable.tar.gz - $ cd perl-|min-perl-ver| - $ sh Configure -de -Dprefix=/home/foo/perl - $ make && make test && make install - -Once you have Perl installed into a directory (probably -in :file:`~/perl/bin`), you will need to -install the Perl Modules, described below. - -.. _install-perlmodules-nonroot: - -Perl Modules -============ - -Installing the Perl modules as a non-root user is accomplished by -running the :file:`install-module.pl` -script. For more details on this script, see the -`install-module.pl documentation <../html/api/install-module.html>`_. - -HTTP Server -=========== - -Ideally, this also needs to be installed as root and -run under a special web server account. As long as -the web server will allow the running of \*.cgi files outside of a -cgi-bin, and a way of denying web access to certain files (such as a -.htaccess file), you should be good in this department. - -Running Apache as Non-Root --------------------------- - -You can run Apache as a non-root user, but the port will need -to be set to one above 1024. If you type :command:`httpd -V`, -you will get a list of the variables that your system copy of httpd -uses. One of those, namely HTTPD_ROOT, tells you where that -installation looks for its config information. - -From there, you can copy the config files to your own home -directory to start editing. When you edit those and then use the -d -option to override the HTTPD_ROOT compiled into the web server, you -get control of your own customized web server. - -.. note:: You will need to start the daemons yourself. You can either - ask your system administrator to add them to system startup files, or - add a crontab entry that runs a script to check on these daemons - and restart them if needed. - -.. warning:: Do NOT run daemons or other services on a server without first - consulting your system administrator! Daemons use up system resources - and running one may be in violation of your terms of service for any - machine on which you are a user! - -Bugzilla -======== - -When you run :command:`./checksetup.pl` to create -the :file:`localconfig` file, it will list the Perl -modules it finds. If one is missing, go back and double-check the -module installation from :ref:`install-perlmodules-nonroot`, -then delete the :file:`localconfig` file and try again. - -.. warning:: One option in :file:`localconfig` you - might have problems with is the web server group. If you can't - successfully browse to the :file:`index.cgi` (like - a Forbidden error), you may have to relax your permissions, - and blank out the web server group. Of course, this may pose - as a security risk. Having a properly jailed shell and/or - limited access to shell accounts may lessen the security risk, - but use at your own risk. - -.. _suexec: - -suexec or shared hosting ------------------------- - -If you are running on a system that uses suexec (most shared -hosting environments do this), you will need to set the -*webservergroup* value in :file:`localconfig` -to match *your* primary group, rather than the one -the web server runs under. You will need to run the following -shell commands after running :command:`./checksetup.pl`, -every time you run it (or modify :file:`checksetup.pl` -to do them for you via the system() command). - -:: - - for i in docs graphs images js skins; do find $i -type d -exec chmod o+rx {} \\; ; done - for i in jpg gif css js png html rdf xul; do find . -name \\*.$i -exec chmod o+r {} \\; ; done - find . -name .htaccess -exec chmod o+r {} \\; - chmod o+x . data data/webdot - -Pay particular attention to the number of semicolons and dots. -They are all important. A future version of Bugzilla will -hopefully be able to do this for you out of the box. - -.. _upgrade: - -Upgrading to New Releases -######################### - -Upgrading to new Bugzilla releases is very simple. There is -a script named :file:`checksetup.pl` included with -Bugzilla that will automatically do all of the database migration -for you. - -The following sections explain how to upgrade from one -version of Bugzilla to another. Whether you are upgrading -from one bug-fix version to another (such as 4.2 to 4.2.1) -or from one major version to another (such as from 4.0 to 4.2), -the instructions are always the same. - -.. note:: Any examples in the following sections are written as though the - user were updating to version 4.2.1, but the procedures are the - same no matter what version you're updating to. Also, in the - examples, the user's Bugzilla installation is found - at :file:`/var/www/html/bugzilla`. If that is not the - same as the location of your Bugzilla installation, simply - substitute the proper paths where appropriate. - -.. _upgrade-before: - -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, - particularly the "Notes for Upgraders" section. - -#. View the Sanity Check (:ref:`sanitycheck`) page - on your installation before upgrading. Attempt to fix all warnings - that the page produces before you go any further, or you may - experience problems during your upgrade. - -#. Shut down your Bugzilla installation by putting some HTML or - text in the shutdownhtml parameter - (see :ref:`parameters`). - -#. Make a backup of the Bugzilla database. - *THIS IS VERY IMPORTANT*. If - anything goes wrong during the upgrade, your installation - can be corrupted beyond recovery. Having a backup keeps you safe. - - .. 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 database - from this backup. - - 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. - - MySQL: - mysqldump --opt -u bugs -p bugs > bugs.sql - PostgreSQL: - pg_dump --no-privileges --no-owner -h localhost -U bugs - > bugs.sql - -.. _upgrade-files: - -Getting The New Bugzilla -======================== - -There are three ways to get the new version of Bugzilla. -We'll list them here briefly and then explain them -more later. - -Bzr (:ref:`upgrade-bzr`) - If you have :command:`bzr` installed on your machine - and you have Internet access, this is the easiest way to - upgrade, particularly if you have made modifications - to the code or templates of Bugzilla. - -Download the tarball (:ref:`upgrade-tarball`) - This is a very simple way to upgrade, and good if you - haven't made many (or any) modifications to the code or - templates of your Bugzilla. - -Patches (:ref:`upgrade-patches`) - If you have made modifications to your Bugzilla, and - you don't have Internet access or you don't want to use - bzr, then this is the best way to upgrade. - You can only do minor upgrades (such as 4.2 to 4.2.1 or - 4.2.1 to 4.2.2) with patches. - -.. _upgrade-modified: - -If you have modified your Bugzilla ----------------------------------- - -If you have modified the code or templates of your Bugzilla, -then upgrading requires a bit more thought and effort. -A discussion of the various methods of updating compared with -degree and methods of local customization can be found in -:ref:`template-method`. - -The larger the jump you are trying to make, the more difficult it -is going to be to upgrade if you have made local 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. - -.. _upgrade-bzr: - -Upgrading using Bzr -------------------- - -This requires that you have bzr installed (most Unix machines do), -and requires that you are able to access -`bzr.mozilla.org <http://bzr.mozilla.org/bugzilla/>`_, -which may not be an option if you don't have Internet access. - -The following shows the sequence of commands needed to update a -Bugzilla installation via Bzr, and a typical series of results. -These commands assume that you already have Bugzilla installed -using Bzr. - -.. warning:: If your installation is still using CVS, you must first convert - it to Bzr. A very detailed step by step documentation can be - found on `wiki.mozilla.org <https://wiki.mozilla.org/Bugzilla:Moving_From_CVS_To_Bazaar>`_. - -:: - - $ cd /var/www/html/bugzilla - $ bzr switch 4.2 - (only run the previous command when not yet running 4.2) - $ bzr up -r tag:bugzilla-4.2.1 - +N extensions/MoreBugUrl/ - +N extensions/MoreBugUrl/Config.pm - +N extensions/MoreBugUrl/Extension.pm - ... - M Bugzilla/Attachment.pm - M Bugzilla/Attachment/PatchReader.pm - M Bugzilla/Bug.pm - ... - All changes applied successfully. - -.. warning:: If a line in the output from :command:`bzr up` mentions - a conflict, then that represents a file with local changes that - Bzr was unable to properly merge. You need to resolve these - conflicts manually before Bugzilla (or at least the portion using - that file) will be usable. - -.. _upgrade-tarball: - -Upgrading using the tarball ---------------------------- - -If you are unable (or unwilling) to use Bzr, another option that's -always available is to obtain the latest tarball from the `Download Page <http://www.bugzilla.org/download/>`_ and -create a new Bugzilla installation from that. - -This sequence of commands shows how to get the tarball from the -command-line; it is also possible to download it from the site -directly in a web browser. If you go that route, save the file -to the :file:`/var/www/html` -directory (or its equivalent, if you use something else) and -omit the first three lines of the example. - -:: - - $ cd /var/www/html - $ wget http://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-4.2.1.tar.gz - ... - $ tar xzvf bugzilla-4.2.1.tar.gz - bugzilla-4.2.1/ - bugzilla-4.2.1/colchange.cgi - ... - $ cd bugzilla-4.2.1 - $ cp ../bugzilla/localconfig* . - $ cp -r ../bugzilla/data . - $ cd .. - $ mv bugzilla bugzilla.old - $ mv bugzilla-4.2.1 bugzilla - -.. warning:: The :command:`cp` commands both end with periods which - is a very important detail--it means that the destination - directory is the current working directory. - -.. warning:: If you have some extensions installed, you will have to copy them - to the new bugzilla directory too. Extensions are located in :file:`bugzilla/extensions/`. - Only copy those you - installed, not those managed by the Bugzilla team. - -This upgrade method will give you a clean install of Bugzilla. -That's fine if you don't have any local customizations that you -want to maintain. If you do have customizations, then you will -need to reapply them by hand to the appropriate files. - -.. _upgrade-patches: - -Upgrading using patches ------------------------ - -A patch is a collection of all the bug fixes that have been made -since the last bug-fix release. - -If you are doing a bug-fix upgrade—that is, one where only the -last number of the revision changes, such as from 4.2 to -4.2.1—then you have the option of obtaining and applying a -patch file from the `Download Page <http://www.bugzilla.org/download/>`_. - -As above, this example starts with obtaining the file via the -command line. If you have already downloaded it, you can omit the -first two commands. - -:: - - $ cd /var/www/html/bugzilla - $ wget http://ftp.mozilla.org/pub/mozilla.org/webtools/bugzilla-4.2-to-4.2.1.diff.gz - ... - $ gunzip bugzilla-4.2-to-4.2.1.diff.gz - $ patch -p1 < bugzilla-4.2-to-4.2.1.diff - patching file Bugzilla/Constants.pm - patching file enter_bug.cgi - ... - -.. warning:: Be aware that upgrading from a patch file does not change the - entries in your :file:`.bzr` directory. - This could make it more difficult to upgrade using Bzr - (:ref:`upgrade-bzr`) in the future. - -.. _upgrade-completion: - -Completing Your Upgrade -======================= - -Now that you have the new Bugzilla code, there are a few final -steps to complete your upgrade. - -#. If your new Bugzilla installation is in a different - directory or on a different machine than your old Bugzilla - installation, make sure that you have copied the - :file:`data` directory and the - :file:`localconfig` file from your old Bugzilla - installation. (If you followed the tarball instructions - above, this has already happened.) - -#. If this is a major update, check that the configuration - (:ref:`configuration`) for your new Bugzilla is - up-to-date. Sometimes the configuration requirements change - between major versions. - -#. If you didn't do it as part of the above configuration step, - now you need to run :command:`checksetup.pl`, which - will do everything required to convert your existing database - and settings for the new version: - - :: - - $ :command:`cd /var/www/html/bugzilla` - $ :command:`./checksetup.pl` - - .. warning:: The period at the beginning of the - command :command:`./checksetup.pl` is important and cannot - be omitted. - - .. warning:: If this is a major upgrade (say, 3.6 to 4.2 or similar), - running :command:`checksetup.pl` on a large - installation (75,000 or more bugs) can take a long time, - possibly several hours. - -#. Clear any HTML or text that you put into the shutdownhtml - parameter, to re-activate Bugzilla. - -#. View the Sanity Check (:ref:`sanitycheck`) page in your - upgraded Bugzilla. - It is recommended that, if possible, you fix any problems - you see, immediately. Failure to do this may mean that Bugzilla - will not work correctly. Be aware that if the sanity check page - contains more errors after an upgrade, it doesn't necessarily - mean there are more errors in your database than there were - before, as additional tests are added to the sanity check over - time, and it is possible that those errors weren't being - checked for in the old version. - -.. _upgrade-notifications: - -Automatic Notifications of New Releases -======================================= - -Bugzilla 3.0 introduced the ability to automatically notify -administrators when new releases are available, based on the -``upgrade_notification`` parameter, see -:ref:`parameters`. Administrators will see these -notifications when they access the :file:`index.cgi` -page, i.e. generally when logging in. Bugzilla will check once per -day for new releases, unless the parameter is set to -``disabled``. If you are behind a proxy, you may have to set -the ``proxy_url`` parameter accordingly. If the proxy -requires authentication, use the -``http://user:pass@proxy_url/`` syntax. - - diff --git a/docs/en/rst/installing/apache-windows.rst b/docs/en/rst/installing/apache-windows.rst new file mode 100644 index 000000000..5e8ac8928 --- /dev/null +++ b/docs/en/rst/installing/apache-windows.rst @@ -0,0 +1,128 @@ +.. _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` diff --git a/docs/en/rst/installing/apache.rst b/docs/en/rst/installing/apache.rst new file mode 100644 index 000000000..fe734b222 --- /dev/null +++ b/docs/en/rst/installing/apache.rst @@ -0,0 +1,137 @@ +.. 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. diff --git a/docs/en/rst/installing/backups.rst b/docs/en/rst/installing/backups.rst new file mode 100644 index 000000000..f20b3021a --- /dev/null +++ b/docs/en/rst/installing/backups.rst @@ -0,0 +1,38 @@ +.. _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` + diff --git a/docs/en/rst/installing/essential-post-install-config.rst b/docs/en/rst/installing/essential-post-install-config.rst new file mode 100644 index 000000000..c5e9c0bc1 --- /dev/null +++ b/docs/en/rst/installing/essential-post-install-config.rst @@ -0,0 +1,172 @@ +.. _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`. diff --git a/docs/en/rst/installing/iis.rst b/docs/en/rst/installing/iis.rst new file mode 100644 index 000000000..d65aef9de --- /dev/null +++ b/docs/en/rst/installing/iis.rst @@ -0,0 +1,115 @@ +.. _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`. diff --git a/docs/en/rst/installing/index.rst b/docs/en/rst/installing/index.rst new file mode 100644 index 000000000..91a81bede --- /dev/null +++ b/docs/en/rst/installing/index.rst @@ -0,0 +1,36 @@ +.. 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 diff --git a/docs/en/rst/installing/installing-end.inc.rst b/docs/en/rst/installing/installing-end.inc.rst new file mode 100644 index 000000000..6e34395ac --- /dev/null +++ b/docs/en/rst/installing/installing-end.inc.rst @@ -0,0 +1,66 @@ +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. diff --git a/docs/en/rst/installing/linux.rst b/docs/en/rst/installing/linux.rst new file mode 100644 index 000000000..97192fac3 --- /dev/null +++ b/docs/en/rst/installing/linux.rst @@ -0,0 +1,215 @@ +.. _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`. diff --git a/docs/en/rst/installing/mac-os-x.rst b/docs/en/rst/installing/mac-os-x.rst new file mode 100644 index 000000000..545d2fa27 --- /dev/null +++ b/docs/en/rst/installing/mac-os-x.rst @@ -0,0 +1,130 @@ +.. _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`. diff --git a/docs/en/rst/installing/merging-accounts.rst b/docs/en/rst/installing/merging-accounts.rst new file mode 100644 index 000000000..4dbdb807f --- /dev/null +++ b/docs/en/rst/installing/merging-accounts.rst @@ -0,0 +1,14 @@ +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. diff --git a/docs/en/rst/installing/migrating-from-1.inc.rst b/docs/en/rst/installing/migrating-from-1.inc.rst new file mode 100644 index 000000000..d834a8605 --- /dev/null +++ b/docs/en/rst/installing/migrating-from-1.inc.rst @@ -0,0 +1,7 @@ +.. 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. diff --git a/docs/en/rst/installing/migrating-from-2.inc.rst b/docs/en/rst/installing/migrating-from-2.inc.rst new file mode 100644 index 000000000..873a9c87d --- /dev/null +++ b/docs/en/rst/installing/migrating-from-2.inc.rst @@ -0,0 +1,149 @@ +.. 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. diff --git a/docs/en/rst/installing/migrating-from-a-tarball.rst b/docs/en/rst/installing/migrating-from-a-tarball.rst new file mode 100644 index 000000000..852cb8dbe --- /dev/null +++ b/docs/en/rst/installing/migrating-from-a-tarball.rst @@ -0,0 +1,15 @@ +.. _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 diff --git a/docs/en/rst/installing/migrating-from-bzr.rst b/docs/en/rst/installing/migrating-from-bzr.rst new file mode 100644 index 000000000..da6809a01 --- /dev/null +++ b/docs/en/rst/installing/migrating-from-bzr.rst @@ -0,0 +1,11 @@ +.. _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 diff --git a/docs/en/rst/installing/migrating-from-cvs.rst b/docs/en/rst/installing/migrating-from-cvs.rst new file mode 100644 index 000000000..76f6253f2 --- /dev/null +++ b/docs/en/rst/installing/migrating-from-cvs.rst @@ -0,0 +1,13 @@ +.. _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 + + diff --git a/docs/en/rst/installing/migrating.rst b/docs/en/rst/installing/migrating.rst new file mode 100644 index 000000000..5b842dd3d --- /dev/null +++ b/docs/en/rst/installing/migrating.rst @@ -0,0 +1,23 @@ +.. _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. + + diff --git a/docs/en/rst/installing/moving.rst b/docs/en/rst/installing/moving.rst new file mode 100644 index 000000000..966acda07 --- /dev/null +++ b/docs/en/rst/installing/moving.rst @@ -0,0 +1,66 @@ +.. _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. diff --git a/docs/en/rst/installing/multiple-bugzillas.rst b/docs/en/rst/installing/multiple-bugzillas.rst new file mode 100644 index 000000000..1e2d7951f --- /dev/null +++ b/docs/en/rst/installing/multiple-bugzillas.rst @@ -0,0 +1,41 @@ +.. _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. diff --git a/docs/en/rst/installing/mysql.rst b/docs/en/rst/installing/mysql.rst new file mode 100644 index 000000000..1107547a6 --- /dev/null +++ b/docs/en/rst/installing/mysql.rst @@ -0,0 +1,143 @@ +.. _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. diff --git a/docs/en/rst/installing/optional-post-install-config.rst b/docs/en/rst/installing/optional-post-install-config.rst new file mode 100644 index 000000000..f79918d2a --- /dev/null +++ b/docs/en/rst/installing/optional-post-install-config.rst @@ -0,0 +1,133 @@ +.. _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`. diff --git a/docs/en/rst/installing/oracle.rst b/docs/en/rst/installing/oracle.rst new file mode 100644 index 000000000..860b61fe6 --- /dev/null +++ b/docs/en/rst/installing/oracle.rst @@ -0,0 +1,69 @@ +.. _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. diff --git a/docs/en/rst/installing/postgresql.rst b/docs/en/rst/installing/postgresql.rst new file mode 100644 index 000000000..1d0ec1d49 --- /dev/null +++ b/docs/en/rst/installing/postgresql.rst @@ -0,0 +1,58 @@ +.. _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`.) diff --git a/docs/en/rst/installing/quick-start.rst b/docs/en/rst/installing/quick-start.rst new file mode 100644 index 000000000..220421bce --- /dev/null +++ b/docs/en/rst/installing/quick-start.rst @@ -0,0 +1,223 @@ +.. _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. :-) diff --git a/docs/en/rst/installing/sanity-check.rst b/docs/en/rst/installing/sanity-check.rst new file mode 100644 index 000000000..4f8fb11c6 --- /dev/null +++ b/docs/en/rst/installing/sanity-check.rst @@ -0,0 +1,26 @@ +.. _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. + diff --git a/docs/en/rst/installing/sqlite.rst b/docs/en/rst/installing/sqlite.rst new file mode 100644 index 000000000..bf5953666 --- /dev/null +++ b/docs/en/rst/installing/sqlite.rst @@ -0,0 +1,14 @@ +.. _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`. diff --git a/docs/en/rst/installing/upgrading-customizations.rst b/docs/en/rst/installing/upgrading-customizations.rst new file mode 100644 index 000000000..c99c6a9f7 --- /dev/null +++ b/docs/en/rst/installing/upgrading-customizations.rst @@ -0,0 +1,20 @@ +.. _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. diff --git a/docs/en/rst/installing/upgrading-with-1.inc.rst b/docs/en/rst/installing/upgrading-with-1.inc.rst new file mode 100644 index 000000000..4861f6ea9 --- /dev/null +++ b/docs/en/rst/installing/upgrading-with-1.inc.rst @@ -0,0 +1,41 @@ +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. diff --git a/docs/en/rst/installing/upgrading-with-2.inc.rst b/docs/en/rst/installing/upgrading-with-2.inc.rst new file mode 100644 index 000000000..d8e2dbfaa --- /dev/null +++ b/docs/en/rst/installing/upgrading-with-2.inc.rst @@ -0,0 +1,32 @@ +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. diff --git a/docs/en/rst/installing/upgrading-with-a-tarball.rst b/docs/en/rst/installing/upgrading-with-a-tarball.rst new file mode 100644 index 000000000..2bbfb3158 --- /dev/null +++ b/docs/en/rst/installing/upgrading-with-a-tarball.rst @@ -0,0 +1,74 @@ +.. _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 diff --git a/docs/en/rst/installing/upgrading-with-git.rst b/docs/en/rst/installing/upgrading-with-git.rst new file mode 100644 index 000000000..78b4fb1e0 --- /dev/null +++ b/docs/en/rst/installing/upgrading-with-git.rst @@ -0,0 +1,69 @@ +.. _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 diff --git a/docs/en/rst/installing/upgrading.rst b/docs/en/rst/installing/upgrading.rst new file mode 100644 index 000000000..f43897fb3 --- /dev/null +++ b/docs/en/rst/installing/upgrading.rst @@ -0,0 +1,70 @@ +.. _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. diff --git a/docs/en/rst/installing/windows.rst b/docs/en/rst/installing/windows.rst new file mode 100644 index 000000000..e70483daf --- /dev/null +++ b/docs/en/rst/installing/windows.rst @@ -0,0 +1,175 @@ +.. _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`. diff --git a/docs/en/rst/integrating/apis.rst b/docs/en/rst/integrating/apis.rst new file mode 100644 index 000000000..6067c12df --- /dev/null +++ b/docs/en/rst/integrating/apis.rst @@ -0,0 +1,72 @@ +.. _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. diff --git a/docs/en/rst/integrating/extensions.rst b/docs/en/rst/integrating/extensions.rst new file mode 100644 index 000000000..2097909fc --- /dev/null +++ b/docs/en/rst/integrating/extensions.rst @@ -0,0 +1,199 @@ +.. _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. + diff --git a/docs/en/rst/integrating/faq.rst b/docs/en/rst/integrating/faq.rst new file mode 100644 index 000000000..19f8b59ff --- /dev/null +++ b/docs/en/rst/integrating/faq.rst @@ -0,0 +1,27 @@ + +.. _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`. diff --git a/docs/en/rst/integrating/index.rst b/docs/en/rst/integrating/index.rst new file mode 100644 index 000000000..816ffe8e5 --- /dev/null +++ b/docs/en/rst/integrating/index.rst @@ -0,0 +1,22 @@ +.. 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 diff --git a/docs/en/rst/integrating/languages.rst b/docs/en/rst/integrating/languages.rst new file mode 100644 index 000000000..01586d3fe --- /dev/null +++ b/docs/en/rst/integrating/languages.rst @@ -0,0 +1,19 @@ +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. diff --git a/docs/en/rst/integrating/skins.rst b/docs/en/rst/integrating/skins.rst new file mode 100644 index 000000000..2cd08b4c0 --- /dev/null +++ b/docs/en/rst/integrating/skins.rst @@ -0,0 +1,27 @@ +.. _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. diff --git a/docs/en/rst/integrating/templates.rst b/docs/en/rst/integrating/templates.rst new file mode 100644 index 000000000..f30b4a848 --- /dev/null +++ b/docs/en/rst/integrating/templates.rst @@ -0,0 +1,289 @@ +.. _templates: + +Templates +######### + +Bugzilla uses a system of templates to define its user interface. The standard +templates can be modified, replaced or overridden. You can also use template +hooks in an :ref:`extension <extensions>` to add or modify the +behaviour of templates using a stable interface. + +.. _template-directory: + +Template Directory Structure +============================ + +The template directory structure starts with top level directory +named :file:`template`, which contains a directory +for each installed localization. Bugzilla comes with English +templates, so the directory name is :file:`en`, +and we will discuss :file:`template/en` throughout +the documentation. Below :file:`template/en` is the +:file:`default` directory, which contains all the +standard templates shipped with Bugzilla. + +.. warning:: A directory :file:`data/template` also exists; + this is where Template Toolkit puts the compiled versions (i.e. Perl code) + of the templates. *Do not* directly edit the files in this + directory, or all your changes will be lost the next time + Template Toolkit recompiles the templates. + +.. _template-method: + +Choosing a Customization Method +=============================== + +If you want to edit Bugzilla's templates, the first decision +you must make is how you want to go about doing so. There are three +choices, and which you use depends mainly on the scope of your +modifications, and the method you plan to use to upgrade Bugzilla. + +#. You can directly edit the templates found in :file:`template/en/default`. + +#. You can copy the templates to be modified into a mirrored directory + structure under :file:`template/en/custom`. Templates in this + directory structure automatically override any identically-named + and identically-located templates in the + :file:`template/en/default` directory. (The :file:`custom` directory does + not exist by default and must be created if you want to use it.) + +#. You can use the hooks built into many of the templates to add or modify + the UI from an :ref:`extension <extensions>`. Hooks generally don't go away + and have a stable interface. + +The third method is the best if there are hooks in the appropriate places +and the change you want to do is possible using hooks. It's not very easy +to modify existing UI using hooks; they are most commonly used for additions. +You can make modifications if you add JS code which then makes the +modifications when the page is loaded. You can remove UI by adding CSS to hide +it. + +Unlike code hooks, there is no requirement to document template hooks, so +you just have to open up the template and see (search for ``Hook.process``). + +If there are no hooks available, then the second method of customization +should be used if you are going to make major changes, because it is +guaranteed that the contents of the :file:`custom` directory will not be +touched during an upgrade, and you can then decide whether +to revert to the standard templates, continue using yours, or make the effort +to merge your changes into the new versions by hand. It's also good for +entirely new files, and for a few files like +:file:`bug/create/user-message.html.tmpl` which are designed to be entirely +replaced. + +Using the second method, your user interface may break if incompatible +changes are made to the template interface. Templates do change regularly +and so interface changes are not individually documented, and you would +need to work out what had changed and adapt your template accordingly. + +For minor changes, the convenience of the first method is hard to beat. When +you upgrade Bugzilla, :command:`git` will merge your changes into the new +version for you. On the downside, if the merge fails then Bugzilla will not +work properly until you have fixed the problem and re-integrated your code. + +Also, you can see what you've changed using :command:`git diff`, which you +can't if you fork the file into the :file:`custom` directory. + +.. _template-edit: + +How To Edit Templates +===================== + +.. note:: If you are making template changes that you intend on submitting + back for inclusion in standard Bugzilla, you should read the relevant + sections of the + `Developers' Guide <http://www.bugzilla.org/docs/developer.html>`_. + +Bugzilla uses a templating system called Template Toolkit. The syntax of the +language is beyond the scope of this guide. It's reasonably easy to pick up by +looking at the current templates; or, you can read the manual, available on +the `Template Toolkit home page <http://www.template-toolkit.org>`_. + +One thing you should take particular care about is the need +to properly HTML filter data that has been passed into the template. +This means that if the data can possibly contain special HTML characters +such as ``<``, and the data was not intended to be HTML, they need to be +converted to entity form, i.e. ``<``. You use the ``html`` filter in the +Template Toolkit to do this (or the ``uri`` filter to encode special +characters in URLs). If you forget, you may open up your installation +to cross-site scripting attacks. + + +You should run :command:`./checksetup.pl` after editing any templates. Failure +to do so may mean either that your changes are not picked up, or that the +permissions on the edited files are wrong so the webserver can't read them. + +.. _template-formats: + +Template Formats and Types +========================== + +Some CGI's have the ability to use more than one template. For example, +:file:`buglist.cgi` can output itself as two formats of HTML (complex and +simple). Each of these is a separate template. The mechanism that provides +this feature is extensible - you can create new templates to add new formats. + +You might use this feature to e.g. add a custom bug entry form for a +particular subset of users or a particular type of bug. + +Bugzilla can also support different types of output - e.g. bugs are available +as HTML and as XML, and this mechanism is extensible also to add new content +types. However, instead of using such interfaces or enhancing Bugzilla to add +more, you would be better off using the :ref:`apis` to integrate with +Bugzilla. + +To see if a CGI supports multiple output formats and types, grep the +CGI for ``get_format``. If it's not present, adding +multiple format/type support isn't too hard - see how it's done in +other CGIs, e.g. :file:`config.cgi`. + +To make a new format template for a CGI which supports this, +open a current template for +that CGI and take note of the INTERFACE comment (if present.) This +comment defines what variables are passed into this template. If +there isn't one, I'm afraid you'll have to read the template and +the code to find out what information you get. + +Write your template in whatever markup or text style is appropriate. + +You now need to decide what content type you want your template +served as. The content types are defined in the +:file:`Bugzilla/Constants.pm` file in the :file:`contenttypes` +constant. If your content type is not there, add it. Remember +the three- or four-letter tag assigned to your content type. +This tag will be part of the template filename. + +Save your new template as +:file:`<stubname>-<formatname>.<contenttypetag>.tmpl`. +Try out the template by calling the CGI as +``<cginame>.cgi?format=<formatname>``. Add ``&ctype=<type>`` if the type is +not HTML. + +.. _template-specific: + +Particular Templates +==================== + +There are a few templates you may be particularly interested in +customizing for your installation. + +:file:`index.html.tmpl`: + This is the Bugzilla front page. + +:file:`global/header.html.tmpl`: + This defines the header that goes on all Bugzilla pages. + The header includes the banner, which is what appears to users + and is probably what you want to edit instead. However the + header also includes the HTML HEAD section, so you could for + example add a stylesheet or META tag by editing the header. + +:file:`global/banner.html.tmpl`: + This contains the ``banner``, the part of the header that appears + at the top of all Bugzilla pages. The default banner is reasonably + barren, so you'll probably want to customize this to give your + installation a distinctive look and feel. It is recommended you + preserve the Bugzilla version number in some form so the version + you are running can be determined, and users know what docs to read. + +:file:`global/footer.html.tmpl`: + This defines the footer that goes on all Bugzilla pages. Editing + this is another way to quickly get a distinctive look and feel for + your Bugzilla installation. + +:file:`global/variables.none.tmpl`: + This allows you to change the word 'bug' to something else (e.g. "issue") + throughout the interface, and also to change the name Bugzilla to something + else (e.g. "FooCorp Bug Tracker"). + +:file:`list/table.html.tmpl`: + This template controls the appearance of the bug lists created + by Bugzilla. Editing this template allows per-column control of + the width and title of a column, the maximum display length of + each entry, and the wrap behaviour of long entries. + For long bug lists, Bugzilla inserts a 'break' every 100 bugs by + default; this behaviour is also controlled by this template, and + that value can be modified here. + +:file:`bug/create/user-message.html.tmpl`: + This is a message that appears near the top of the bug reporting page. + By modifying this, you can tell your users how they should report + bugs. + +:file:`bug/process/midair.html.tmpl`: + This is the page used if two people submit simultaneous changes to the + same bug. The second person to submit their changes will get this page + to tell them what the first person did, and ask if they wish to + overwrite those changes or go back and revisit the bug. The default + title and header on this page read "Mid-air collision detected!" If + you work in the aviation industry, or other environment where this + might be found offensive (yes, we have true stories of this happening) + you'll want to change this to something more appropriate for your + environment. + +.. _custom-bug-entry: + +:file:`bug/create/create.html.tmpl` and :file:`bug/create/comment.txt.tmpl`: + You may not wish to go to the effort of creating custom fields in + Bugzilla, yet you want to make sure that each bug report contains + a number of pieces of important information for which there is not + a special field. The bug entry system has been designed in an + extensible fashion to enable you to add arbitrary HTML widgets, + such as drop-down lists or textboxes, to the bug entry page + and have their values appear formatted in the initial comment. + + An example of this is the `guided bug submission form + <http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi?product=WorldControl;format=guided>`_. + The code for this comes with the Bugzilla distribution as an example for + you to copy. It can be found in the files + :file:`create-guided.html.tmpl` and :file:`comment-guided.html.tmpl`. + + A hidden field that indicates the format should be added inside + the form in order to make the template functional. Its value should + be the suffix of the template filename. For example, if the file + is called :file:`create-guided.html.tmpl`, then + + :: + + <input type="hidden" name="format" value="guided"> + + is used inside the form. + + So to use this feature, create a custom template for + :file:`enter_bug.cgi`. The default template, on which you + could base it, is + :file:`default/bug/create/create.html.tmpl`. + Call it :file:`custom/bug/create/create-<formatname>.html.tmpl`, and + in it, add form inputs for each piece of information you'd like + collected - such as a build number, or set of steps to reproduce. + + Then, create a template based on + :file:`default/bug/create/comment.txt.tmpl`, and call it + :file:`custom/bug/create/comment-<formatname>.txt.tmpl`. + It needs a couple of lines of boilerplate at the top like this:: + + [% USE Bugzilla %] + [% cgi = Bugzilla.cgi % + + Then, this template can reference the form fields you have created using + the syntax ``[% cgi.param("field_name") %]``. When a bug report is + submitted, the initial comment attached to the bug report will be + formatted according to the layout of this template. + + For example, if your custom enter_bug template had a field:: + + <input type="text" name="buildid" size="30"> + + and then your comment.txt.tmpl had:: + + [% USE Bugzilla %] + [% cgi = Bugzilla.cgi %] + Build Identifier: [%+ cgi.param("buildid") %] + + then something like:: + + Build Identifier: 20140303 + + would appear in the initial comment. + + This system allows you to gather structured data in bug reports without + the overhead and UI complexity of a large number of custom fields. diff --git a/docs/en/rst/modules.rst b/docs/en/rst/modules.rst deleted file mode 100644 index 474016180..000000000 --- a/docs/en/rst/modules.rst +++ /dev/null @@ -1,126 +0,0 @@ -.. 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>`_ diff --git a/docs/en/rst/patches.rst b/docs/en/rst/patches.rst deleted file mode 100644 index 688d17105..000000000 --- a/docs/en/rst/patches.rst +++ /dev/null @@ -1,88 +0,0 @@ - - -.. _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. - - diff --git a/docs/en/rst/security.rst b/docs/en/rst/security.rst deleted file mode 100644 index 17dfc73a2..000000000 --- a/docs/en/rst/security.rst +++ /dev/null @@ -1,167 +0,0 @@ - - -.. _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. - - diff --git a/docs/en/rst/style.rst b/docs/en/rst/style.rst index 8fd9dc037..aa3957b95 100644 --- a/docs/en/rst/style.rst +++ b/docs/en/rst/style.rst @@ -1,5 +1,7 @@ :orphan: +.. _style-guide: + ============================== Writing Bugzilla Documentation ============================== @@ -8,8 +10,10 @@ The Bugzilla documentation uses `reStructured Text (reST) <http://docutils.sourceforge.net/rst.html>`_, as extended by our documentation compilation tool, `Sphinx <http://sphinx-doc.org/>`_. This document is a reST document for -demonstration purposes. When you build the docs, it gets built (at least in -the HTML version) as a standalone file, although it isn't as readable in that +demonstration purposes. To learn from it, you need to read it in reST form. + +When you build the docs, this document gets built (at least in +the HTML version) as a standalone file, although it isn't as useful in that form because some of the directives discussed are invisible or change when rendered. @@ -19,14 +23,15 @@ that one immediately-linked page should be enough to get started. Later, the `inline markup section <http://sphinx-doc.org/latest/markup/inline.html>`_ is worth a read. -Bugzilla's particular documentation conventions are as follows. +Bugzilla's particular documentation conventions are as follows: Block Directives ################ -Every heading should be preceded by an anchor, with a globally-unique name -with no spaces. Then we demonstrate the available heading levels we haven't -used yet: +Chapter headings use the double-equals, page title headings the #, and then +the three other levels are headings within a page. Every heading should be +preceded by an anchor, with a globally-unique name with no spaces. Now, we +demonstrate the available heading levels we haven't used yet: .. _uniqueanchorname: @@ -59,6 +64,8 @@ Other block types: .. warning:: This is a warning of a potential serious problem you should be aware of. +.. todo:: This is some documentation-related task that still needs doing. + Use both of the above block types sparingly. Consider putting the information in the main text, omitting it, or (if long) placing it in a subsidiary file. @@ -72,30 +79,44 @@ this: .. code-block:: perl - # This is some Perl code - print "Hello"; + # This is some Perl code + print "Hello"; There is a `list of all available lexer names <http://pygments.org/docs/lexers/>`_ available. We currently use ``console``, ``perl``, and ``sql``. ``none`` is also a valid value. +Use 4-space indentation, except where a different value is better so that +things line up. So normally two spaces for bulleted lists, and 3 spaces +for .. blocks. + Inline Directives ################# .. warning:: Remember that reST does not support nested inline markup. So you can't have a substitution inside a link, or bold inside italics. -A filename or a path to a filename is displayed like this: -:file:`/path/to/filename.ext` +* A filename or a path to a filename: + :file:`/path/to/{variable-bit-of-path}/filename.ext` + +* A command to type in the shell: + :command:`command --arguments` + +* A parameter name: + :param:`shutdownhtml` + +* A parameter value: + :paramval:`DB` + +* A group name: + :group:`editbugs` -A command to type in the shell is displayed like this: -:command:`command --arguments` +* A bug field name: + :field:`Summary` -We place static values for substitution (using |subst-name|) in the file -:file:`$BUGZILLA_HOME/docs/definitions.rst.tmpl`. -This gets built into definitions.rst, with the script adding some definitions -for minimum module versions etc. generated from the source itself. Lines in -that file look like this: +* Any string from the UI: + :guilabel:`Administration` -.. |subst-name| replace:: Some Text Here +* A specific BMO bug: + :bug:`201069` diff --git a/docs/en/rst/troubleshooting.rst b/docs/en/rst/troubleshooting.rst deleted file mode 100644 index 64b9263a4..000000000 --- a/docs/en/rst/troubleshooting.rst +++ /dev/null @@ -1,239 +0,0 @@ -.. highlight:: console - -.. _troubleshooting: - -=============== -Troubleshooting -=============== - -This section gives solutions to common Bugzilla installation -problems. If none of the section headings seems to match your -problem, read the general advice. - -.. _general-advice: - -General Advice -############## - -If you can't get :file:`checksetup.pl` to run to -completion, it normally explains what's wrong and how to fix it. -If you can't work it out, or if it's being uncommunicative, post -the errors in the -`mozilla.support.bugzilla <news://news.mozilla.org/mozilla.support.bugzilla>`_ -newsgroup. - -If you have made it all the way through -:ref:`installation` (Installation) and -:ref:`configuration` (Configuration) but accessing the Bugzilla -URL doesn't work, the first thing to do is to check your web server error -log. For Apache, this is often located at -:file:`/etc/logs/httpd/error_log`. The error messages -you see may be self-explanatory enough to enable you to diagnose and -fix the problem. If not, see below for some commonly-encountered -errors. If that doesn't help, post the errors to the newsgroup. - -Bugzilla can also log all user-based errors (and many code-based errors) -that occur, without polluting the web server's error log. To enable -Bugzilla error logging, create a file that Bugzilla can write to, named -:file:`errorlog`, in the Bugzilla :file:`data` -directory. Errors will be logged as they occur, and will include the type -of the error, the IP address and username (if available) of the user who -triggered the error, and the values of all environment variables; if a -form was being submitted, the data in the form will also be included. -To disable error logging, delete or rename the -:file:`errorlog` file. - -.. _trbl-testserver: - -The Apache web server is not serving Bugzilla pages -################################################### - -After you have run :command:`checksetup.pl` twice, -run :command:`testserver.pl http://yoursite.yourdomain/yoururl` -to confirm that your web server is configured properly for -Bugzilla. - -:: - - $ ./testserver.pl http://landfill.bugzilla.org/bugzilla-tip - TEST-OK Webserver is running under group id in $webservergroup. - TEST-OK Got ant picture. - TEST-OK Webserver is executing CGIs. - TEST-OK Webserver is preventing fetch of http://landfill.bugzilla.org/bugzilla-tip/localconfig. - -.. _trbl-perlmodule: - -I installed a Perl module, but :file:`checksetup.pl` claims it's not installed! -############################################################################### - -This could be caused by one of two things: - -#. You have two versions of Perl on your machine. You are installing - modules into one, and Bugzilla is using the other. Rerun the CPAN - commands (or manual compile) using the full path to Perl from the - top of :file:`checksetup.pl`. This will make sure you - are installing the modules in the right place. - -#. The permissions on your library directories are set incorrectly. - They must, at the very least, be readable by the web server user or - group. It is recommended that they be world readable. - -.. _trbl-dbdSponge: - -DBD::Sponge::db prepare failed -############################## - -The following error message may appear due to a bug in DBD::mysql -(over which the Bugzilla team have no control): - -:: - - DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248. - SV = NULL(0x0) at 0x20fc444 - REFCNT = 1 - FLAGS = (PADBUSY,PADMY) - -To fix this, go to -:file:`<path-to-perl>/lib/DBD/sponge.pm` -in your Perl installation and replace - -.. code-block:: perl - - my $numFields; - if ($attribs->{'NUM_OF_FIELDS'}) { - $numFields = $attribs->{'NUM_OF_FIELDS'}; - } - elsif ($attribs->{'NAME'}) { - $numFields = @{$attribs->{NAME}}; - } - -with - -.. code-block:: perl - - my $numFields; - if ($attribs->{'NUM_OF_FIELDS'}) { - $numFields = $attribs->{'NUM_OF_FIELDS'}; - } - elsif ($attribs->{'NAMES'}) { - $numFields = @{$attribs->{NAMES}}; - } - -(note the S added to NAME.) - -.. _paranoid-security: - -cannot chdir(/var/spool/mqueue) -############################### - -If you are installing Bugzilla on SuSE Linux, or some other -distributions with ``paranoid`` security options, it is -possible that the checksetup.pl script may fail with the error: -:: - - cannot chdir(/var/spool/mqueue): Permission denied - -This is because your :file:`/var/spool/mqueue` -directory has a mode of ``drwx------``. -Type :command:`chmod 755 :file:`/var/spool/mqueue`` -as root to fix this problem. This will allow any process running on your -machine the ability to *read* the -:file:`/var/spool/mqueue` directory. - -.. _trbl-relogin-everyone: - -Everybody is constantly being forced to relogin -############################################### - -The most-likely cause is that the ``cookiepath`` parameter -is not set correctly in the Bugzilla configuration. You can change this (if -you're a Bugzilla administrator) from the editparams.cgi page via the web interface. - -The value of the cookiepath parameter should be the actual directory -containing your Bugzilla installation, *as seen by the end-user's -web browser*. Leading and trailing slashes are mandatory. You can -also set the cookiepath to any directory which is a parent of the Bugzilla -directory (such as '/', the root directory). But you can't put something -that isn't at least a partial match or it won't work. What you're actually -doing is restricting the end-user's browser to sending the cookies back only -to that directory. - -How do you know if you want your specific Bugzilla directory or the -whole site? - -If you have only one Bugzilla running on the server, and you don't -mind having other applications on the same server with it being able to see -the cookies (you might be doing this on purpose if you have other things on -your site that share authentication with Bugzilla), then you'll want to have -the cookiepath set to "/", or to a sufficiently-high enough directory that -all of the involved apps can see the cookies. - -.. _trbl-relogin-everyone-share: - -Examples of urlbase/cookiepath pairs for sharing login cookies -============================================================== - -| urlbase is http://bugzilla.mozilla.org/ -| cookiepath is / - - -| urlbase is http://tools.mysite.tld/bugzilla/ -| but you have http://tools.mysite.tld/someotherapp/ which shares -| authentication with your Bugzilla -| -| cookiepath is / - -On the other hand, if you have more than one Bugzilla running on the -server (some people do - we do on landfill) then you need to have the -cookiepath restricted enough so that the different Bugzillas don't -confuse their cookies with one another. - -.. _trbl-relogin-everyone-restrict: - -Examples of urlbase/cookiepath pairs to restrict the login cookie -================================================================= - -| urlbase is http://landfill.bugzilla.org/bugzilla-tip/ -| cookiepath is /bugzilla-tip/ - -| urlbase is http://landfill.bugzilla.org/bugzilla-4.0-branch/ -| cookiepath is /bugzilla-4.0-branch/ - -If you had cookiepath set to ``/`` at any point in the -past and need to set it to something more restrictive -(i.e. ``/bugzilla/``), you can safely do this without -requiring users to delete their Bugzilla-related cookies in their -browser (this is true starting with Bugzilla 2.18 and Bugzilla 2.16.5). - -.. _trbl-index: - -:file:`index.cgi` doesn't show up unless specified in the URL -############################################################# - -You probably need to set up your web server in such a way that it -will serve the index.cgi page as an index page. - -If you are using Apache, you can do this by adding -:file:`index.cgi` to the end of the -``DirectoryIndex`` line -as mentioned in :ref:`http-apache`. - -.. _trbl-passwd-encryption: - -checksetup.pl reports "Client does not support authentication protocol requested by server..." -############################################################################################## - -This error is occurring because you are using the new password -encryption that comes with MySQL 4.1, while your -:file:`DBD::mysql` module was compiled against an -older version of MySQL. If you recompile :file:`DBD::mysql` -against the current MySQL libraries (or just obtain a newer version -of this module) then the error may go away. - -If that does not fix the problem, or if you cannot recompile the -existing module (e.g. you're running Windows) and/or don't want to -replace it (e.g. you want to keep using a packaged version), then a -workaround is available from the MySQL docs: -`<http://dev.mysql.com/doc/mysql/en/Old_client.html>`_ - - diff --git a/docs/en/rst/using.rst b/docs/en/rst/using.rst deleted file mode 100644 index eb887093b..000000000 --- a/docs/en/rst/using.rst +++ /dev/null @@ -1,1378 +0,0 @@ - - -.. _using: - -============== -Using Bugzilla -============== - -.. _using-intro: - -Introduction -############ - -This section contains information for end-users of Bugzilla. There -is a machine with many Bugzilla test installations, called -`Landfill <http://landfill.bugzilla.org/>`_, which you are -welcome to play with (if it's up). However, not all of the Bugzilla -installations there will necessarily have all Bugzilla features enabled, -and different installations run different versions, so some things may not -quite work as this document describes. - -Frequently Asked Questions (FAQ) are available and answered on -`wiki.mozilla.org <http://wiki.mozilla.org/Bugzilla:FAQ>`_. -They may cover some questions you have which are left unanswered. - -.. _myaccount: - -Create a Bugzilla Account -######################### - -If you want to use Bugzilla, first you need to create an account. -Consult with the administrator responsible for your installation of -Bugzilla for the URL you should use to access it. If you're -test-driving Bugzilla, use an installation on -`Landfill <http://landfill.bugzilla.org/>`_. - -#. On the home page :file:`index.cgi`, click the - ``Open a new Bugzilla account`` link, or the - ``New Account`` link available in the footer of pages. - Now enter your email address, then click the ``Send`` - button. - - .. note:: If none of these links is available, this means that the - administrator of the installation has disabled self-registration. - This means that only an administrator can create accounts - for other users. One reason could be that this installation is - private. - - .. note:: Also, if only some users are allowed to create an account on - the installation, you may see these links but your registration - may fail if your email address doesn't match the ones accepted - by the installation. This is another way to restrict who can - access and edit bugs in this installation. - -#. Within moments, and if your registration is accepted, you should - receive an email to the address you provided, which contains your - login name (generally the same as the email address), and two URLs - with a token (a random string generated by the installation) to - confirm, respectively cancel, your registration. This is a way to - prevent users from abusing the generation of user accounts, for - instance by entering inexistent email addresses, or email addresses - which do not belong to them. - -#. By default, you have 3 days to confirm your registration. Past this - timeframe, the token is invalidated and the registration is - automatically canceled. You can also cancel this registration sooner - by using the appropriate URL in the email you got. - -#. If you confirm your registration, Bugzilla will ask you your real name - (optional, but recommended) and your password, which must be between - 3 and 16 characters long. - -#. Now all you need to do is to click the ``Log In`` - link in the footer at the bottom of the page in your browser, - enter your email address and password you just chose into the - login form, and click the ``Log in`` button. - -You are now logged in. Bugzilla uses cookies to remember you are -logged in so, unless you have cookies disabled or your IP address changes, -you should not have to log in again during your session. - -.. _bug_page: - -Anatomy of a Bug -################ - -The core of Bugzilla is the screen which displays a particular -bug. It's a good place to explain some Bugzilla concepts. -`Bug 1 on Landfill <http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1>`_ -is a good example. Note that the labels for most fields are hyperlinks; -clicking them will take you to context-sensitive help on that -particular field. Fields marked * may not be present on every -installation of Bugzilla. - -#. *Product and Component*: - Bugs are divided up by Product and Component, with a Product - having one or more Components in it. For example, - bugzilla.mozilla.org's "Bugzilla" Product is composed of several - Components: - - Administration: - Administration of a Bugzilla installation. - Bugzilla-General: - Anything that doesn't fit in the other components, or spans - multiple components. - Creating/Changing Bugs: - Creating, changing, and viewing bugs. - Documentation: - The Bugzilla documentation, including The Bugzilla Guide. - Email: - Anything to do with email sent by Bugzilla. - Installation: - The installation process of Bugzilla. - Query/Buglist: - Anything to do with searching for bugs and viewing the - buglists. - Reporting/Charting: - Getting reports from Bugzilla. - User Accounts: - Anything about managing a user account from the user's perspective. - Saved queries, creating accounts, changing passwords, logging in, - etc. - User Interface: - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, - etc. - -#. *Status and Resolution:* - These define exactly what state the bug is in - from not even - being confirmed as a bug, through to being fixed and the fix - confirmed by Quality Assurance. The different possible values for - Status and Resolution on your installation should be documented in the - context-sensitive help for those items. - -#. *Assigned To:* - The person responsible for fixing the bug. - -#. *\*QA Contact:* - The person responsible for quality assurance on this bug. - -#. *\*URL:* - A URL associated with the bug, if any. - -#. *Summary:* - A one-sentence summary of the problem. - -#. *\*Status Whiteboard:* - (a.k.a. Whiteboard) A free-form text area for adding short notes - and tags to a bug. - -#. *\*Keywords:* - The administrator can define keywords which you can use to tag and - categorise bugs - e.g. The Mozilla Project has keywords like crash - and regression. - -#. *Platform and OS:* - These indicate the computing environment where the bug was - found. - -#. *Version:* - The "Version" field is usually used for versions of a product which - have been released, and is set to indicate which versions of a - Component have the particular problem the bug report is - about. - -#. *Priority:* - The bug assignee uses this field to prioritize his or her bugs. - It's a good idea not to change this on other people's bugs. - -#. *Severity:* - This indicates how severe the problem is - from blocker - ("application unusable") to trivial ("minor cosmetic issue"). You - can also use this field to indicate whether a bug is an enhancement - request. - -#. *\*Target:* - (a.k.a. Target Milestone) A future version by which the bug is to - be fixed. e.g. The Bugzilla Project's milestones for future - Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not - restricted to numbers, thought - you can use any text strings, such - as dates. - -#. *Reporter:* - The person who filed the bug. - -#. *CC list:* - A list of people who get mail when the bug changes. - -#. *\*Time Tracking:* - This form can be used for time tracking. - To use this feature, you have to be blessed group membership - specified by the ``timetrackinggroup`` parameter. - - Orig. Est.: - This field shows the original estimated time. - Current Est.: - This field shows the current estimated time. - This number is calculated from ``Hours Worked`` - and ``Hours Left``. - Hours Worked: - This field shows the number of hours worked. - Hours Left: - This field shows the ``Current Est.`` - - ``Hours Worked``. - This value + ``Hours Worked`` will become the - new Current Est. - %Complete: - This field shows what percentage of the task is complete. - Gain: - This field shows the number of hours that the bug is ahead of the - ``Orig. Est.``. - Deadline: - This field shows the deadline for this bug. - -#. *Attachments:* - You can attach files (e.g. testcases or patches) to bugs. If there - are any attachments, they are listed in this section. - -#. *\*Dependencies:* - If this bug cannot be fixed unless other bugs are fixed (depends - on), or this bug stops other bugs being fixed (blocks), their - numbers are recorded here. - -#. *\*Votes:* - Whether this bug has any votes. - -#. *Additional Comments:* - You can add your two cents to the bug discussion here, if you have - something worthwhile to say. - -.. _lifecycle: - -Life Cycle of a Bug -################### - -The life cycle of a bug, also known as workflow, is customizable to match -the needs of your organization, see :ref:`bug_status_workflow`. -:ref:`lifecycle-image` contains a graphical representation of -the default workflow using the default bug statuses. If you wish to -customize this image for your site, the -`diagram file <../images/bzLifecycle.xml>`_ -is available in `Dia's <http://www.gnome.org/projects/dia>`_ -native XML format. - -.. _lifecycle-image: - -Lifecycle of a Bugzilla Bug -=========================== - -.. image:: ../images/bzLifecycle.png - -.. _query: - -Searching for Bugs -################## - -The Bugzilla Search page is the interface where you can find -any bug report, comment, or patch currently in the Bugzilla system. -`You can play with it on -Landfill <http://landfill.bugzilla.org/bugzilla-tip/query.cgi?format=advanced>`_. - -The Search page has controls for selecting different possible -values for all of the fields in a bug, as described above. For some -fields, multiple values can be selected. In those cases, Bugzilla -returns bugs where the content of the field matches any one of the selected -values. If none is selected, then the field can take any value. - -After a search is run, you can save it as a Saved Search, which -will appear in the page footer. If you are in the group defined -by the "querysharegroup" parameter, you may share your queries -with other users, see :ref:`savedsearches` for more details. - -.. _boolean: - -Boolean Charts -============== - -Highly advanced querying is done using Boolean Charts. - -The boolean charts further restrict the set of results -returned by a query. It is possible to search for bugs -based on elaborate combinations of criteria. - -The simplest boolean searches have only one term. These searches -permit the selected left *field* -to be compared using a -selectable *operator* to a -specified *value.* -Using the "And," "Or," and "Add Another Boolean Chart" buttons, -additional terms can be included in the query, further -altering the list of bugs returned by the query. - -There are three fields in each row of a boolean search. - -- *Field:* - the items being searched - -- *Operator:* - the comparison operator - -- *Value:* - the value to which the field is being compared - -.. _pronouns: - -Pronoun Substitution --------------------- - -Sometimes, a query needs to compare a user-related field -(such as ReportedBy) with a role-specific user (such as the -user running the query or the user to whom each bug is assigned). -When the operator is either "equals" or "notequals", the value -can be "%reporter%", "%assignee%", "%qacontact%", or "%user%". -The user pronoun -refers to the user who is executing the query or, in the case -of whining reports, the user who will be the recipient -of the report. The reporter, assignee, and qacontact -pronouns refer to the corresponding fields in the bug. - -Boolean charts also let you type a group name in any user-related -field if the operator is either "equals", "notequals" or "anyexact". -This will let you query for any member belonging (or not) to the -specified group. The group name must be entered following the -"%group.foo%" syntax, where "foo" is the group name. -So if you are looking for bugs reported by any user being in the -"editbugs" group, then you can type "%group.editbugs%". - -.. _negation: - -Negation --------- - -At first glance, negation seems redundant. Rather than -searching for - - NOT("summary" "contains the string" "foo"), - -one could search for - - ("summary" "does not contain the string" "foo"). - -However, the search - - ("CC" "does not contain the string" "@mozilla.org") - -would find every bug where anyone on the CC list did not contain -"@mozilla.org" while - - NOT("CC" "contains the string" "@mozilla.org") - -would find every bug where there was nobody on the CC list who -did contain the string. Similarly, the use of negation also permits -complex expressions to be built using terms OR'd together and then -negated. Negation permits queries such as - - NOT(("product" "equals" "update") OR - ("component" "equals" "Documentation")) - -to find bugs that are neither -in the update product or in the documentation component or - - NOT(("commenter" "equals" "%assignee%") OR - ("component" "equals" "Documentation")) - -to find non-documentation -bugs on which the assignee has never commented. - -.. _multiplecharts: - -Multiple Charts ---------------- - -The terms within a single row of a boolean chart are all -constraints on a single piece of data. If you are looking for -a bug that has two different people cc'd on it, then you need -to use two boolean charts. A search for - - ("cc" "contains the string" "foo@") AND - ("cc" "contains the string" "@mozilla.org") - -would return only bugs with "foo@mozilla.org" on the cc list. -If you wanted bugs where there is someone on the cc list -containing "foo@" and someone else containing "@mozilla.org", -then you would need two boolean charts. - - First chart: ("cc" "contains the string" "foo@") - Second chart: ("cc" "contains the string" "@mozilla.org") - -The bugs listed will be only the bugs where ALL the charts are true. - -.. _quicksearch: - -Quicksearch -=========== - -Quicksearch is a single-text-box query tool which uses -metacharacters to indicate what is to be searched. For example, typing -"``foo|bar``" -into Quicksearch would search for "foo" or "bar" in the -summary and status whiteboard of a bug; adding -"``:BazProduct``" would -search only in that product. -You can use it to find a bug by its number or its alias, too. - -You'll find the Quicksearch box in Bugzilla's footer area. -On Bugzilla's front page, there is an additional -`quicksearcgh help <../../../page.cgi?id=quicksearch.html>`_ -link which details how to use it. - -.. _casesensitivity: - -Case Sensitivity in Searches -============================ - -Bugzilla queries are case-insensitive and accent-insensitive, when -used with either MySQL or Oracle databases. When using Bugzilla with -PostgreSQL, however, some queries are case-sensitive. This is due to -the way PostgreSQL handles case and accent sensitivity. - -.. _list: - -Bug Lists -========= - -If you run a search, a list of matching bugs will be returned. - -The format of the list is configurable. For example, it can be -sorted by clicking the column headings. Other useful features can be -accessed using the links at the bottom of the list: - -Long Format: - this gives you a large page with a non-editable summary of the fields - of each bug. - -XML: - get the buglist in the XML format. - -CSV: - get the buglist as comma-separated values, for import into e.g. - a spreadsheet. - -Feed: - get the buglist as an Atom feed. Copy this link into your - favorite feed reader. If you are using Firefox, you can also - save the list as a live bookmark by clicking the live bookmark - icon in the status bar. To limit the number of bugs in the feed, - add a limit=n parameter to the URL. - -iCalendar: - Get the buglist as an iCalendar file. Each bug is represented as a - to-do item in the imported calendar. - -Change Columns: - change the bug attributes which appear in the list. - -Change several bugs at once: - If your account is sufficiently empowered, and more than one bug - appear in the bug list, this link is displayed which lets you make - the same change to all the bugs in the list - for example, changing - their assignee. - -Send mail to bug assignees: - If more than one bug appear in the bug list and there are at least - two distinct bug assignees, this links is displayed which lets you - easily send a mail to the assignees of all bugs on the list. - -Edit Search: - If you didn't get exactly the results you were looking for, you can - return to the Query page through this link and make small revisions - to the query you just made so you get more accurate results. - -Remember Search As: - You can give a search a name and remember it; a link will appear - in your page footer giving you quick access to run it again later. - -.. _individual-buglists: - -Adding/removing tags to/from bugs -================================= - -You can add and remove tags from individual bugs, which let you find and -manage bugs more easily. Tags are per-user and so are only visible and editable -by the user who created them. You can then run queries using tags as a criteria, -either by using the Advanced Search form, or simply by typing "tag:my_tag_name" -in the QuickSearch box at the top (or bottom) of the page. Tags can also be -displayed in buglists. - -This feature is useful when you want to keep track of several bugs, but -for different reasons. Instead of adding yourself to the CC list of all -these bugs and mixing all these reasons, you can now store these bugs in -separate lists, e.g. ``Keep in mind``, ``Interesting bugs``, -or ``Triage``. One big advantage of this way to manage bugs -is that you can easily add or remove tags from bugs one by one. - -.. _bugreports: - -Filing Bugs -########### - -.. _fillingbugs: - -Reporting a New Bug -=================== - -Years of bug writing experience has been distilled for your -reading pleasure into the -`Bug Writing Guidelines <http://landfill.bugzilla.org/bugzilla-tip/page.cgi?id=bug-writing.html>`_. -While some of the advice is Mozilla-specific, the basic principles of -reporting Reproducible, Specific bugs, isolating the Product you are -using, the Version of the Product, the Component which failed, the -Hardware Platform, and Operating System you were using at the time of -the failure go a long way toward ensuring accurate, responsible fixes -for the bug that bit you. - -The procedure for filing a bug is as follows: - -#. Click the ``New`` link available in the footer - of pages, or the ``Enter a new bug report`` link - displayed on the home page of the Bugzilla installation. - - .. note:: If you want to file a test bug to see how Bugzilla works, - you can do it on one of our test installations on - `Landfill <http://landfill.bugzilla.org/>`_. - -#. You first have to select the product in which you found a bug. - -#. You now see a form where you can specify the component (part of - the product which is affected by the bug you discovered; if you have - no idea, just select ``General`` if such a component exists), - the version of the program you were using, the Operating System and - platform your program is running on and the severity of the bug (if the - bug you found crashes the program, it's probably a major or a critical - bug; if it's a typo somewhere, that's something pretty minor; if it's - something you would like to see implemented, then that's an enhancement). - -#. You now have to give a short but descriptive summary of the bug you found. - ``My program is crashing all the time`` is a very poor summary - and doesn't help developers at all. Try something more meaningful or - your bug will probably be ignored due to a lack of precision. - The next step is to give a very detailed list of steps to reproduce - the problem you encountered. Try to limit these steps to a minimum set - required to reproduce the problem. This will make the life of - developers easier, and the probability that they consider your bug in - a reasonable timeframe will be much higher. - - .. note:: Try to make sure that everything in the summary is also in the first - comment. Summaries are often updated and this will ensure your original - information is easily accessible. - -#. As you file the bug, you can also attach a document (testcase, patch, - or screenshot of the problem). - -#. Depending on the Bugzilla installation you are using and the product in - which you are filing the bug, you can also request developers to consider - your bug in different ways (such as requesting review for the patch you - just attached, requesting your bug to block the next release of the - product, and many other product specific requests). - -#. Now is a good time to read your bug report again. Remove all misspellings, - otherwise your bug may not be found by developers running queries for some - specific words, and so your bug would not get any attention. - Also make sure you didn't forget any important information developers - should know in order to reproduce the problem, and make sure your - description of the problem is explicit and clear enough. - When you think your bug report is ready to go, the last step is to - click the ``Commit`` button to add your report into the database. - -You do not need to put "any" or similar strings in the URL field. -If there is no specific URL associated with the bug, leave this -field blank. - -If you feel a bug you filed was incorrectly marked as a -DUPLICATE of another, please question it in your bug, not -the bug it was duped to. Feel free to CC the person who duped it -if they are not already CCed. - -.. _cloningbugs: - -Clone an Existing Bug -===================== - -Starting with version 2.20, Bugzilla has a feature that allows you -to clone an existing bug. The newly created bug will inherit -most settings from the old bug. This allows you to track more -easily similar concerns in a new bug. To use this, go to the bug -that you want to clone, then click the ``Clone This Bug`` -link on the bug page. This will take you to the ``Enter Bug`` -page that is filled with the values that the old bug has. -You can change those values and/or texts if needed. - -.. _attachments: - -Attachments -########### - -You should use attachments, rather than comments, for large chunks of ASCII -data, such as trace, debugging output files, or log files. That way, it -doesn't bloat the bug for everyone who wants to read it, and cause people to -receive fat, useless mails. - -You should make sure to trim screenshots. There's no need to show the -whole screen if you are pointing out a single-pixel problem. - -Bugzilla stores and uses a Content-Type for each attachment -(e.g. text/html). To download an attachment as a different -Content-Type (e.g. application/xhtml+xml), you can override this -using a 'content_type' parameter on the URL, e.g. -:file:`&content_type=text/plain`. - -Also, you can enter the URL pointing to the attachment instead of -uploading the attachment itself. For example, this is useful if you want to -point to an external application, a website or a very large file. Note that -there is no guarantee that the source file will always be available, nor -that its content will remain unchanged. - -Another way to attach data is to paste text directly in the text field, -and Bugzilla will convert it into an attachment. This is pretty useful -when you do copy and paste, and you don't want to put the text in a temporary -file first. - -.. _patchviewer: - -Patch Viewer -============ - -Viewing and reviewing patches in Bugzilla is often difficult due to improper -format and the inherent readability issues that raw patches present. Patch -Viewer is an enhancement to Bugzilla designed to fix that by offering linking -to sections. - -Patch viewer allows you to: - -+ View patches in color, with side-by-side view rather than trying - to interpret the contents of the patch. - -+ See the difference between two patches. - -+ Collapse and expand sections of a patch for easy - reading. - -+ Link to a particular section of a patch for discussion or - review - -+ Create a rawtext unified format diff out of any patch, no - matter what format it came from - -.. _patchviewer_view: - -Viewing Patches in Patch Viewer -------------------------------- - -The main way to view a patch in patch viewer is to click on the -"Diff" link next to a patch in the Attachments list on a bug. You may -also do this within the edit window by clicking the "View Attachment As -Diff" button in the Edit Attachment screen. - -.. _patchviewer_diff: - -Seeing the Difference Between Two Patches ------------------------------------------ - -To see the difference between two patches, you must first view the -newer patch in Patch Viewer. Then select the older patch from the -dropdown at the top of the page ("Differences between \[dropdown] and -this patch") and click the "Diff" button. This will show you what -is new or changed in the newer patch. - -.. _patchviewer_collapse: - -Collapsing and Expanding Sections of a Patch --------------------------------------------- - -To view only a certain set of files in a patch (for example, if a -patch is absolutely huge and you want to only review part of it at a -time), you can click the "(+)" and "(-)" links next to each file (to -expand it or collapse it). If you want to collapse all files or expand -all files, you can click the "Collapse All" and "Expand All" links at the -top of the page. - -.. _patchviewer_link: - -Linking to a Section of a Patch -------------------------------- - -To link to a section of a patch (for example, if you want to be -able to give someone a URL to show them which part you are talking -about) you simply click the "Link Here" link on the section header. The -resulting URL can be copied and used in discussion. - -.. _patchviewer_unified_diff: - -Creating a Unified Diff ------------------------ - -If the patch is not in a format that you like, you can turn it -into a unified diff format by clicking the "Raw Unified" link at the top -of the page. - -.. _hintsandtips: - -Hints and Tips -############## - -This section distills some Bugzilla tips and best practices -that have been developed. - -Autolinkification -================= - -Bugzilla comments are plain text - so typing <U> will -produce less-than, U, greater-than rather than underlined text. -However, Bugzilla will automatically make hyperlinks out of certain -sorts of text in comments. For example, the text -"http://www.bugzilla.org" will be turned into a link: -`<http://www.bugzilla.org>`_. -Other strings which get linkified in the obvious manner are: - -+ bug 12345 - -+ bugs 123, 456, 789 - -+ comment 7 - -+ comments 1, 2, 3, 4 - -+ bug 23456, comment 53 - -+ attachment 4321 - -+ mailto:george@example.com - -+ george@example.com - -+ ftp://ftp.mozilla.org - -+ Most other sorts of URL - -A corollary here is that if you type a bug number in a comment, -you should put the word "bug" before it, so it gets autolinkified -for the convenience of others. - -.. _commenting: - -Comments -======== - -If you are changing the fields on a bug, only comment if -either you have something pertinent to say, or Bugzilla requires it. -Otherwise, you may spam people unnecessarily with bug mail. -To take an example: a user can set up their account to filter out messages -where someone just adds themselves to the CC field of a bug -(which happens a lot.) If you come along, add yourself to the CC field, -and add a comment saying "Adding self to CC", then that person -gets a pointless piece of mail they would otherwise have avoided. - -Don't use sigs in comments. Signing your name ("Bill") is acceptable, -if you do it out of habit, but full mail/news-style -four line ASCII art creations are not. - -.. _markdown: - -Markdown --------- - -Markdown lets you write your comments in a structured plain-text format and -have your comments generated as HTML. For example, you may use Markdown for -making a part of your comment look italic or bold in the generated HTML. Bugzilla -supports most of the structures defined by `standard Markdown <http://daringfireball.net/projects/markdown/basics>`_. -but does NOT support inline images and inline HTML. For a complete reference on -supported Markdown structures, please see the `syntax help <../../../page.cgi?id=markdown.html>`_ -link next to the markdown checkbox for new comments. - -To use the Markdown feature, make sure that ``Enable Markdown support for comments`` is set to ``on`` -in your :ref:`userpreferences` and that you also check the ``Use Markdown for this comment`` option below -the comment box when you want to submit a new comment. - -.. _comment-wrapping: - -Server-Side Comment Wrapping -============================ - -Bugzilla stores comments unwrapped and wraps them at display time. This -ensures proper wrapping in all browsers. Lines beginning with the ">" -character are assumed to be quotes, and are not wrapped. - -.. _dependencytree: - -Dependency Tree -=============== - -On the ``Dependency tree`` page linked from each bug -page, you can see the dependency relationship from the bug as a -tree structure. - -You can change how much depth to show, and you can hide resolved bugs -from this page. You can also collaps/expand dependencies for -each bug on the tree view, using the \[-]/\[+] buttons that appear -before its summary. This option is not available for terminal -bugs in the tree (that don't have further dependencies). - -.. _timetracking: - -Time Tracking Information -######################### - -Users who belong to the group specified by the ``timetrackinggroup`` -parameter have access to time-related fields. Developers can see -deadlines and estimated times to fix bugs, and can provide time spent -on these bugs. Users who do not belong to this group can only see the deadline, -but not edit it. Other time-related fields remain invisible to them. - -At any time, a summary of the time spent by developers on bugs is -accessible either from bug lists when clicking the ``Time Summary`` -button or from individual bugs when clicking the ``Summarize time`` -link in the time tracking table. The :file:`summarize_time.cgi` -page lets you view this information either per developer or per bug, -and can be split on a month basis to have greater details on how time -is spent by developers. - -As soon as a bug is marked as RESOLVED, the remaining time expected -to fix the bug is set to zero. This lets QA people set it again for -their own usage, and it will be set to zero again when the bug will -be marked as CLOSED. - -.. _userpreferences: - -User Preferences -################ - -Once logged in, you can customize various aspects of -Bugzilla via the "Preferences" link in the page footer. -The preferences are split into five tabs: - -.. _generalpreferences: - -General Preferences -=================== - -This tab allows you to change several default settings of Bugzilla. - -- Bugzilla's general appearance (skin) - select which skin to use. - Bugzilla supports adding custom skins. - -- Quote the associated comment when you click on its reply link - sets - the behavior of the comment "Reply" link. Options include quoting the - full comment, just reference the comment number, or turn the link off. - -- Language used in email - select which language email will be sent in, - from the list of available languages. - -- After changing a bug - This controls what page is displayed after - changes to a bug are submitted. The options include to show the bug - just modified, to show the next bug in your list, or to do nothing. - -- Zoom textareas large when in use (requires JavaScript) - enable or - disable the automatic expanding of text areas when text is being - entered into them. - -- Field separator character for CSV files - - Select between a comma and semi-colon for exported CSV bug lists. - -- Automatically add me to the CC list of bugs I change - set default - behavior of CC list. Options include "Always", "Never", and "Only - if I have no role on them". - -- When viewing a bug, show comments in this order - - controls the order of comments. Options include "Oldest - to Newest", "Newest to Oldest" and "Newest to Oldest, but keep the - bug description at the top". - -- Show a quip at the top of each bug list - controls - whether a quip will be shown on the Bug list page. - -.. _emailpreferences: - -Email Preferences -================= - -This tab allows you to enable or disable email notification on -specific events. - -In general, users have almost complete control over how much (or -how little) email Bugzilla sends them. If you want to receive the -maximum amount of email possible, click the ``Enable All -Mail`` button. If you don't want to receive any email from -Bugzilla at all, click the ``Disable All Mail`` button. - -.. note:: A Bugzilla administrator can stop a user from receiving - bugmail by clicking the ``Bugmail Disabled`` checkbox - when editing the user account. This is a drastic step - best taken only for disabled accounts, as it overrides - the user's individual mail preferences. - -There are two global options -- ``Email me when someone -asks me to set a flag`` and ``Email me when someone -sets a flag I asked for``. These define how you want to -receive bugmail with regards to flags. Their use is quite -straightforward; enable the checkboxes if you want Bugzilla to -send you mail under either of the above conditions. - -If you'd like to set your bugmail to something besides -'Completely ON' and 'Completely OFF', the -``Field/recipient specific options`` table -allows you to do just that. The rows of the table -define events that can happen to a bug -- things like -attachments being added, new comments being made, the -priority changing, etc. The columns in the table define -your relationship with the bug: - -- Reporter - Where you are the person who initially - reported the bug. Your name/account appears in the - ``Reporter:`` field. - -- Assignee - Where you are the person who has been - designated as the one responsible for the bug. Your - name/account appears in the ``Assigned To:`` - field of the bug. - -- QA Contact - You are one of the designated - QA Contacts for the bug. Your account appears in the - ``QA Contact:`` text-box of the bug. - -- CC - You are on the list CC List for the bug. - Your account appears in the ``CC:`` text box - of the bug. - -- Voter - You have placed one or more votes for the bug. - Your account appears only if someone clicks on the - ``Show votes for this bug`` link on the bug. - -.. note:: Some columns may not be visible for your installation, depending - on your site's configuration. - -To fine-tune your bugmail, decide the events for which you want -to receive bugmail; then decide if you want to receive it all -the time (enable the checkbox for every column), or only when -you have a certain relationship with a bug (enable the checkbox -only for those columns). For example: if you didn't want to -receive mail when someone added themselves to the CC list, you -could uncheck all the boxes in the ``CC Field Changes`` -line. As another example, if you never wanted to receive email -on bugs you reported unless the bug was resolved, you would -un-check all boxes in the ``Reporter`` column -except for the one on the ``The bug is resolved or -verified`` row. - -.. note:: Bugzilla adds the ``X-Bugzilla-Reason`` header to - all bugmail it sends, describing the recipient's relationship - (AssignedTo, Reporter, QAContact, CC, or Voter) to the bug. - This header can be used to do further client-side filtering. - -Bugzilla has a feature called ``Users Watching``. -When you enter one or more comma-delineated user accounts (usually email -addresses) into the text entry box, you will receive a copy of all the -bugmail those users are sent (security settings permitting). -This powerful functionality enables seamless transitions as developers -change projects or users go on holiday. - -.. note:: The ability to watch other users may not be available in all - Bugzilla installations. If you don't see this feature, and feel - that you need it, speak to your administrator. - -Each user listed in the ``Users watching you`` field -has you listed in their ``Users to watch`` list -and can get bugmail according to your relationship to the bug and -their ``Field/recipient specific options`` setting. - -.. _savedsearches: - -Saved Searches -============== - -On this tab you can view and run any Saved Searches that you have -created, and also any Saved Searches that other members of the group -defined in the "querysharegroup" parameter have shared. -Saved Searches can be added to the page footer from this screen. -If somebody is sharing a Search with a group she or he is allowed to -:ref:`assign users to <groups>`, the sharer may opt to have -the Search show up in the footer of the group's direct members by default. - -.. _accountpreferences: - -Account Information -=================== - -On this tab, you can change your basic account information, -including your password, email address and real name. For security -reasons, in order to change anything on this page you must type your -*current* password into the ``Password`` -field at the top of the page. -If you attempt to change your email address, a confirmation -email is sent to both the old and new addresses, with a link to use to -confirm the change. This helps to prevent account hijacking. - -.. _apikey: - -API Keys -======== - -API keys are used to authenticate WebService API calls. You can create more than -one API key if required. Each API key has an optional description which can help -you record what each key is used for. - -On this page, you can unrevoke, revoke and change the description of existing -API keys for your login. A revoked key means that it cannot be used. The -description for purely for your information, and is optional. - -You can also create a new API key by selecting the check box under the 'New -API key' section of the page. - -.. _permissionsettings: - -Permissions -=========== - -This is a purely informative page which outlines your current -permissions on this installation of Bugzilla. - -A complete list of permissions is below. Only users with -*editusers* privileges can change the permissions -of other users. - -admin - Indicates user is an Administrator. - -bz_canusewhineatothers - Indicates user can configure whine reports for other users. - -bz_canusewhines - Indicates user can configure whine reports for self. - -bz_quip_moderators - Indicates user can moderate quips. - -bz_sudoers - Indicates user can perform actions as other users. - -bz_sudo_protect - Indicates user cannot be impersonated by other users. - -canconfirm - Indicates user can confirm a bug or mark it a duplicate. - -creategroups - Indicates user can create and destroy groups. - -editbugs - Indicates user can edit all bug fields. - -editclassifications - Indicates user can create, destroy, and edit classifications. - -editcomponents - Indicates user can create, destroy, and edit components. - -editkeywords - Indicates user can create, destroy, and edit keywords. - -editusers - Indicates user can edit or disable users. - -tweakparams - Indicates user can change Parameters. - -.. note:: For more information on how permissions work in Bugzilla (i.e. who can - change what), see :ref:`cust-change-permissions`. - -.. _reporting: - -Reports and Charts -################## - -As well as the standard buglist, Bugzilla has two more ways of -viewing sets of bugs. These are the reports (which give different -views of the current state of the database) and charts (which plot -the changes in particular sets of bugs over time.) - -.. _reports: - -Reports -======= - -A report is a view of the current state of the bug database. - -You can run either an HTML-table-based report, or a graphical -line/pie/bar-chart-based one. The two have different pages to -define them, but are close cousins - once you've defined and -viewed a report, you can switch between any of the different -views of the data at will. - -Both report types are based on the idea of defining a set of bugs -using the standard search interface, and then choosing some -aspect of that set to plot on the horizontal and/or vertical axes. -You can also get a form of 3-dimensional report by choosing to have -multiple images or tables. - -So, for example, you could use the search form to choose "all -bugs in the WorldControl product", and then plot their severity -against their component to see which component had had the largest -number of bad bugs reported against it. - -Once you've defined your parameters and hit "Generate Report", -you can switch between HTML, CSV, Bar, Line and Pie. (Note: Pie -is only available if you didn't define a vertical axis, as pie -charts don't have one.) The other controls are fairly self-explanatory; -you can change the size of the image if you find text is overwriting -other text, or the bars are too thin to see. - -.. _charts: - -Charts -====== - -A chart is a view of the state of the bug database over time. - -Bugzilla currently has two charting systems - Old Charts and New -Charts. Old Charts have been part of Bugzilla for a long time; they -chart each status and resolution for each product, and that's all. -They are deprecated, and going away soon - we won't say any more -about them. -New Charts are the future - they allow you to chart anything you -can define as a search. - -.. note:: Both charting forms require the administrator to set up the - data-gathering script. If you can't see any charts, ask them whether - they have done so. - -An individual line on a chart is called a data set. -All data sets are organised into categories and subcategories. The -data sets that Bugzilla defines automatically use the Product name -as a Category and Component names as Subcategories, but there is no -need for you to follow that naming scheme with your own charts if -you don't want to. - -Data sets may be public or private. Everyone sees public data sets in -the list, but only their creator sees private data sets. Only -administrators can make data sets public. -No two data sets, even two private ones, can have the same set of -category, subcategory and name. So if you are creating private data -sets, one idea is to have the Category be your username. - -Creating Charts ---------------- - -You create a chart by selecting a number of data sets from the -list, and pressing Add To List for each. In the List Of Data Sets -To Plot, you can define the label that data set will have in the -chart's legend, and also ask Bugzilla to Sum a number of data sets -(e.g. you could Sum data sets representing RESOLVED, VERIFIED and -CLOSED in a particular product to get a data set representing all -the resolved bugs in that product.) - -If you've erroneously added a data set to the list, select it -using the checkbox and click Remove. Once you add more than one -data set, a "Grand Total" line -automatically appears at the bottom of the list. If you don't want -this, simply remove it as you would remove any other line. - -You may also choose to plot only over a certain date range, and -to cumulate the results - that is, to plot each one using the -previous one as a baseline, so the top line gives a sum of all -the data sets. It's easier to try than to explain :-) - -Once a data set is in the list, one can also perform certain -actions on it. For example, one can edit the -data set's parameters (name, frequency etc.) if it's one you -created or if you are an administrator. - -Once you are happy, click Chart This List to see the chart. - -.. _charts-new-series: - -Creating New Data Sets ----------------------- - -You may also create new data sets of your own. To do this, -click the "create a new data set" link on the Create Chart page. -This takes you to a search-like interface where you can define -the search that Bugzilla will plot. At the bottom of the page, -you choose the category, sub-category and name of your new -data set. - -If you have sufficient permissions, you can make the data set public, -and reduce the frequency of data collection to less than the default -seven days. - -.. _flags: - -Flags -##### - -A flag is a kind of status that can be set on bugs or attachments -to indicate that the bugs/attachments are in a certain state. -Each installation can define its own set of flags that can be set -on bugs or attachments. - -If your installation has defined a flag, you can set or unset that flag, -and if your administrator has enabled requesting of flags, you can submit -a request for another user to set the flag. - -To set a flag, select either "+" or "-" from the drop-down menu next to -the name of the flag in the "Flags" list. The meaning of these values are -flag-specific and thus cannot be described in this documentation, -but by way of example, setting a flag named "review" to "+" may indicate -that the bug/attachment has passed review, while setting it to "-" -may indicate that the bug/attachment has failed review. - -To unset a flag, click its drop-down menu and select the blank value. -Note that marking an attachment as obsolete automatically cancels all -pending requests for the attachment. - -If your administrator has enabled requests for a flag, request a flag -by selecting "?" from the drop-down menu and then entering the username -of the user you want to set the flag in the text field next to the menu. - -A set flag appears in bug reports and on "edit attachment" pages with the -abbreviated username of the user who set the flag prepended to the -flag name. For example, if Jack sets a "review" flag to "+", it appears -as Jack: review [ + ] - -A requested flag appears with the user who requested the flag prepended -to the flag name and the user who has been requested to set the flag -appended to the flag name within parentheses. For example, if Jack -asks Jill for review, it appears as Jack: review [ ? ] (Jill). - -You can browse through open requests made of you and by you by selecting -'My Requests' from the footer. You can also look at open requests limited -by other requesters, requestees, products, components, and flag names from -this page. Note that you can use '-' for requestee to specify flags with -'no requestee' set. - -.. _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 (i.e. the 15th of the month at midnight) or at -regular intervals (i.e. 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 a - 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. - - diff --git a/docs/en/rst/using/creating-an-account.rst b/docs/en/rst/using/creating-an-account.rst new file mode 100644 index 000000000..0ea42ee5d --- /dev/null +++ b/docs/en/rst/using/creating-an-account.rst @@ -0,0 +1,39 @@ +.. _creating-an-account: + +Creating an Account +################### + +If you want to use a particular installation of Bugzilla, first you need to +create an account. Ask the administrator responsible for your installation +for the URL you should use to access it. If you're test-driving Bugzilla, +you can use one of the installations on +`Landfill <http://landfill.bugzilla.org/>`_. + +The process of creating an account is similar to many other websites. + +#. On the home page, click the :guilabel:`New Account` link in the header. + Enter your email address, then click the ``Send`` + button. + + .. note:: If the :guilabel:`New Account` link is not available, this means that the + administrator of the installation has disabled self-registration. + Speak to the administrator to find out how to get an account. + +#. Within moments, you should + receive an email to the address you provided, which contains your + login name (generally the same as the email address), and a URL to + click to confirm your registration. + +#. Once you confirm your registration, Bugzilla will ask you your real name + (optional, but recommended) and ask you to choose a password. Depending + on how your Bugzilla is configured, there may be minimum complexity + requirements for the password. + +#. Now all you need to do is to click the :guilabel:`Log In` + link in the header or footer, + enter your email address and the password you just chose into the + login form, and click the :guilabel:`Log in` button. + +You are now logged in. Bugzilla uses cookies to remember you are +logged in, so, unless you have cookies disabled or your IP address changes, +you should not have to log in again during your session. diff --git a/docs/en/rst/using/editing.rst b/docs/en/rst/using/editing.rst new file mode 100644 index 000000000..c147d9d3b --- /dev/null +++ b/docs/en/rst/using/editing.rst @@ -0,0 +1,98 @@ +.. _editing: + +Editing a Bug +############# + +.. _attachments: + +Attachments +=========== + +Attachments are used to attach relevant files to bugs - patches, screenshots, +test cases, debugging aids or logs, or anything else binary or too large to +fit into a comment. + +You should use attachments, rather than comments, for large chunks of plain +text data, such as trace, debugging output files, or log files. That way, it +doesn't bloat the bug for everyone who wants to read it, and cause people to +receive large, useless mails. + +You should make sure to trim screenshots. There's no need to show the +whole screen if you are pointing out a single-pixel problem. + +Bugzilla stores and uses a Content-Type for each attachment +(e.g. text/html). To download an attachment as a different +Content-Type (e.g. application/xhtml+xml), you can override this +using a 'content_type' parameter on the URL, e.g. +:file:`&content_type=text/plain`. + +Also, you can enter the URL pointing to the attachment instead of +uploading the attachment itself. For example, this is useful if you want to +point to an external application, a website or a very large file. + +It's also possible to create an attachment by pasting text directly in a text +field; Bugzilla will convert it into an attachment. This is pretty useful +when you are copying and pasting, to avoid the extra step of saving the text +in a temporary file. + +.. _editing-flags: + +Flags +===== + +To set a flag, select either :guilabel:`+` or :guilabel:`-` from the drop-down +menu next to the name of the flag in the :guilabel:`Flags` list. The meaning +of these values are flag-specific and thus cannot be described in this +documentation, but by way of example, setting a flag named :guilabel:`review` +:guilabel:`+` may indicate that the bug/attachment has passed review, while +setting it to :guilabel:`-` may indicate that the bug/attachment has failed +review. + +To unset a flag, click its drop-down menu and select the blank value. +Note that marking an attachment as obsolete automatically cancels all +pending requests for the attachment. + +If your administrator has enabled requests for a flag, request a flag +by selecting :guilabel:`?` from the drop-down menu and then entering the +username of the user you want to set the flag in the text field next to the +menu. + +.. _time-tracking: + +Time Tracking +============= + +Users who belong to the group specified by the ``timetrackinggroup`` +parameter have access to time-related fields. Developers can see +deadlines and estimated times to fix bugs, and can provide time spent +on these bugs. Users who do not belong to this group can only see the deadline +but not edit it. Other time-related fields remain invisible to them. + +At any time, a summary of the time spent by developers on bugs is +accessible either from bug lists when clicking the ``Time Summary`` +button or from individual bugs when clicking the ``Summarize time`` +link in the time tracking table. The :file:`summarize_time.cgi` +page lets you view this information either per developer or per bug +and can be split on a month basis to have greater details on how time +is spent by developers. + +As soon as a bug is marked as RESOLVED, the remaining time expected +to fix the bug is set to zero. This lets QA people set it again for +their own usage, and it will be set to zero again when the bug is +marked as VERIFIED. + +.. _lifecycle: + +Life Cycle of a Bug +=================== + +The life cycle of a bug, also known as workflow, is customizable to match +the needs of your organization (see :ref:`workflow`). +The image below contains a graphical representation of +the default workflow using the default bug statuses. If you wish to +customize this image for your site, the +`diagram file <../../images/bzLifecycle.xml>`_ +is available in `Dia's <http://www.gnome.org/projects/dia>`_ +native XML format. + +.. image:: ../../images/bzLifecycle.png diff --git a/docs/en/rst/using/filing.rst b/docs/en/rst/using/filing.rst new file mode 100644 index 000000000..788cebbd5 --- /dev/null +++ b/docs/en/rst/using/filing.rst @@ -0,0 +1,82 @@ +.. _filing: + +Filing a Bug +############ + +Reporting a New Bug +=================== + +Years of bug writing experience has been distilled for your +reading pleasure into the +`Bug Writing Guidelines <http://landfill.bugzilla.org/bugzilla-tip/page.cgi?id=bug-writing.html>`_. +While some of the advice is Mozilla-specific, the basic principles of +reporting Reproducible, Specific bugs and isolating the Product you are +using, the Version of the Product, the Component which failed, the Hardware +Platform, and Operating System you were using at the time of the failure go a +long way toward ensuring accurate, responsible fixes for the bug that bit you. + +.. note:: If you want to file a test bug to see how Bugzilla works, + you can do it on one of our test installations on + `Landfill <http://landfill.bugzilla.org/>`_. Please don't do it on anyone's + production Bugzilla installation. + +The procedure for filing a bug is as follows: + +#. Click the :guilabel:`New` link available in the header or footer + of pages, or the :guilabel:`File a Bug` link on the home page. + +#. First, you have to select the product in which you found a bug. + +#. You now see a form where you can specify the component (part of + the product which is affected by the bug you discovered; if you have + no idea, just select :guilabel:`General` if such a component exists), + the version of the program you were using, the operating system and + platform your program is running on and the severity of the bug (if the + bug you found crashes the program, it's probably a major or a critical + bug; if it's a typo somewhere, that's something pretty minor; if it's + something you would like to see implemented, then that's an enhancement). + +#. You also need to provide a short but descriptive summary of the bug you found. + "My program is crashing all the time" is a very poor summary + and doesn't help developers at all. Try something more meaningful or + your bug will probably be ignored due to a lack of precision. + In the Description, give a detailed list of steps to reproduce + the problem you encountered. Try to limit these steps to a minimum set + required to reproduce the problem. This will make the life of + developers easier, and the probability that they consider your bug in + a reasonable timeframe will be much higher. + + .. note:: Try to make sure that everything in the Summary is also in the + Description. Summaries are often updated and this will ensure your original + information is easily accessible. + +#. As you file the bug, you can also attach a document (testcase, patch, + or screenshot of the problem). + +#. Depending on the Bugzilla installation you are using and the product in + which you are filing the bug, you can also request developers to consider + your bug in different ways (such as requesting review for the patch you + just attached, requesting your bug to block the next release of the + product, and many other product-specific requests). + +#. Now is a good time to read your bug report again. Remove all misspellings; + otherwise, your bug may not be found by developers running queries for some + specific words, and so your bug would not get any attention. + Also make sure you didn't forget any important information developers + should know in order to reproduce the problem, and make sure your + description of the problem is explicit and clear enough. + When you think your bug report is ready to go, the last step is to + click the :guilabel:`Submit Bug` button to add your report into the database. + +.. _cloning-a-bug: + +Clone an Existing Bug +===================== + +Bugzilla allows you to "clone" an existing bug. The newly created bug will +inherit most settings from the old bug. This allows you to track similar +concerns that require different handling in a new bug. To use this, go to +the bug that you want to clone, then click the :guilabel:`Clone This Bug` +link on the bug page. This will take you to the :guilabel:`Enter Bug` +page that is filled with the values that the old bug has. +You can then change the values and/or text if needed. diff --git a/docs/en/rst/using/finding.rst b/docs/en/rst/using/finding.rst new file mode 100644 index 000000000..414e30cba --- /dev/null +++ b/docs/en/rst/using/finding.rst @@ -0,0 +1,266 @@ +.. _finding: + +Finding Bugs +############ + +Bugzilla has a number of different search options. + +.. note:: Bugzilla queries are case-insensitive and accent-insensitive when + used with either MySQL or Oracle databases. When using Bugzilla with + PostgreSQL, however, some queries are case sensitive. This is due to + the way PostgreSQL handles case and accent sensitivity. + +.. _quicksearch: + +Quicksearch +=========== + +Quicksearch is a single-text-box query tool. You'll find it in +Bugzilla's header or footer. + +Quicksearch uses +metacharacters to indicate what is to be searched. For example, typing + + ``foo|bar`` + +into Quicksearch would search for "foo" or "bar" in the +summary and status whiteboard of a bug; adding + + ``:BazProduct`` + +would search only in that product. + +You can also use it to go directly to a bug by entering its number or its +alias. + +.. todo:: Need to incorporate the full reference, and link it properly from + the GUI. https://bugzilla.mozilla.org/page.cgi?id=quicksearch.html + Turn this item into a bug after checkin. + +Simple Search +============= + +Simple Search is good for finding one particular bug. It works like internet +search engines - just enter some keywords and off you go. + +Advanced Search +=============== + +The Advanced Search page is used to produce a list of all bugs fitting +exact criteria. `You can play with it on +Landfill <http://landfill.bugzilla.org/bugzilla-tip/query.cgi?format=advanced>`_. + +Advanced Search has controls for selecting different possible +values for all of the fields in a bug, as described above. For some +fields, multiple values can be selected. In those cases, Bugzilla +returns bugs where the content of the field matches any one of the selected +values. If none is selected, then the field can take any value. + +After a search is run, you can save it as a Saved Search, which +will appear in the page footer. If you are in the group defined +by the "querysharegroup" parameter, you may share your queries +with other users; see :ref:`saved-searches` for more details. + +.. _custom-search: + +Custom Search +============= + +Highly advanced querying is done using the Custom Search feature of the +Advanced Search page. + +The search criteria here further restrict the set of results +returned by a query over and above those defined in the fields at the top +of the page. It is thereby possible to search for bugs +based on elaborate combinations of criteria. + +The simplest boolean searches have only one term. These searches +permit the selected *field* +to be compared using a +selectable *operator* to a +specified *value.* Much of this could be reproduced using the standard +fields. However, you can then combine terms using "Match ANY" or "Match ALL", +using parentheses for combining and priority, in order to construct searches +of almost arbitrary complexity. + +There are three fields in each row of a boolean search. + +- *Field:* + the items being searched + +- *Operator:* + the comparison operator + +- *Value:* + the value to which the field is being compared + +.. _negation: + +.. _multiplecharts: + +Multiple Charts +--------------- + +.. todo:: This needs rewriting for the new UI. + Turn this item into a bug after checkin. + +The terms within a single row of a boolean chart are all +constraints on a single piece of data. If you are looking for +a bug that has two different people cc'd on it, then you need +to use two boolean charts. A search for + + ("cc" "contains the string" "foo@") AND + ("cc" "contains the string" "@mozilla.org") + +would return only bugs with "foo@mozilla.org" on the cc list. +If you wanted bugs where there is someone on the cc list +containing "foo@" and someone else containing "@mozilla.org", +then you would need two boolean charts. + + First chart: ("cc" "contains the string" "foo@") + Second chart: ("cc" "contains the string" "@mozilla.org") + +The bugs listed will be only the bugs where ALL the charts are true. + +Negation +-------- + +At first glance, negation seems redundant. Rather than +searching for + + NOT("summary" "contains the string" "foo"), + +one could search for + + ("summary" "does not contain the string" "foo"). + +However, the search + + ("CC" "does not contain the string" "@mozilla.org") + +would find every bug where anyone on the CC list did not contain +"@mozilla.org" while + + NOT("CC" "contains the string" "@mozilla.org") + +would find every bug where there was nobody on the CC list who +did contain the string. Similarly, the use of negation also permits +complex expressions to be built using terms OR'd together and then +negated. Negation permits queries such as + + NOT(("product" "equals" "update") OR + ("component" "equals" "Documentation")) + +to find bugs that are neither +in the update product or in the documentation component or + + NOT(("commenter" "equals" "%assignee%") OR + ("component" "equals" "Documentation")) + +to find non-documentation +bugs on which the assignee has never commented. + +.. _pronouns: + +Pronoun Substitution +-------------------- + +Sometimes, a query needs to compare a user-related field +(such as Reporter) with a role-specific user (such as the +user running the query or the user to whom each bug is assigned). For +example, you may want to find all bugs which are assigned to the person +who reported them. + +When the Custom Search operator is either "equals" or "notequals", the value +can be "%reporter%", "%assignee%", "%qacontact%", or "%user%". +The user pronoun +refers to the user who is executing the query or, in the case +of whining reports, the user who will be the recipient +of the report. The reporter, assignee, and qacontact +pronouns refer to the corresponding fields in the bug. + +Boolean charts also let you type a group name in any user-related +field if the operator is either "equals", "notequals" or "anyexact". +This will let you query for any member belonging (or not) to the +specified group. The group name must be entered following the +"%group.foo%" syntax, where "foo" is the group name. +So if you are looking for bugs reported by any user being in the +"editbugs" group, then you can type "%group.editbugs%". + +.. _list: + +Bug Lists +========= + +The result of a search is a list of matching bugs. + +The format of the list is configurable. For example, it can be +sorted by clicking the column headings. Other useful features can be +accessed using the links at the bottom of the list: + +Long Format: + this gives you a large page with a non-editable summary of the fields + of each bug. + +XML: + get the buglist in the XML format. + +CSV: + get the buglist as comma-separated values, for import into e.g. + a spreadsheet. + +Feed: + get the buglist as an Atom feed. Copy this link into your + favorite feed reader. If you are using Firefox, you can also + save the list as a live bookmark by clicking the live bookmark + icon in the status bar. To limit the number of bugs in the feed, + add a limit=n parameter to the URL. + +iCalendar: + Get the buglist as an iCalendar file. Each bug is represented as a + to-do item in the imported calendar. + +Change Columns: + change the bug attributes which appear in the list. + +Change several bugs at once: + If your account is sufficiently empowered, and more than one bug + appears in the bug list, this link is displayed and lets you easily make + the same change to all the bugs in the list - for example, changing + their assignee. + +Send mail to bug assignees: + If more than one bug appear in the bug list and there are at least + two distinct bug assignees, this links is displayed which lets you + easily send a mail to the assignees of all bugs on the list. + +Edit Search: + If you didn't get exactly the results you were looking for, you can + return to the Query page through this link and make small revisions + to the query you just made so you get more accurate results. + +Remember Search As: + You can give a search a name and remember it; a link will appear + in your page footer giving you quick access to run it again later. + +.. _individual-buglists: + +Adding and Removing Tags on Bugs +================================ + +.. todo:: Looks like you can no longer do this from search results; is that right? + Turn this item into a bug after checkin. + +You can add and remove tags from individual bugs, which let you find and +manage bugs more easily. Tags are per-user and so are only visible and editable +by the user who created them. You can then run queries using tags as a criteria, +either by using the Advanced Search form, or simply by typing "tag\:my_tag_name" +in the QuickSearch box at the top (or bottom) of the page. Tags can also be +displayed in buglists. + +This feature is useful when you want to keep track of several bugs, but +for different reasons. Instead of adding yourself to the CC list of all +these bugs and mixing all these reasons, you can now store these bugs in +separate lists, e.g. ``Keep in mind``, ``Interesting bugs``, +or ``Triage``. One big advantage of this way to manage bugs +is that you can easily add or remove tags from bugs one by one. diff --git a/docs/en/rst/using/index.rst b/docs/en/rst/using/index.rst new file mode 100644 index 000000000..f336b3729 --- /dev/null +++ b/docs/en/rst/using/index.rst @@ -0,0 +1,18 @@ +.. _using: + +========== +User Guide +========== + +.. toctree:: + :maxdepth: 2 + + creating-an-account + filing + understanding + editing + finding + reports-and-charts + tips + preferences + diff --git a/docs/en/rst/using/preferences.rst b/docs/en/rst/using/preferences.rst new file mode 100644 index 000000000..d61dc4f8a --- /dev/null +++ b/docs/en/rst/using/preferences.rst @@ -0,0 +1,195 @@ +.. _user-preferences: + +User Preferences +################ + +Once logged in, you can customize various aspects of +Bugzilla via the "Preferences" link in the page footer. +The preferences are split into a number of tabs, detailed in the sections +below. + +.. _generalpreferences: + +General Preferences +=================== + +This tab allows you to change several default settings of Bugzilla. +Administrators have the power to remove preferences from this list, so you +may not see all the preferences available. + +Each preference should be self-explanatory. + +.. _emailpreferences: + +Email Preferences +================= + +This tab allows you to enable or disable email notification on +specific events. + +In general, users have almost complete control over how much (or +how little) email Bugzilla sends them. If you want to receive the +maximum amount of email possible, click the ``Enable All +Mail`` button. If you don't want to receive any email from +Bugzilla at all, click the ``Disable All Mail`` button. + +.. note:: A Bugzilla administrator can stop a user from receiving + bugmail by clicking the ``Bugmail Disabled`` checkbox + when editing the user account. This is a drastic step + best taken only for disabled accounts, as it overrides + the user's individual mail preferences. + +There are two global options -- ``Email me when someone +asks me to set a flag`` and ``Email me when someone +sets a flag I asked for``. These define how you want to +receive bugmail with regards to flags. Their use is quite +straightforward: enable the checkboxes if you want Bugzilla to +send you mail under either of the above conditions. + +If you'd like to set your bugmail to something besides +'Completely ON' and 'Completely OFF', the +``Field/recipient specific options`` table +allows you to do just that. The rows of the table +define events that can happen to a bug -- things like +attachments being added, new comments being made, the +priority changing, etc. The columns in the table define +your relationship with the bug - reporter, assignee, QA contact (if enabled) +or CC list member. + +To fine-tune your bugmail, decide the events for which you want +to receive bugmail; then decide if you want to receive it all +the time (enable the checkbox for every column) or only when +you have a certain relationship with a bug (enable the checkbox +only for those columns). For example, if you didn't want to +receive mail when someone added themselves to the CC list, you +could uncheck all the boxes in the ``CC Field Changes`` +line. As another example, if you never wanted to receive email +on bugs you reported unless the bug was resolved, you would +uncheck all boxes in the ``Reporter`` column +except for the one on the ``The bug is resolved or +verified`` row. + +.. note:: Bugzilla adds the ``X-Bugzilla-Reason`` header to + all bugmail it sends, describing the recipient's relationship + (AssignedTo, Reporter, QAContact, CC, or Voter) to the bug. + This header can be used to do further client-side filtering. + +Bugzilla has a feature called ``User Watching``. +When you enter one or more comma-delineated user accounts (usually email +addresses) into the text entry box, you will receive a copy of all the +bugmail those users are sent (security settings permitting). +This powerful functionality enables seamless transitions as developers +change projects or users go on holiday. + +Each user listed in the ``Users watching you`` field +has you listed in their ``Users to watch`` list +and can get bugmail according to your relationship to the bug and +their ``Field/recipient specific options`` setting. + +Lastly, you can define a list of bugs on which you no longer wish to receive +any email, ever. (You can also add bugs to this list individually by checking +the "Ignore Bug Mail" checkbox on the bug page for that bug.) This is useful +for ignoring bugs where you are the reporter, as that's a role it's not +possible to stop having. + +.. _saved-searches: + +Saved Searches +============== + +On this tab you can view and run any Saved Searches that you have +created, and any Saved Searches that other members of the group +defined in the :param:`querysharegroup` parameter have shared. +Saved Searches can be added to the page footer from this screen. +If somebody is sharing a Search with a group they are allowed to +:ref:`assign users to <groups>`, the sharer may opt to have +the Search show up in the footer of the group's direct members by default. + +.. _account-information: + +Account Information +=================== + +On this tab, you can change your basic account information, +including your password, email address and real name. For security +reasons, in order to change anything on this page you must type your +*current* password into the ``Password`` +field at the top of the page. +If you attempt to change your email address, a confirmation +email is sent to both the old and new addresses with a link to use to +confirm the change. This helps to prevent account hijacking. + +.. _api-keys: + +API Keys +======== + +API keys allow you to give a "token" to some external software so it can log +in to the WebService API as you without knowing your password. You can then +revoke that token if you stop using the web service, and you don't need to +change your password everywhere. + +You can create more than one API key if required. Each API key has an optional +description which can help you record what it is used for. + +On this page, you can unrevoke, revoke and change the description of existing +API keys for your login. A revoked key means that it cannot be used. The +description is optional and purely for your information. + +You can also create a new API key by selecting the checkbox under the 'New +API key' section of the page. + +.. _permissions: + +Permissions +=========== + +This is a purely informative page which outlines your current +permissions on this installation of Bugzilla. + +A complete list of permissions in a default install of Bugzilla is below. +Your administrator may have defined other permissions. Only users with +*editusers* privileges can change the permissions of other users. + +admin + Indicates user is an Administrator. + +bz_canusewhineatothers + Indicates user can configure whine reports for other users. + +bz_canusewhines + Indicates user can configure whine reports for self. + +bz_quip_moderators + Indicates user can moderate quips. + +bz_sudoers + Indicates user can perform actions as other users. + +bz_sudo_protect + Indicates user cannot be impersonated by other users. + +canconfirm + Indicates user can confirm a bug or mark it a duplicate. + +creategroups + Indicates user can create and destroy groups. + +editbugs + Indicates user can edit all bug fields. + +editclassifications + Indicates user can create, destroy and edit classifications. + +editcomponents + Indicates user can create, destroy and edit products, components, + versions, milestones and flag types. + +editkeywords + Indicates user can create, destroy and edit keywords. + +editusers + Indicates user can create, disable and edit users. + +tweakparams + Indicates user can change :ref:`Parameters <parameters>`. diff --git a/docs/en/rst/using/reports-and-charts.rst b/docs/en/rst/using/reports-and-charts.rst new file mode 100644 index 000000000..659cd5cbd --- /dev/null +++ b/docs/en/rst/using/reports-and-charts.rst @@ -0,0 +1,120 @@ +.. _reports-and-charts: + +Reports and Charts +################## + +As well as the standard buglist, Bugzilla has two more ways of +viewing sets of bugs. These are the reports (which give different +views of the current state of the database) and charts (which plot +the changes in particular sets of bugs over time). + +.. _reports: + +Reports +======= + +A report is a view of the current state of the bug database. + +You can run either an HTML-table-based report, or a graphical +line/pie/bar-chart-based one. The two have different pages to +define them but are close cousins - once you've defined and +viewed a report, you can switch between any of the different +views of the data at will. + +Both report types are based on the idea of defining a set of bugs +using the standard search interface and then choosing some +aspect of that set to plot on the horizontal and/or vertical axes. +You can also get a form of 3-dimensional report by choosing to have +multiple images or tables. + +So, for example, you could use the search form to choose "all +bugs in the WorldControl product" and then plot their severity +against their component to see which component had had the largest +number of bad bugs reported against it. + +Once you've defined your parameters and hit :guilabel:`Generate Report`, +you can switch between HTML, CSV, Bar, Line and Pie. (Note: Pie +is only available if you didn't define a vertical axis, as pie +charts don't have one.) The other controls are fairly self-explanatory; +you can change the size of the image if you find text is overwriting +other text, or the bars are too thin to see. + +.. _charts: + +Charts +====== + +A chart is a view of the state of the bug database over time. + +Bugzilla currently has two charting systems - Old Charts and New +Charts. Old Charts have been part of Bugzilla for a long time; they +chart each status and resolution for each product, and that's all. +They are deprecated, and going away soon - we won't say any more +about them. +New Charts are the future - they allow you to chart anything you +can define as a search. + +.. note:: Both charting forms require the administrator to set up the + data-gathering script. If you can't see any charts, ask them whether + they have done so. + +An individual line on a chart is called a data set. +All data sets are organised into categories and subcategories. The +data sets that Bugzilla defines automatically use the Product name +as a :guilabel:`Category` and Component names as :guilabel:`Subcategories`, +but there is no need for you to follow that naming scheme with your own +charts if you don't want to. + +Data sets may be public or private. Everyone sees public data sets in +the list, but only their creator sees private data sets. Only +administrators can make data sets public. +No two data sets, even two private ones, can have the same set of +category, subcategory and name. So if you are creating private data +sets, one idea is to have the :guilabel:`Category` be your username. + +Creating Charts +--------------- + +You create a chart by selecting a number of data sets from the +list and pressing :guilabel:`Add To List` for each. In the +:guilabel:`List Of Data Sets To Plot`, you can define the label that data +set will have in the chart's legend and also ask Bugzilla to :guilabel:`Sum` +a number of data sets (e.g. you could :guilabel:`Sum` data sets representing +:guilabel:`RESOLVED`, :guilabel:`VERIFIED` and :guilabel:`CLOSED` in a +particular product to get a data set representing all the resolved bugs in +that product.) + +If you've erroneously added a data set to the list, select it +using the checkbox and click :guilabel:`Remove`. Once you add more than one +data set, a :guilabel:`Grand Total` line +automatically appears at the bottom of the list. If you don't want +this, simply remove it as you would remove any other line. + +You may also choose to plot only over a certain date range, and +to cumulate the results, that is, to plot each one using the +previous one as a baseline so the top line gives a sum of all +the data sets. It's easier to try than to explain :-) + +Once a data set is in the list, you can also perform certain +actions on it. For example, you can edit the +data set's parameters (name, frequency etc.) if it's one you +created or if you are an administrator. + +Once you are happy, click :guilabel:`Chart This List` to see the chart. + +.. _charts-new-series: + +Creating New Data Sets +---------------------- + +You may also create new data sets of your own. To do this, +click the :guilabel:`create a new data set` link on the +:guilabel:`Create Chart` page. This takes you to a search-like interface +where you can define the search that Bugzilla will plot. At the bottom of the +page, you choose the category, sub-category and name of your new +data set. + +If you have sufficient permissions, you can make the data set public, +and reduce the frequency of data collection to less than the default +of seven days. + diff --git a/docs/en/rst/using/tips.rst b/docs/en/rst/using/tips.rst new file mode 100644 index 000000000..a48149275 --- /dev/null +++ b/docs/en/rst/using/tips.rst @@ -0,0 +1,92 @@ +.. _pro-tips: + +Pro Tips +######## + +This section distills some Bugzilla tips and best practices +that have been developed. + +Autolinkification +================= + +Bugzilla comments are plain text - so typing <U> will +produce less-than, U, greater-than rather than underlined text. +However, Bugzilla will automatically make hyperlinks out of certain +sorts of text in comments. For example, the text +``http://www.bugzilla.org`` will be turned into a link: +`<http://www.bugzilla.org>`_. +Other strings which get linkified in the obvious manner are: + ++ bug 12345 + ++ bugs 123, 456, 789 + ++ comment 7 + ++ comments 1, 2, 3, 4 + ++ bug 23456, comment 53 + ++ attachment 4321 + ++ mailto\:george\@example.com + ++ george\@example.com + ++ ftp\://ftp.mozilla.org + ++ Most other sorts of URL + +A corollary here is that if you type a bug number in a comment, +you should put the word "bug" before it, so it gets autolinkified +for the convenience of others. + +.. _commenting: + +Comments +======== + +If you are changing the fields on a bug, only comment if +either you have something pertinent to say or Bugzilla requires it. +Otherwise, you may spam people unnecessarily with bugmail. +To take an example: a user can set up their account to filter out messages +where someone just adds themselves to the CC field of a bug +(which happens a lot). If you come along, add yourself to the CC field, +and add a comment saying "Adding self to CC", then that person +gets a pointless piece of mail they would otherwise have avoided. + +Don't use sigs in comments. Signing your name ("Bill") is acceptable, +if you do it out of habit, but full mail/news-style +four line ASCII art creations are not. + +If you feel a bug you filed was incorrectly marked as a +DUPLICATE of another, please question it in your bug, not +the bug it was duped to. Feel free to CC the person who duped it +if they are not already CCed. + +.. _markdown: + +Markdown +-------- + +Markdown is a structured plain-text format which lets you write comments that +have more styling than plain text. For example, you may use Markdown for +making a part of your comment look italic or bold in the generated HTML. +Bugzilla supports most of the structures defined by +`standard Markdown <http://daringfireball.net/projects/markdown/basics>`_, +but does **not** support inline images and inline HTML. For a complete +reference on supported Markdown structures, please see the +`syntax help <https://bugzilla.mozilla.org/page.cgi?id=markdown.html>`_ link +next to the Markdown checkbox for new comments. + +.. todo:: The above link isn't ideal, but we can't easily link to the user's + Bugzilla because the docs aren't always on a Bugzilla (e.g. + when they are on ReadTheDocs). Best solution is to port the + Markdown guide to ReST. + Turn this item into a bug after checkin. + +To use the Markdown feature, make sure that :guilabel:`Enable Markdown +support for comments` is set to :guilabel:`on` +in your :ref:`user-preferences` and that you also check the :guilabel:`Use +Markdown for this comment` option below the comment box when you want to +submit a new comment which uses Markdown. diff --git a/docs/en/rst/using/understanding.rst b/docs/en/rst/using/understanding.rst new file mode 100644 index 000000000..014abefd6 --- /dev/null +++ b/docs/en/rst/using/understanding.rst @@ -0,0 +1,302 @@ +.. _understanding: + +Understanding a Bug +################### + +The core of Bugzilla is the screen which displays a particular +bug. Note that the labels for most fields are hyperlinks; +clicking them will take you to context-sensitive help on that +particular field. Fields marked * may not be present on every +installation of Bugzilla. + +*Summary:* + A one-sentence summary of the problem, displayed in the header next to + the bug number. + +*Status (and Resolution):* + These define exactly what state the bug is in—from not even + being confirmed as a bug, through to being fixed and the fix + confirmed by Quality Assurance. The different possible values for + Status and Resolution on your installation should be documented in the + context-sensitive help for those items. + +*Alias:* + A unique short text name for the bug, which can be used instead of the + bug number. + +*Product and Component*: + Bugs are divided up by Product and Component, with a Product + having one or more Components in it. + +*Version:* + The "Version" field usually contains the numbers or names of released + versions of the product. It is used to indicate the version(s) affected by + the bug report. + +*Hardware (Platform and OS):* + These indicate the computing environment where the bug was + found. + +*Importance (Priority and Severity):* + The Priority field is used to prioritize bugs, either by the assignee, + or someone else with authority to direct their time such as a project + manager. It's a good idea not to change this on other people's bugs. The + default values are P1 to P5. + + The Severity field indicates how severe the problem is—from blocker + ("application unusable") to trivial ("minor cosmetic issue"). You + can also use this field to indicate whether a bug is an enhancement + request. + +*\*Target Milestone:* + A future version by which the bug is to + be fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 4.4, 5.0, 6.0, etc. Milestones are not + restricted to numbers, though—you can use any text strings, such + as dates. + +*Assigned To:* + The person responsible for fixing the bug. + +*\*QA Contact:* + The person responsible for quality assurance on this bug. + +*URL:* + A URL associated with the bug, if any. + +*\*Whiteboard:* + A free-form text area for adding short notes and tags to a bug. + +*Keywords:* + The administrator can define keywords which you can use to tag and + categorise bugs—e.g. ``crash`` or ``regression``. + +*Personal Tags:* + Unlike Keywords which are global and visible by all users, Personal Tags + are personal and can only be viewed and edited by their author. Editing + them won't send any notification to other users. Use them to tag and keep + track of bugs. + +*Dependencies (Depends On and Blocks):* + If this bug cannot be fixed unless other bugs are fixed (depends + on), or this bug stops other bugs being fixed (blocks), their + numbers are recorded here. + + Clicking the :guilabel:`Dependency tree` link shows + the dependency relationships of the bug as a tree structure. + You can change how much depth to show, and you can hide resolved bugs + from this page. You can also collapse/expand dependencies for + each non-terminal bug on the tree view, using the [-]/[+] buttons that + appear before the summary. + +*Reported:* + The person who filed the bug, and the date and time they did it. + +*Modified:* + The date and time the bug was last changed. + +*CC List:* + A list of people who get mail when the bug changes, in addition to the + Reporter, Assignee and QA Contact (if enabled). + +*Ignore Bug Mail:* + Set this if you want never to get bugmail from this bug again. See also + :ref:`emailpreferences`. + +*\*See Also:* + Bugs, in this Bugzilla, other Bugzillas, or other bug trackers, that are + related to this one. + +*Flags:* + A flag is a kind of status that can be set on bugs or attachments + to indicate that the bugs/attachments are in a certain state. + Each installation can define its own set of flags that can be set + on bugs or attachments. See :ref:`flags`. + +*\*Time Tracking:* + This form can be used for time tracking. + To use this feature, you have to be a member of the group + specified by the :param:`timetrackinggroup` parameter. See + :ref:`time-tracking` for more information. + + Orig. Est.: + This field shows the original estimated time. + Current Est.: + This field shows the current estimated time. + This number is calculated from ``Hours Worked`` + and ``Hours Left``. + Hours Worked: + This field shows the number of hours worked. + Hours Left: + This field shows the ``Current Est.`` - + ``Hours Worked``. + This value + ``Hours Worked`` will become the + new Current Est. + %Complete: + This field shows what percentage of the task is complete. + Gain: + This field shows the number of hours that the bug is ahead of the + ``Orig. Est.``. + Deadline: + This field shows the deadline for this bug. + +*Attachments:* + You can attach files (e.g. test cases or patches) to bugs. If there + are any attachments, they are listed in this section. See + :ref:`attachments` for more information. + +*Additional Comments:* + You can add your two cents to the bug discussion here, if you have + something worthwhile to say. + +.. _flags: + +Flags +===== + +Flags are a way to attach a specific status to a bug or attachment, +either ``+`` or ``-``. The meaning of these symbols depends on the name of +the flag itself, but contextually they could mean pass/fail, +accept/reject, approved/denied, or even a simple yes/no. If your site +allows requestable flags, then users may set a flag to ``?`` as a +request to another user that they look at the bug/attachment and set +the flag to its correct status. + +A set flag appears in bug reports and on "edit attachment" pages with the +abbreviated username of the user who set the flag prepended to the +flag name. For example, if Jack sets a "review" flag to ``+``, it appears +as :guilabel:`Jack: review [ + ]`. + +A requested flag appears with the user who requested the flag prepended +to the flag name and the user who has been requested to set the flag +appended to the flag name within parentheses. For example, if Jack +asks Jill for review, it appears as :guilabel:`Jack: review [ ? ] (Jill)`. + +You can browse through open requests made of you and by you by selecting +:guilabel:`My Requests` from the footer. You can also look at open requests +limited by other requesters, requestees, products, components, and flag names. +Note that you can use '-' for requestee to specify flags with no requestee +set. + +.. _flags-simpleexample: + +A Simple Example +---------------- + +A developer might want to ask their manager, +"Should we fix this bug before we release version 2.0?" +They might want to do this for a *lot* of bugs, +so they decide to streamline the process. So: + +#. The Bugzilla administrator creates a flag type called blocking2.0 for bugs + in your product. It shows up on the :guilabel:`Show Bug` screen as the text + :guilabel:`blocking2.0` with a drop-down box next to it. The drop-down box + contains four values: an empty space, ``?``, ``-``, and ``+``. + +#. The developer sets the flag to ``?``. + +#. The manager sees the :guilabel:`blocking2.0` + flag with a ``?`` value. + +#. If the manager thinks the feature should go into the product + before version 2.0 can be released, they set the flag to + ``+``. Otherwise, they set it to ``-``. + +#. Now, every Bugzilla user who looks at the bug knows whether or + not the bug needs to be fixed before release of version 2.0. + +.. _flags-about: + +About Flags +----------- + +Flags can have four values: + +``?`` + A user is requesting that a status be set. (Think of it as 'A question is being asked'.) + +``-`` + The status has been set negatively. (The question has been answered ``no``.) + +``+`` + The status has been set positively. + (The question has been answered ``yes``.) + +``_`` + ``unset`` actually shows up as a blank space. This just means that nobody + has expressed an opinion (or asked someone else to express an opinion) + about the matter covered by this flag. + +.. _flag-askto: + +Flag Requests +------------- + +If a flag has been defined as :guilabel:`requestable`, and a user has enough +privileges to request it (see below), the user can set the flag's status to +``?``. This status indicates that someone (a.k.a. "the requester") is asking +someone else to set the flag to either ``+`` or ``-``. + +If a flag has been defined as :guilabel:`specifically requestable`, +a text box will appear next to the flag into which the requester may +enter a Bugzilla username. That named person (a.k.a. "the requestee") +will receive an email notifying them of the request, and pointing them +to the bug/attachment in question. + +If a flag has *not* been defined as :guilabel:`specifically requestable`, +then no such text box will appear. A request to set this flag cannot be made +of any specific individual; these requests are open for anyone to answer. In +Bugzilla this is known as "asking the wind". A requester may ask the wind on +any flag simply by leaving the text box blank. + +.. _flag-types: + +.. _flag-type-attachment: + +Attachment Flags +---------------- + +There are two types of flags: bug flags and attachment flags. + +Attachment flags are used to ask a question about a specific +attachment on a bug. + +Many Bugzilla installations use this to +request that one developer review another +developer's code before they check it in. They attach the code to +a bug report, and then set a flag on that attachment called +:guilabel:`review` to +:guilabel:`review? reviewer@example.com`. +reviewer\@example.com is then notified by email that +they have to check out that attachment and approve it or deny it. + +For a Bugzilla user, attachment flags show up in three places: + +#. On the list of attachments in the :guilabel:`Show Bug` + screen, you can see the current state of any flags that + have been set to ``?``, ``+``, or ``-``. You can see who asked about + the flag (the requester), and who is being asked (the + requestee). + +#. When you edit an attachment, you can + see any settable flag, along with any flags that have + already been set. The :guilabel:`Edit Attachment` + screen is where you set flags to ``?``, ``-``, ``+``, or unset them. + +#. Requests are listed in the :guilabel:`Request Queue`, which + is accessible from the :guilabel:`My Requests` link (if you are + logged in) or :guilabel:`Requests` link (if you are logged out) + visible on all pages. + +.. _flag-type-bug: + +Bug Flags +--------- + +Bug flags are used to set a status on the bug itself. You can +see Bug Flags in the :guilabel:`Show Bug` and :guilabel:`Requests` +screens, as described above. + +Only users with enough privileges (see below) may set flags on bugs. +This doesn't necessarily include the assignee, reporter, or users with the +:group:`editbugs` permission. diff --git a/docs/makedocs.pl b/docs/makedocs.pl index be5573080..a58848403 100755 --- a/docs/makedocs.pl +++ b/docs/makedocs.pl @@ -156,11 +156,12 @@ foreach my $lang (@langs) { my $dst = "$docparent/$lang/rst/api/extensions/$ext_name"; mkdir($dst) unless -d $dst; rcopy("$path/*", $dst); - next; } - my $dst = "$docparent/$lang/rst/extensions/$ext_name"; - mkdir($dst) unless -d $dst; - rcopy($path, "$dst/$file"); + else { + my $dst = "$docparent/$lang/rst/extensions/$ext_name"; + mkdir($dst) unless -d $dst; + rcopy($path, "$dst/$file"); + } } } |
