%% Generated by Sphinx.
\def\sphinxdocclass{report}
\documentclass[letterpaper,10pt,english]{sphinxmanual}
\ifdefined\pdfpxdimen
   \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen
\fi \sphinxpxdimen=.75bp\relax

\usepackage[utf8]{inputenc}
\ifdefined\DeclareUnicodeCharacter
 \ifdefined\DeclareUnicodeCharacterAsOptional
  \DeclareUnicodeCharacter{"00A0}{\nobreakspace}
  \DeclareUnicodeCharacter{"2500}{\sphinxunichar{2500}}
  \DeclareUnicodeCharacter{"2502}{\sphinxunichar{2502}}
  \DeclareUnicodeCharacter{"2514}{\sphinxunichar{2514}}
  \DeclareUnicodeCharacter{"251C}{\sphinxunichar{251C}}
  \DeclareUnicodeCharacter{"2572}{\textbackslash}
 \else
  \DeclareUnicodeCharacter{00A0}{\nobreakspace}
  \DeclareUnicodeCharacter{2500}{\sphinxunichar{2500}}
  \DeclareUnicodeCharacter{2502}{\sphinxunichar{2502}}
  \DeclareUnicodeCharacter{2514}{\sphinxunichar{2514}}
  \DeclareUnicodeCharacter{251C}{\sphinxunichar{251C}}
  \DeclareUnicodeCharacter{2572}{\textbackslash}
 \fi
\fi
\usepackage{cmap}
\usepackage[T1]{fontenc}
\usepackage{amsmath,amssymb,amstext}
\usepackage{babel}
\usepackage{times}
\usepackage[Bjarne]{fncychap}
\usepackage[dontkeepoldnames]{sphinx}

\usepackage{geometry}

% Include hyperref last.
\usepackage{hyperref}
% Fix anchor placement for figures with captions.
\usepackage{hypcap}% it must be loaded after hyperref.
% Set up styles of URL: it should be placed after hyperref.
\urlstyle{same}

\addto\captionsenglish{\renewcommand{\figurename}{Fig.}}
\addto\captionsenglish{\renewcommand{\tablename}{Table}}
\addto\captionsenglish{\renewcommand{\literalblockname}{Listing}}

\addto\captionsenglish{\renewcommand{\literalblockcontinuedname}{continued from previous page}}
\addto\captionsenglish{\renewcommand{\literalblockcontinuesname}{continues on next page}}

\addto\extrasenglish{\def\pageautorefname{page}}

\setcounter{tocdepth}{0}



\title{Bugzilla Documentation}
\date{Feb 20, 2018}
\release{5.0}
\author{The Bugzilla Team}
\newcommand{\sphinxlogo}{\vbox{}}
\renewcommand{\releasename}{Release}
\makeindex

\begin{document}

\maketitle
\sphinxtableofcontents
\phantomsection\label{\detokenize{index::doc}}



\chapter{About This Documentation}
\label{\detokenize{about/index:bugzilla-documentation}}\label{\detokenize{about/index:about}}\label{\detokenize{about/index::doc}}\label{\detokenize{about/index:about-this-documentation}}
This is the documentation for version 5.0 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
\sphinxhref{http://www.bugzilla.org/docs/}{Bugzilla website}.


\section{Evaluating Bugzilla}
\label{\detokenize{about/index:evaluating-bugzilla}}\label{\detokenize{about/index:evaluating}}
If you want to try out Bugzilla to see if it meets your needs, you can do so
on \sphinxhref{https://landfill.bugzilla.org/bugzilla-4.4-branch/}{Landfill}, our test
server. The \sphinxhref{https://wiki.mozilla.org/Bugzilla:FAQ}{Bugzilla FAQ} may also
be helpful, as it answers a number of questions people sometimes have about
whether Bugzilla is for them.


\section{Getting More Help}
\label{\detokenize{about/index:getting-help}}\label{\detokenize{about/index:getting-more-help}}
If this document does not answer your questions, we run a
\sphinxhref{https://www.mozilla.org/about/forums/\#support-bugzilla}{Mozilla forum}
which can be accessed as a newsgroup, mailing list, or over the web as a
Google Group. Please
\sphinxhref{https://groups.google.com/forum/\#!forum/mozilla.support.bugzilla}{search it}
first, and then ask your question there.

If you need a guaranteed response, commercial support is
\sphinxhref{http://www.bugzilla.org/support/consulting.html}{available} for Bugzilla
from a number of people and organizations.


\section{Document Conventions}
\label{\detokenize{about/index:document-conventions}}\label{\detokenize{about/index:conventions}}
This document uses the following conventions:

\begin{sphinxadmonition}{warning}{Warning:}
This is a warning—something you should be aware of.
\end{sphinxadmonition}

\begin{sphinxadmonition}{note}{Note:}
This is just a note, for your information.
\end{sphinxadmonition}

A filename or a path to a filename is displayed like this:
\sphinxcode{/path/to/filename.ext}

A command to type in the shell is displayed like this:
\sphinxstyleliteralstrong{command -{-}arguments}

A sample of code is illustrated like this:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{First} \PYG{n}{Line} \PYG{n}{of} \PYG{n}{Code}
\PYG{n}{Second} \PYG{n}{Line} \PYG{n}{of} \PYG{n}{Code}
\PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
\end{sphinxVerbatim}

This documentation is maintained in
\sphinxhref{http://docutils.sourceforge.net/docs/user/rst/quickstart.html}{reStructured Text} format using
the \sphinxhref{http://www.sphinx-doc.org/}{Sphinx} documentation system. It has
recently been rewritten, so it undoubtedly has bugs. Please file any you find, in
the \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla;component=Documentation}{Bugzilla 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 \DUrole{xref,std,std-ref}{Style Guide} to help you write any
new text and markup.


\section{License}
\label{\detokenize{about/index:license}}\label{\detokenize{about/index:id1}}
Bugzilla is \sphinxhref{http://www.gnu.org/philosophy/free-sw.html}{free} and
\sphinxhref{http://opensource.org/osd}{open source} 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
\sphinxhref{http://www.mozilla.org/MPL/2.0/}{Mozilla Public License 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
\sphinxhref{https://creativecommons.org/licenses/by-sa/4.0/}{Creative Commons CC-BY-SA International License 4.0},
or any later version.


\section{Credits}
\label{\detokenize{about/index:credits}}\label{\detokenize{about/index:id2}}
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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{User Guide}
\label{\detokenize{using/index:using}}\label{\detokenize{using/index::doc}}\label{\detokenize{using/index:user-guide}}

\section{Creating an Account}
\label{\detokenize{using/creating-an-account:creating-an-account}}\label{\detokenize{using/creating-an-account::doc}}\label{\detokenize{using/creating-an-account:id1}}
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
\sphinxhref{http://landfill.bugzilla.org/}{Landfill}.

The process of creating an account is similar to many other websites.
\begin{enumerate}
\item {} 
On the home page, click the \sphinxmenuselection{New Account} link in the header.
Enter your email address, then click the \sphinxcode{Send}
button.

\begin{sphinxadmonition}{note}{Note:}
If the \sphinxmenuselection{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.
\end{sphinxadmonition}

\item {} 
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.

\item {} 
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.

\item {} 
Now all you need to do is to click the \sphinxmenuselection{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 \sphinxmenuselection{Log in} button.

\end{enumerate}

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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Filing a Bug}
\label{\detokenize{using/filing:filing-a-bug}}\label{\detokenize{using/filing::doc}}\label{\detokenize{using/filing:filing}}

\subsection{Reporting a New Bug}
\label{\detokenize{using/filing:reporting-a-new-bug}}
Years of bug writing experience has been distilled for your
reading pleasure into the
\sphinxhref{http://landfill.bugzilla.org/bugzilla-tip/page.cgi?id=bug-writing.html}{Bug Writing Guidelines}.
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.

\begin{sphinxadmonition}{note}{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
\sphinxhref{http://landfill.bugzilla.org/}{Landfill}. Please don't do it on anyone's
production Bugzilla installation.
\end{sphinxadmonition}

The procedure for filing a bug is as follows:
\begin{enumerate}
\item {} 
Click the \sphinxmenuselection{New} link available in the header or footer
of pages, or the \sphinxmenuselection{File a Bug} link on the home page.

\item {} 
First, you have to select the product in which you found a bug.

\item {} 
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 \sphinxmenuselection{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).

\item {} 
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.

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}

\item {} 
As you file the bug, you can also attach a document (testcase, patch,
or screenshot of the problem).

\item {} 
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).

\item {} 
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 \sphinxmenuselection{Submit Bug} button to add your report into the database.

\end{enumerate}


\subsection{Clone an Existing Bug}
\label{\detokenize{using/filing:clone-an-existing-bug}}\label{\detokenize{using/filing:cloning-a-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 \sphinxmenuselection{Clone This Bug}
link on the bug page. This will take you to the \sphinxmenuselection{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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Understanding a Bug}
\label{\detokenize{using/understanding:understanding-a-bug}}\label{\detokenize{using/understanding::doc}}\label{\detokenize{using/understanding:understanding}}
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.
\begin{description}
\item[{\sphinxstyleemphasis{Summary:}}] \leavevmode
A one-sentence summary of the problem, displayed in the header next to
the bug number.

\item[{\sphinxstyleemphasis{Status (and Resolution):}}] \leavevmode
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.

\item[{\sphinxstyleemphasis{Alias:}}] \leavevmode
A unique short text name for the bug, which can be used instead of the
bug number.

\item[{\sphinxstyleemphasis{Product and Component}:}] \leavevmode
Bugs are divided up by Product and Component, with a Product
having one or more Components in it.

\item[{\sphinxstyleemphasis{Version:}}] \leavevmode
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.

\item[{\sphinxstyleemphasis{Hardware (Platform and OS):}}] \leavevmode
These indicate the computing environment where the bug was
found.

\item[{\sphinxstyleemphasis{Importance (Priority and Severity):}}] \leavevmode
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.

\item[{\sphinxstyleemphasis{*Target Milestone:}}] \leavevmode
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.

\item[{\sphinxstyleemphasis{Assigned To:}}] \leavevmode
The person responsible for fixing the bug.

\item[{\sphinxstyleemphasis{*QA Contact:}}] \leavevmode
The person responsible for quality assurance on this bug.

\item[{\sphinxstyleemphasis{URL:}}] \leavevmode
A URL associated with the bug, if any.

\item[{\sphinxstyleemphasis{*Whiteboard:}}] \leavevmode
A free-form text area for adding short notes and tags to a bug.

\item[{\sphinxstyleemphasis{Keywords:}}] \leavevmode
The administrator can define keywords which you can use to tag and
categorise bugs—e.g. \sphinxcode{crash} or \sphinxcode{regression}.

\item[{\sphinxstyleemphasis{Personal Tags:}}] \leavevmode
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 notifications to other users. Use them to tag and keep
track of sets of bugs that you personally care about, using your own
classification system.

\item[{\sphinxstyleemphasis{Dependencies (Depends On and Blocks):}}] \leavevmode
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 \sphinxmenuselection{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.

\item[{\sphinxstyleemphasis{Reported:}}] \leavevmode
The person who filed the bug, and the date and time they did it.

\item[{\sphinxstyleemphasis{Modified:}}] \leavevmode
The date and time the bug was last changed.

\item[{\sphinxstyleemphasis{CC List:}}] \leavevmode
A list of people who get mail when the bug changes, in addition to the
Reporter, Assignee and QA Contact (if enabled).

\item[{\sphinxstyleemphasis{Ignore Bug Mail:}}] \leavevmode
Set this if you want never to get bugmail from this bug again. See also
{\hyperref[\detokenize{using/preferences:emailpreferences}]{\sphinxcrossref{\DUrole{std,std-ref}{Email Preferences}}}}.

\item[{\sphinxstyleemphasis{*See Also:}}] \leavevmode
Bugs, in this Bugzilla, other Bugzillas, or other bug trackers, that are
related to this one.

\item[{\sphinxstyleemphasis{Flags:}}] \leavevmode
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 {\hyperref[\detokenize{using/understanding:flags}]{\sphinxcrossref{\DUrole{std,std-ref}{Flags}}}}.

\item[{\sphinxstyleemphasis{*Time Tracking:}}] \leavevmode
This form can be used for time tracking.
To use this feature, you have to be a member of the group
specified by the \DUrole{param}{timetrackinggroup} parameter. See
{\hyperref[\detokenize{using/editing:time-tracking}]{\sphinxcrossref{\DUrole{std,std-ref}{Time Tracking}}}} for more information.
\begin{description}
\item[{Orig. Est.:}] \leavevmode
This field shows the original estimated time.

\item[{Current Est.:}] \leavevmode
This field shows the current estimated time.
This number is calculated from \sphinxcode{Hours Worked}
and \sphinxcode{Hours Left}.

\item[{Hours Worked:}] \leavevmode
This field shows the number of hours worked.

\item[{Hours Left:}] \leavevmode
This field shows the \sphinxcode{Current Est.} -
\sphinxcode{Hours Worked}.
This value + \sphinxcode{Hours Worked} will become the
new Current Est.

\item[{\%Complete:}] \leavevmode
This field shows what percentage of the task is complete.

\item[{Gain:}] \leavevmode
This field shows the number of hours that the bug is ahead of the
\sphinxcode{Orig. Est.}.

\item[{Deadline:}] \leavevmode
This field shows the deadline for this bug.

\end{description}

\item[{\sphinxstyleemphasis{Attachments:}}] \leavevmode
You can attach files (e.g. test cases or patches) to bugs. If there
are any attachments, they are listed in this section. See
{\hyperref[\detokenize{using/editing:attachments}]{\sphinxcrossref{\DUrole{std,std-ref}{Attachments}}}} for more information.

\item[{\sphinxstyleemphasis{Additional Comments:}}] \leavevmode
You can add your two cents to the bug discussion here, if you have
something worthwhile to say.

\end{description}


\subsection{Flags}
\label{\detokenize{using/understanding:flags}}\label{\detokenize{using/understanding:id1}}
Flags are a way to attach a specific status to a bug or attachment,
either \sphinxcode{+} or \sphinxcode{-}. 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 \sphinxcode{?} 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 \sphinxcode{+}, it appears
as \sphinxmenuselection{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 \sphinxmenuselection{Jack: review {[} ? {]} (Jill)}.

You can browse through open requests made of you and by you by selecting
\sphinxmenuselection{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.


\subsubsection{A Simple Example}
\label{\detokenize{using/understanding:flags-simpleexample}}\label{\detokenize{using/understanding: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 \sphinxstyleemphasis{lot} of bugs,
so they decide to streamline the process. So:
\begin{enumerate}
\item {} 
The Bugzilla administrator creates a flag type called blocking2.0 for bugs
in your product. It shows up on the \sphinxmenuselection{Show Bug} screen as the text
\sphinxmenuselection{blocking2.0} with a drop-down box next to it. The drop-down box
contains four values: an empty space, \sphinxcode{?}, \sphinxcode{-}, and \sphinxcode{+}.

\item {} 
The developer sets the flag to \sphinxcode{?}.

\item {} 
The manager sees the \sphinxmenuselection{blocking2.0}
flag with a \sphinxcode{?} value.

\item {} 
If the manager thinks the feature should go into the product
before version 2.0 can be released, they set the flag to
\sphinxcode{+}. Otherwise, they set it to \sphinxcode{-}.

\item {} 
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.

\end{enumerate}


\subsubsection{About Flags}
\label{\detokenize{using/understanding:flags-about}}\label{\detokenize{using/understanding:about-flags}}
Flags can have four values:
\begin{description}
\item[{\sphinxcode{?}}] \leavevmode
A user is requesting that a status be set. (Think of it as 'A question is being asked'.)

\item[{\sphinxcode{-}}] \leavevmode
The status has been set negatively. (The question has been answered \sphinxcode{no}.)

\item[{\sphinxcode{+}}] \leavevmode
The status has been set positively.
(The question has been answered \sphinxcode{yes}.)

\item[{\sphinxcode{\_}}] \leavevmode
\sphinxcode{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.

\end{description}


\subsubsection{Flag Requests}
\label{\detokenize{using/understanding:flag-requests}}\label{\detokenize{using/understanding:flag-askto}}
If a flag has been defined as \sphinxmenuselection{requestable}, and a user has enough
privileges to request it (see below), the user can set the flag's status to
\sphinxcode{?}. This status indicates that someone (a.k.a. "the requester") is asking
someone else to set the flag to either \sphinxcode{+} or \sphinxcode{-}.

If a flag has been defined as \sphinxmenuselection{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 \sphinxstyleemphasis{not} been defined as \sphinxmenuselection{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.

\phantomsection\label{\detokenize{using/understanding:flag-types}}

\subsubsection{Attachment Flags}
\label{\detokenize{using/understanding:attachment-flags}}\label{\detokenize{using/understanding:flag-type-attachment}}\label{\detokenize{using/understanding:flag-types}}
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
\sphinxmenuselection{review} to
\sphinxmenuselection{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:
\begin{enumerate}
\item {} 
On the list of attachments in the \sphinxmenuselection{Show Bug}
screen, you can see the current state of any flags that
have been set to \sphinxcode{?}, \sphinxcode{+}, or \sphinxcode{-}. You can see who asked about
the flag (the requester), and who is being asked (the
requestee).

\item {} 
When you edit an attachment, you can
see any settable flag, along with any flags that have
already been set. The \sphinxmenuselection{Edit Attachment}
screen is where you set flags to \sphinxcode{?}, \sphinxcode{-}, \sphinxcode{+}, or unset them.

\item {} 
Requests are listed in the \sphinxmenuselection{Request Queue}, which
is accessible from the \sphinxmenuselection{My Requests} link (if you are
logged in) or \sphinxmenuselection{Requests} link (if you are logged out)
visible on all pages.

\end{enumerate}


\subsubsection{Bug Flags}
\label{\detokenize{using/understanding:flag-type-bug}}\label{\detokenize{using/understanding:bug-flags}}
Bug flags are used to set a status on the bug itself. You can
see Bug Flags in the \sphinxmenuselection{Show Bug} and \sphinxmenuselection{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
\DUrole{group}{editbugs} permission.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Editing a Bug}
\label{\detokenize{using/editing:editing}}\label{\detokenize{using/editing::doc}}\label{\detokenize{using/editing:editing-a-bug}}

\subsection{Attachments}
\label{\detokenize{using/editing:attachments}}\label{\detokenize{using/editing:id1}}
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.
\sphinxcode{\&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.


\subsection{Flags}
\label{\detokenize{using/editing:editing-flags}}\label{\detokenize{using/editing:flags}}
To set a flag, select either \sphinxmenuselection{+} or \sphinxmenuselection{-} from the drop-down
menu next to the name of the flag in the \sphinxmenuselection{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 \sphinxmenuselection{review}
\sphinxmenuselection{+} may indicate that the bug/attachment has passed review, while
setting it to \sphinxmenuselection{-} 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 \sphinxmenuselection{?} 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.


\subsection{Time Tracking}
\label{\detokenize{using/editing:time-tracking}}\label{\detokenize{using/editing:id2}}
Users who belong to the group specified by the \sphinxcode{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 \sphinxcode{Time Summary}
button or from individual bugs when clicking the \sphinxcode{Summarize time}
link in the time tracking table. The \sphinxcode{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.


\subsection{Life Cycle of a Bug}
\label{\detokenize{using/editing:life-cycle-of-a-bug}}\label{\detokenize{using/editing:lifecycle}}
The life cycle of a bug, also known as workflow, is customizable to match
the needs of your organization (see {\hyperref[\detokenize{administering/workflow:workflow}]{\sphinxcrossref{\DUrole{std,std-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
\sphinxhref{../../images/bzLifecycle.xml}{diagram file}
is available in \sphinxhref{http://www.gnome.org/projects/dia}{Dia's}
native XML format.

\noindent\sphinxincludegraphics{{bzLifecycle}.png}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Finding Bugs}
\label{\detokenize{using/finding:finding}}\label{\detokenize{using/finding::doc}}\label{\detokenize{using/finding:finding-bugs}}
Bugzilla has a number of different search options.

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}


\subsection{Quicksearch}
\label{\detokenize{using/finding:quicksearch}}\label{\detokenize{using/finding:id1}}
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
\begin{quote}

\sphinxcode{foo\textbar{}bar}
\end{quote}

into Quicksearch would search for "foo" or "bar" in the
summary and status whiteboard of a bug; adding
\begin{quote}

\sphinxcode{:BazProduct}
\end{quote}

would search only in that product.

You can also use it to go directly to a bug by entering its number or its
alias.


\subsection{Simple Search}
\label{\detokenize{using/finding: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.


\subsection{Advanced Search}
\label{\detokenize{using/finding:advanced-search}}
The Advanced Search page is used to produce a list of all bugs fitting
exact criteria. \sphinxhref{http://landfill.bugzilla.org/bugzilla-tip/query.cgi?format=advanced}{You can play with it on
Landfill}.

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 {\hyperref[\detokenize{using/preferences:saved-searches}]{\sphinxcrossref{\DUrole{std,std-ref}{Saved Searches}}}} for more details.


\subsection{Custom Search}
\label{\detokenize{using/finding:custom-search}}\label{\detokenize{using/finding:id2}}
Highly advanced querying is done using the \sphinxmenuselection{Custom Search} feature
of the \sphinxmenuselection{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 custom searches have only one term. These searches
permit the selected \sphinxstyleemphasis{field}
to be compared using a
selectable \sphinxstyleemphasis{operator} to a
specified \sphinxstyleemphasis{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 (known as a "term") of a custom search:
\begin{itemize}
\item {} 
\sphinxstyleemphasis{Field:}
the name of the field being searched

\item {} 
\sphinxstyleemphasis{Operator:}
the comparison operator

\item {} 
\sphinxstyleemphasis{Value:}
the value to which the field is being compared

\end{itemize}

The list of available \sphinxstyleemphasis{fields} contains all the fields defined for a bug,
including any custom fields, and then also some pseudofields like
\sphinxmenuselection{Assignee Real Name}, \sphinxmenuselection{Days Since Bug Changed},
\sphinxmenuselection{Time Since Assignee Touched} and other things it may be useful to
search on.

There are a wide range of \sphinxstyleemphasis{operators} available, not all of which may make
sense for a particular field. There are various string-matching operations
(including regular expressions), numerical comparisons (which also work for
dates), and also the ability to search for change information—when a field
changed, what it changed from or to, and who did it. There are special
operators for \sphinxmenuselection{is empty} and \sphinxmenuselection{is not empty}, because
Bugzilla can't tell the difference between a value field left blank on
purpose and one left blank by accident.

You can have an arbitrary number of rows, and the dropdown box above them
defines how they relate—\sphinxmenuselection{Match ALL of the following separately},
\sphinxmenuselection{Match ANY of the following separately}, or \sphinxmenuselection{Match ALL of
the following against the same field}. The difference between the first and
the third can be illustrated with a comment search. If you have a search:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Comment}   \PYG{n}{contains} \PYG{n}{the} \PYG{n}{string}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{Fred}\PYG{l+s+s2}{\PYGZdq{}}
\PYG{n}{Comment}   \PYG{n}{contains} \PYG{n}{the} \PYG{n}{string}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{Barney}\PYG{l+s+s2}{\PYGZdq{}}
\end{sphinxVerbatim}

then under the first regime (match separately) the search would return bugs
where "Fred" appeared in one comment and "Barney" in the same or any other
comment, whereas under the second (match against the same field), both strings
would need to occur in exactly the same comment.


\subsubsection{Advanced Features}
\label{\detokenize{using/finding:id3}}\label{\detokenize{using/finding:advanced-features}}
If you click \sphinxmenuselection{Show Advanced Features}, then more capabilities appear.
You can negate any row with a checkbox (see below) and also group lines of the
search with parentheses to determine how different search terms relate. Within
each bracketed set, you get the choice of combining them using ALL (i.e. AND)
or ANY (i.e. OR).


\subsubsection{Negation}
\label{\detokenize{using/finding:negation}}
At first glance, negation seems redundant. Rather than
searching for:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{NOT} \PYG{p}{(} \PYG{n}{summary}   \PYG{n}{contains} \PYG{n}{the} \PYG{n}{string}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{foo}\PYG{l+s+s2}{\PYGZdq{}} \PYG{p}{)}
\end{sphinxVerbatim}

one could search for:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{summary}   \PYG{n}{does} \PYG{o+ow}{not} \PYG{n}{contain} \PYG{n}{the} \PYG{n}{string}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{foo}\PYG{l+s+s2}{\PYGZdq{}}
\end{sphinxVerbatim}

However, the search:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{CC}   \PYG{n}{does} \PYG{o+ow}{not} \PYG{n}{contain} \PYG{n}{the} \PYG{n}{string}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{@mozilla.org}\PYG{l+s+s2}{\PYGZdq{}}
\end{sphinxVerbatim}

would find every bug where anyone on the CC list did not contain
"@mozilla.org" while:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{NOT} \PYG{p}{(} \PYG{n}{CC}   \PYG{n}{contains} \PYG{n}{the} \PYG{n}{string}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{@mozilla.org}\PYG{l+s+s2}{\PYGZdq{}} \PYG{p}{)}
\end{sphinxVerbatim}

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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{NOT} \PYG{p}{(} \PYG{p}{(} \PYG{n}{product}   \PYG{n}{equals}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{Update}\PYG{l+s+s2}{\PYGZdq{}} \PYG{p}{)}
      \PYG{n}{OR}
      \PYG{p}{(} \PYG{n}{component}   \PYG{n}{equals}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{Documentation}\PYG{l+s+s2}{\PYGZdq{}} \PYG{p}{)}
    \PYG{p}{)}
\end{sphinxVerbatim}

to find bugs that are neither
in the \sphinxmenuselection{Update} product or in the \sphinxmenuselection{Documentation} component
or:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{NOT} \PYG{p}{(} \PYG{p}{(} \PYG{n}{commenter}   \PYG{n}{equals}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{\PYGZpc{}}\PYG{l+s+s2}{assignee}\PYG{l+s+s2}{\PYGZpc{}}\PYG{l+s+s2}{\PYGZdq{}} \PYG{p}{)}
      \PYG{n}{OR}
      \PYG{p}{(}\PYG{n}{component}   \PYG{n}{equals}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{Documentation}\PYG{l+s+s2}{\PYGZdq{}} \PYG{p}{)}
    \PYG{p}{)}
\end{sphinxVerbatim}

to find non-documentation bugs on which the assignee has never commented.


\subsubsection{Pronoun Substitution}
\label{\detokenize{using/finding:pronouns}}\label{\detokenize{using/finding:pronoun-substitution}}
Sometimes, a query needs to compare a user-related field
(such as \sphinxmenuselection{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 that are assigned to the person
who reported them.

When the \sphinxmenuselection{Custom Search} operator is either \sphinxmenuselection{equals} or
\sphinxmenuselection{notequals}, the value can be "\%reporter\%", "\%assignee\%",
"\%qacontact\%", or "\%user\%". These are known as "pronouns". 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.

This feature also lets you search by a user's group memberships. If the
operator is either \sphinxmenuselection{equals}, \sphinxmenuselection{notequals} or
\sphinxmenuselection{anyexact}, you can search for
whether a user belongs (or not) to the specified group. The group name must be
entered using "\%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 use:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{reporter}   \PYG{n}{equals}   \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+si}{\PYGZpc{}g}\PYG{l+s+s2}{roup.editbugs}\PYG{l+s+s2}{\PYGZpc{}}\PYG{l+s+s2}{\PYGZdq{}}
\end{sphinxVerbatim}


\subsection{Bug Lists}
\label{\detokenize{using/finding:bug-lists}}\label{\detokenize{using/finding:list}}
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:
\begin{description}
\item[{Long Format:}] \leavevmode
this gives you a large page with a non-editable summary of the fields
of each bug.

\item[{XML (icon):}] \leavevmode
get the buglist in an XML format.

\item[{CSV (icon):}] \leavevmode
get the buglist as comma-separated values, for import into e.g.
a spreadsheet.

\item[{Feed (icon):}] \leavevmode
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.

\item[{iCalendar (icon):}] \leavevmode
Get the buglist as an iCalendar file. Each bug is represented as a
to-do item in the imported calendar.

\item[{Change Columns:}] \leavevmode
change the bug attributes which appear in the list.

\item[{Change Several Bugs At Once:}] \leavevmode
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.

\item[{Send Mail to Bug Assignees:}] \leavevmode
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.

\item[{Edit Search:}] \leavevmode
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.

\item[{Remember Search As:}] \leavevmode
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.

\end{description}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Reports and Charts}
\label{\detokenize{using/reports-and-charts:id1}}\label{\detokenize{using/reports-and-charts::doc}}\label{\detokenize{using/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).


\subsection{Reports}
\label{\detokenize{using/reports-and-charts:id2}}\label{\detokenize{using/reports-and-charts: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 \sphinxmenuselection{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.


\subsection{Charts}
\label{\detokenize{using/reports-and-charts:charts}}\label{\detokenize{using/reports-and-charts:id3}}
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.

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}

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 \sphinxmenuselection{Category} and Component names as \sphinxmenuselection{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 \sphinxmenuselection{Category} be your username.


\subsubsection{Creating Charts}
\label{\detokenize{using/reports-and-charts:creating-charts}}
You create a chart by selecting a number of data sets from the
list and pressing \sphinxmenuselection{Add To List} for each. In the
\sphinxmenuselection{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 \sphinxmenuselection{Sum}
a number of data sets (e.g. you could \sphinxmenuselection{Sum} data sets representing
\sphinxmenuselection{RESOLVED}, \sphinxmenuselection{VERIFIED} and \sphinxmenuselection{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 \sphinxmenuselection{Remove}. Once you add more than one
data set, a \sphinxmenuselection{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 \sphinxmenuselection{Chart This List} to see the chart.


\subsubsection{Creating New Data Sets}
\label{\detokenize{using/reports-and-charts:charts-new-series}}\label{\detokenize{using/reports-and-charts:creating-new-data-sets}}
You may also create new data sets of your own. To do this,
click the \sphinxmenuselection{create a new data set} link on the
\sphinxmenuselection{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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Pro Tips}
\label{\detokenize{using/tips:pro-tips}}\label{\detokenize{using/tips::doc}}\label{\detokenize{using/tips:id1}}
This section distills some Bugzilla tips and best practices
that have been developed.


\subsection{Autolinkification}
\label{\detokenize{using/tips:autolinkification}}
Bugzilla comments are plain text - so typing \textless{}U\textgreater{} 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
\sphinxcode{http://www.bugzilla.org} will be turned into a link:
\sphinxurl{http://www.bugzilla.org}.
Other strings which get linkified in the obvious manner are:
\begin{itemize}
\item {} 
bug 12345

\item {} 
bugs 123, 456, 789

\item {} 
comment 7

\item {} 
comments 1, 2, 3, 4

\item {} 
bug 23456, comment 53

\item {} 
attachment 4321

\item {} 
mailto:george@example.com

\item {} 
george@example.com

\item {} 
ftp://ftp.mozilla.org

\item {} 
Most other sorts of URL

\end{itemize}

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.


\subsection{Comments}
\label{\detokenize{using/tips:commenting}}\label{\detokenize{using/tips: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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{User Preferences}
\label{\detokenize{using/preferences:user-preferences}}\label{\detokenize{using/preferences::doc}}\label{\detokenize{using/preferences:id1}}
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.


\subsection{General Preferences}
\label{\detokenize{using/preferences:general-preferences}}\label{\detokenize{using/preferences:generalpreferences}}
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.


\subsection{Email Preferences}
\label{\detokenize{using/preferences:email-preferences}}\label{\detokenize{using/preferences:emailpreferences}}
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 \sphinxcode{Enable All
Mail} button. If you don't want to receive any email from
Bugzilla at all, click the \sphinxcode{Disable All Mail} button.

\begin{sphinxadmonition}{note}{Note:}
A Bugzilla administrator can stop a user from receiving
bugmail by clicking the \sphinxcode{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.
\end{sphinxadmonition}

There are two global options -- \sphinxcode{Email me when someone
asks me to set a flag} and \sphinxcode{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
\sphinxcode{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 \sphinxcode{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 \sphinxcode{Reporter} column
except for the one on the \sphinxcode{The bug is resolved or
verified} row.

\begin{sphinxadmonition}{note}{Note:}
Bugzilla adds the \sphinxcode{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.
\end{sphinxadmonition}

Bugzilla has a feature called \sphinxcode{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 \sphinxcode{Users watching you} field
has you listed in their \sphinxcode{Users to watch} list
and can get bugmail according to your relationship to the bug and
their \sphinxcode{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.


\subsection{Saved Searches}
\label{\detokenize{using/preferences:saved-searches}}\label{\detokenize{using/preferences:id2}}
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 \DUrole{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
{\hyperref[\detokenize{administering/groups:groups}]{\sphinxcrossref{\DUrole{std,std-ref}{assign users to}}}}, the sharer may opt to have
the Search show up in the footer of the group's direct members by default.


\subsection{Account Information}
\label{\detokenize{using/preferences:account-information}}\label{\detokenize{using/preferences:id3}}
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
\sphinxstyleemphasis{current} password into the \sphinxcode{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.


\subsection{API Keys}
\label{\detokenize{using/preferences:id4}}\label{\detokenize{using/preferences: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.


\subsection{Permissions}
\label{\detokenize{using/preferences:id5}}\label{\detokenize{using/preferences: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
\sphinxstyleemphasis{editusers} privileges can change the permissions of other users.
\begin{description}
\item[{admin}] \leavevmode
Indicates user is an Administrator.

\item[{bz\_canusewhineatothers}] \leavevmode
Indicates user can configure whine reports for other users.

\item[{bz\_canusewhines}] \leavevmode
Indicates user can configure whine reports for self.

\item[{bz\_quip\_moderators}] \leavevmode
Indicates user can moderate quips.

\item[{bz\_sudoers}] \leavevmode
Indicates user can perform actions as other users.

\item[{bz\_sudo\_protect}] \leavevmode
Indicates user cannot be impersonated by other users.

\item[{canconfirm}] \leavevmode
Indicates user can confirm a bug or mark it a duplicate.

\item[{creategroups}] \leavevmode
Indicates user can create and destroy groups.

\item[{editbugs}] \leavevmode
Indicates user can edit all bug fields.

\item[{editclassifications}] \leavevmode
Indicates user can create, destroy and edit classifications.

\item[{editcomponents}] \leavevmode
Indicates user can create, destroy and edit products, components,
versions, milestones and flag types.

\item[{editkeywords}] \leavevmode
Indicates user can create, destroy and edit keywords.

\item[{editusers}] \leavevmode
Indicates user can create, disable and edit users.

\item[{tweakparams}] \leavevmode
Indicates user can change {\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-ref}{Parameters}}}}.

\end{description}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Installed Extensions}
\label{\detokenize{using/extensions::doc}}\label{\detokenize{using/extensions:installed-extensions}}\label{\detokenize{using/extensions:installed-extensions-user}}
Bugzilla can be enhanced using extensions (see {\hyperref[\detokenize{integrating/extensions:extensions}]{\sphinxcrossref{\DUrole{std,std-ref}{Extensions}}}}). If an
extension comes with documentation in the appropriate format, and you build
your own copy of the Bugzilla documentation using \sphinxcode{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):


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{Installation and Maintenance Guide}
\label{\detokenize{installing/index::doc}}\label{\detokenize{installing/index:installing}}\label{\detokenize{installing/index:installation-and-maintenance-guide}}
\begin{sphinxadmonition}{note}{Note:}
If you just want to \sphinxstyleemphasis{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 {\hyperref[\detokenize{using/index:using}]{\sphinxcrossref{\DUrole{std,std-ref}{User Guide}}}}.
\end{sphinxadmonition}

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 {\hyperref[\detokenize{installing/quick-start:quick-start}]{\sphinxcrossref{\DUrole{std,std-ref}{Quick Start instructions}}}}.


\section{Quick Start (Ubuntu Linux 14.04)}
\label{\detokenize{installing/quick-start:quick-start}}\label{\detokenize{installing/quick-start::doc}}\label{\detokenize{installing/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.


\subsection{Obtain Your Hardware}
\label{\detokenize{installing/quick-start: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.


\subsection{Install the OS}
\label{\detokenize{installing/quick-start:install-the-os}}
Get \sphinxhref{http://www.ubuntu.com/download/server}{Ubuntu Server 14.04 LTS}
and follow the \sphinxhref{http://www.ubuntu.com/download/server/install-ubuntu-server}{installation instructions}.
Here are some tips:
\begin{itemize}
\item {} 
Choose any server name you like.

\item {} 
When creating the initial Linux user, call it \sphinxcode{bugzilla}, give it a
strong password, and write that password down.

\item {} 
You do not need an encrypted home directory.

\item {} 
Choose all the defaults for the "partitioning" part (excepting of course
where the default is "No" and you need to press "Yes" to continue).

\item {} 
Choose "install security updates automatically" unless you want to do
them manually.

\item {} 
From the install options, choose "OpenSSH Server" and "LAMP Server".

\item {} 
Set the password for the MySQL root user to a strong password, and write
that password down.

\item {} 
Install the Grub boot loader to the Master Boot Record.

\end{itemize}

Reboot when the installer finishes.


\subsection{Become root}
\label{\detokenize{installing/quick-start:become-root}}
ssh to the machine as the 'bugzilla' user, or start a console. Then:

\sphinxstyleliteralstrong{sudo su}


\subsection{Install Prerequisites}
\label{\detokenize{installing/quick-start:install-prerequisites}}
\sphinxstyleliteralstrong{apt-get install git nano}

\sphinxstyleliteralstrong{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 python-sphinx}

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
\sphinxstyleliteralstrong{sudo su} again.


\subsection{Download Bugzilla}
\label{\detokenize{installing/quick-start:download-bugzilla}}
Get it from our Git repository:

\sphinxstyleliteralstrong{cd /var/www}

\sphinxstyleliteralstrong{rm -rf html}

\sphinxstyleliteralstrong{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)

\sphinxstyleliteralstrong{cd html}


\subsection{Configure MySQL}
\label{\detokenize{installing/quick-start:configure-mysql}}
The following instructions use the simple \sphinxcode{nano} editor, but feel
free to use any text editor you are comfortable with.

\sphinxstyleliteralstrong{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:
\begin{itemize}
\item {} 
Alter on Line 52: \sphinxcode{max\_allowed\_packet=100M}

\item {} 
Add as new line 31, in the \sphinxcode{{[}mysqld{]}} section: \sphinxcode{ft\_min\_word\_len=2}

\end{itemize}

Save and exit.

Then, add a user to MySQL for Bugzilla to use:

\sphinxstyleliteralstrong{mysql -u root -p -e "GRANT ALL PRIVILEGES ON bugs.* TO bugs@localhost IDENTIFIED BY '\$db\_pass'"}

Replace \sphinxcode{\$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 \sphinxcode{\$db\_pass}
different to that password.

Restart MySQL:

\sphinxstyleliteralstrong{service mysql restart}


\subsection{Configure Apache}
\label{\detokenize{installing/quick-start:configure-apache}}
\sphinxstyleliteralstrong{nano /etc/apache2/sites-available/bugzilla.conf}

Paste in the following and save:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nb}{ServerName} localhost

\PYG{n+nt}{\PYGZlt{}Directory} \PYG{l+s}{/var/www/html}\PYG{n+nt}{\PYGZgt{}}
  \PYG{n+nb}{AddHandler} cgi\PYGZhy{}script .cgi
  \PYG{n+nb}{Options} +ExecCGI
  \PYG{n+nb}{DirectoryIndex} index.cgi index.html
  \PYG{n+nb}{AllowOverride} Limit FileInfo Indexes Options
\PYG{n+nt}{\PYGZlt{}/Directory}\PYG{n+nt}{\PYGZgt{}}
\end{sphinxVerbatim}

\sphinxstyleliteralstrong{a2ensite bugzilla}

\sphinxstyleliteralstrong{a2enmod cgi headers expires}

\sphinxstyleliteralstrong{service apache2 restart}


\subsection{Check Setup}
\label{\detokenize{installing/quick-start:check-setup}}
Bugzilla comes with a \sphinxcode{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 \sphinxcode{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.

\sphinxstyleliteralstrong{cd /var/www/html}

\sphinxstyleliteralstrong{./checksetup.pl}


\subsection{Edit \sphinxstyleliteralintitle{localconfig}}
\label{\detokenize{installing/quick-start:edit-localconfig}}
\sphinxstyleliteralstrong{nano localconfig}

You will need to set the following values:
\begin{itemize}
\item {} 
Line 29: set \sphinxcode{\$webservergroup} to \sphinxcode{www-data}

\item {} 
Line 67: set \sphinxcode{\$db\_pass} to the password for the \sphinxcode{bugs} user you created
in MySQL a few steps ago

\end{itemize}


\subsection{Check Setup (again)}
\label{\detokenize{installing/quick-start:check-setup-again}}
Run the \sphinxcode{checksetup.pl} script again to set up the database.

\sphinxstyleliteralstrong{./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.


\subsection{Test Server}
\label{\detokenize{installing/quick-start:test-server}}
\sphinxstyleliteralstrong{./testserver.pl http://localhost/}

All the tests should pass. You will get warnings about deprecation from
the \sphinxcode{Chart::Base} Perl module; just ignore those.


\subsection{Access Via Web Browser}
\label{\detokenize{installing/quick-start:index-0}}\label{\detokenize{installing/quick-start:access-via-web-browser}}
Access the front page:

\sphinxstyleliteralstrong{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 \sphinxcode{http://\textless{}ip address\textgreater{}/}, where \sphinxcode{\textless{}ip address\textgreater{}} is (unless you have
a complex network setup) the "inet addr" value displayed when you run
\sphinxstyleliteralstrong{ifconfig eth0}.


\subsection{Configure Bugzilla}
\label{\detokenize{installing/quick-start:configure-bugzilla}}
Once you have worked out how to access your Bugzilla in a graphical
web browser, bring up the front page, click \sphinxmenuselection{Log In} in the
header, and log in as the admin user you defined in step 10.

Click the \sphinxmenuselection{Parameters} link on the page it gives you, and set
the following parameters in the \sphinxmenuselection{Required Settings} section:
\begin{itemize}
\item {} 
\DUrole{param}{urlbase}:
\DUrole{paramval}{http://\textless{}servername\textgreater{}/} or \DUrole{paramval}{http://\textless{}ip address\textgreater{}/}

\end{itemize}

Click \sphinxmenuselection{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
\sphinxurl{https://gmail.com} and create a new Gmail account for your Bugzilla to use.
Then, open the \sphinxmenuselection{Email} section of the Parameters using the link
in the left column, and set the following parameter values:
\begin{itemize}
\item {} 
\DUrole{param}{mail\_delivery\_method}: \DUrole{paramval}{SMTP}

\item {} 
\DUrole{param}{mailfrom}: \DUrole{paramval}{new\_gmail\_address@gmail.com}

\item {} 
\DUrole{param}{smtpserver}: \DUrole{paramval}{smtp.gmail.com:465}

\item {} 
\DUrole{param}{smtp\_username}: \DUrole{paramval}{new\_gmail\_address@gmail.com}

\item {} 
\DUrole{param}{smtp\_password}: \DUrole{paramval}{new\_gmail\_password}

\item {} 
\DUrole{param}{smtp\_ssl}: \DUrole{paramval}{On}

\end{itemize}

Click \sphinxmenuselection{Save Changes} at the bottom of the page.

And you're all ready to go. :-)


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Linux}
\label{\detokenize{installing/linux:id1}}\label{\detokenize{installing/linux::doc}}\label{\detokenize{installing/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, {\hyperref[\detokenize{installing/quick-start:quick-start}]{\sphinxcrossref{\DUrole{std,std-ref}{Quick Start (Ubuntu Linux 14.04)}}}} may be
the best instructions for you.


\subsection{Install Packages}
\label{\detokenize{installing/linux:install-packages}}\label{\detokenize{installing/linux:linux-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.


\subsubsection{Fedora and Red Hat}
\label{\detokenize{installing/linux:fedora-and-red-hat}}
The following command will install Red Hat's packaged version of Bugzilla:

\sphinxstyleliteralstrong{yum install bugzilla httpd mysql-server}

However, if you go this route, you need to read \sphinxhref{https://bugzilla.mozilla.org/show\_bug.cgi?id=415605}{bug  415605}, which details
some problems with the Email::Send package. Then, you can skip to
{\hyperref[\detokenize{installing/linux:linux-config-database}]{\sphinxcrossref{\DUrole{std,std-ref}{configuring your database}}}}. It may be useful to
know that Fedora stores the Bugzilla files in \sphinxcode{/usr/share/bugzilla}, so
that's where you'll run \sphinxcode{checksetup.pl}.

If you want to install a version of Bugzilla from the Bugzilla project, you
will instead need:

\sphinxstyleliteralstrong{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.


\subsubsection{Ubuntu and Debian}
\label{\detokenize{installing/linux:ubuntu-and-debian}}
\sphinxstyleliteralstrong{apt-get install git nano}

\sphinxstyleliteralstrong{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 python-sphinx}

If you plan to use SQlite as your database, you will need to also install
the appropriate packages for that.


\subsubsection{Gentoo}
\label{\detokenize{installing/linux:gentoo}}
\sphinxstyleliteralstrong{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 \sphinxcode{/var/www/localhost/bugzilla}.

Then, you can skip to {\hyperref[\detokenize{installing/linux:linux-config-database}]{\sphinxcrossref{\DUrole{std,std-ref}{configuring your database}}}}.


\subsection{Perl}
\label{\detokenize{installing/linux:linux-install-perl}}\label{\detokenize{installing/linux:perl}}
Test which version of Perl you have installed with:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYGZdl{} perl \PYGZhy{}v
\end{sphinxVerbatim}

Bugzilla requires at least Perl 5.10.1.


\subsection{Bugzilla}
\label{\detokenize{installing/linux:bugzilla}}\label{\detokenize{installing/linux:linux-install-bzfiles}}
The best way to get Bugzilla is to check it out from git:

\sphinxstyleliteralstrong{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
\sphinxhref{http://www.bugzilla.org/download/}{download a tarball of Bugzilla}.

Place Bugzilla in a suitable directory, accessible by the default web server
user (probably \sphinxcode{apache} or \sphinxcode{www-data}).
Good locations are either directly in the web server's document directory
(often \sphinxcode{/var/www/html}) or in \sphinxcode{/usr/local}, either with a
symbolic link to the web server's document directory or an alias in the web
server's configuration.

\begin{sphinxadmonition}{warning}{Warning:}
The default Bugzilla distribution is NOT designed to be placed
in a \sphinxcode{cgi-bin} directory. This
includes any directory which is configured using the
\sphinxcode{ScriptAlias} directive of Apache.
\end{sphinxadmonition}


\subsection{Perl Modules}
\label{\detokenize{installing/linux:perl-modules}}\label{\detokenize{installing/linux:linux-install-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 \sphinxcode{root}, e.g. by using
\sphinxstyleliteralstrong{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:

\sphinxstyleliteralstrong{./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:

\sphinxstyleliteralstrong{./install-module.pl -{-}all}

Or, you can pass an individual module name:

\sphinxstyleliteralstrong{./install-module.pl \textless{}modulename\textgreater{}}

\begin{sphinxadmonition}{note}{Note:}
If you are using a package-based distribution, and attempting to
install the Perl modules from CPAN (e.g. by using \sphinxcode{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 \sphinxcode{\textless{}packagename\textgreater{}-devel}.
\end{sphinxadmonition}


\subsection{Web Server}
\label{\detokenize{installing/linux:web-server}}\label{\detokenize{installing/linux:linux-config-webserver}}
Any web server that is capable of running CGI scripts can be made to work.
We have specific configuration instructions for the following:
\begin{itemize}
\item {} 
{\hyperref[\detokenize{installing/apache:apache}]{\sphinxcrossref{\DUrole{std,std-ref}{Apache}}}}

\end{itemize}


\subsection{Database Engine}
\label{\detokenize{installing/linux:linux-config-database}}\label{\detokenize{installing/linux: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:
\begin{itemize}
\item {} 
{\hyperref[\detokenize{installing/mysql:mysql}]{\sphinxcrossref{\DUrole{std,std-ref}{MySQL}}}}

\item {} 
{\hyperref[\detokenize{installing/postgresql:postgresql}]{\sphinxcrossref{\DUrole{std,std-ref}{PostgreSQL}}}}

\item {} 
{\hyperref[\detokenize{installing/oracle:oracle}]{\sphinxcrossref{\DUrole{std,std-ref}{Oracle}}}}

\item {} 
{\hyperref[\detokenize{installing/sqlite:sqlite}]{\sphinxcrossref{\DUrole{std,std-ref}{SQLite}}}}

\end{itemize}


\subsection{localconfig}
\label{\detokenize{installing/linux:localconfig}}
You should now change into the Bugzilla directory and run
\sphinxcode{checksetup.pl}, without any parameters:

\sphinxstyleliteralstrong{./checksetup.pl}

\sphinxcode{checksetup.pl} will write out a file called \sphinxcode{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 \sphinxcode{\$db\_driver}
and \sphinxcode{\$db\_pass}, which are respectively the type of the database you are
using and the password for the \sphinxcode{bugs} database user you have created.
\sphinxcode{\$db\_driver} can be either \sphinxcode{mysql}, \sphinxcode{Pg} (PostgreSQL), \sphinxcode{Oracle} or
\sphinxcode{Sqlite}. All values are case sensitive.

Set the value of \sphinxcode{\$webservergroup} to the group your web server runs as.
\begin{itemize}
\item {} 
Fedora/Red Hat: \sphinxcode{apache}

\item {} 
Debian/Ubuntu: \sphinxcode{www-data}

\item {} 
Mac OS X: \sphinxcode{\_www}

\item {} 
Windows: ignore this setting; it does nothing

\end{itemize}

The other options in the \sphinxcode{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 \sphinxcode{\$db\_*} parameters.

\begin{sphinxadmonition}{note}{Note:}
If you are using Oracle, \sphinxcode{\$db\_name} should be set to
the SID name of your database (e.g. \sphinxcode{XE} if you are using Oracle XE).
\end{sphinxadmonition}


\subsection{checksetup.pl}
\label{\detokenize{installing/linux:checksetup-pl}}
Next, run \sphinxcode{checksetup.pl} an additional time:

\sphinxstyleliteralstrong{./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 \sphinxcode{bugs}
user you created and the password you defined, and creates the
\sphinxcode{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.

\sphinxcode{checksetup.pl} will then finish. You may rerun
\sphinxcode{checksetup.pl} at any time if you wish.


\subsection{Success}
\label{\detokenize{installing/linux:success}}
Your Bugzilla should now be working. Check by running:

\sphinxstyleliteralstrong{./testserver.pl http://\textless{}your-bugzilla-server\textgreater{}/}

If that passes, access \sphinxcode{http://\textless{}your-bugzilla-server\textgreater{}/} 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.

Next, do the {\hyperref[\detokenize{installing/essential-post-install-config:essential-post-install-config}]{\sphinxcrossref{\DUrole{std,std-ref}{Essential Post-Installation Configuration}}}}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Windows}
\label{\detokenize{installing/windows:windows}}\label{\detokenize{installing/windows::doc}}\label{\detokenize{installing/windows:id1}}
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.


\subsection{ActiveState Perl}
\label{\detokenize{installing/windows:activestate-perl}}
ActiveState make a popular distribution of Perl for Windows.

Download the ActiveState Perl 5.12.4 or higher MSI installer from the
\sphinxhref{http://www.activestate.com/activeperl/downloads}{ActiveState website}.

ActiveState Perl uses a standard Windows Installer. Install, sticking with
the defaults, which will install Perl into \sphinxcode{C:\textbackslash{}Perl}. It is not
recommended to install Perl into a directory containing a space, such as
\sphinxcode{C:\textbackslash{}Program Files}.

Once the install has completed, log out and log in again to pick up the
changes to the \sphinxcode{PATH} environment variable.


\subsection{Bugzilla}
\label{\detokenize{installing/windows:bugzilla}}\label{\detokenize{installing/windows:windows-install-bzfiles}}
The best way to get Bugzilla is to check it out from git. Download and install
git from the \sphinxhref{http://git-scm.com/download}{git website}, and then run:

\sphinxstyleliteralstrong{git clone -{-}branch bugzilla-X.X-stable https://git.mozilla.org/bugzilla/bugzilla C:\textbackslash{}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
\sphinxcode{C:\textbackslash{}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
\sphinxhref{http://www.bugzilla.org/download/}{download a tarball of Bugzilla} and
copy it across. Bugzilla comes as a 'tarball' (\sphinxcode{.tar.gz} extension),
which any competent Windows archiving tool should be able to open.


\subsection{Perl Modules}
\label{\detokenize{installing/windows:perl-modules}}
Bugzilla requires a number of perl modules to be installed. They are
available in the ActiveState repository, and are installed with the
\sphinxcode{ppm} tool. You can either use it on the command line, as below,
or just type \sphinxstyleliteralstrong{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
\sphinxhref{http://aspn.activestate.com/ASPN/docs/ActivePerl/faq/ActivePerl-faq2.html\#ppm\_and\_proxies}{ActivePerl FAQ}.

Install the following modules with:

\sphinxstyleliteralstrong{ppm install \textless{}modulename\textgreater{}}
\begin{itemize}
\item {} 
CGI.pm

\item {} 
Digest-SHA

\item {} 
TimeDate

\item {} 
DateTime

\item {} 
DateTime-TimeZone

\item {} 
DBI

\item {} 
Template-Toolkit

\item {} 
Email-Sender

\item {} 
Email-MIME

\item {} 
URI

\item {} 
List-MoreUtils

\item {} 
Math-Random-ISAAC

\item {} 
File-Slurp

\item {} 
JSON-XS

\item {} 
Win32

\item {} 
Win32-API

\end{itemize}

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:
\begin{itemize}
\item {} 
GD

\item {} 
Chart

\item {} 
Template-GD

\item {} 
GDTextUtil

\item {} 
GDGraph

\item {} 
MIME-tools

\item {} 
libwww-perl

\item {} 
XML-Twig

\item {} 
PatchReader

\item {} 
perl-ldap

\item {} 
Authen-SASL

\item {} 
Net-SMTP-SSL

\item {} 
RadiusPerl

\item {} 
SOAP-Lite

\item {} 
XMLRPC-Lite

\item {} 
JSON-RPC

\item {} 
Test-Taint

\item {} 
HTML-Parser

\item {} 
HTML-Scrubber

\item {} 
Encode

\item {} 
Encode-Detect

\item {} 
Email-Reply

\item {} 
HTML-FormatText-WithLinks

\item {} 
TheSchwartz

\item {} 
Daemon-Generic

\item {} 
mod\_perl

\item {} 
Apache-SizeLimit

\item {} 
File-MimeInfo

\item {} 
IO-stringy

\item {} 
Cache-Memcached

\item {} 
File-Copy-Recursive

\item {} 
GraphViz

\end{itemize}

\begin{sphinxadmonition}{warning}{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.
\end{sphinxadmonition}

\begin{sphinxadmonition}{note}{Note:}
The \sphinxcode{install-module.pl} script doesn't work with ActivePerl
on Windows.
\end{sphinxadmonition}


\subsection{Web Server}
\label{\detokenize{installing/windows:web-server}}\label{\detokenize{installing/windows:windows-config-webserver}}
Any web server that is capable of running CGI scripts can be made to work.
We have specific instructions for the following:
\begin{itemize}
\item {} 
{\hyperref[\detokenize{installing/apache-windows:apache-windows}]{\sphinxcrossref{\DUrole{std,std-ref}{Apache}}}}

\item {} 
{\hyperref[\detokenize{installing/iis:iis}]{\sphinxcrossref{\DUrole{std,std-ref}{Microsoft IIS}}}}

\end{itemize}


\subsection{Database Engine}
\label{\detokenize{installing/windows: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:
\begin{itemize}
\item {} 
{\hyperref[\detokenize{installing/mysql:mysql}]{\sphinxcrossref{\DUrole{std,std-ref}{MySQL}}}}

\item {} 
{\hyperref[\detokenize{installing/postgresql:postgresql}]{\sphinxcrossref{\DUrole{std,std-ref}{PostgreSQL}}}}

\item {} 
{\hyperref[\detokenize{installing/oracle:oracle}]{\sphinxcrossref{\DUrole{std,std-ref}{Oracle}}}}

\item {} 
{\hyperref[\detokenize{installing/sqlite:sqlite}]{\sphinxcrossref{\DUrole{std,std-ref}{SQLite}}}}

\end{itemize}


\subsection{localconfig}
\label{\detokenize{installing/windows:localconfig}}
You should now change into the Bugzilla directory and run
\sphinxcode{checksetup.pl}, without any parameters:

\sphinxstyleliteralstrong{checksetup.pl}

\sphinxcode{checksetup.pl} will write out a file called \sphinxcode{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 \sphinxcode{\$db\_driver}
and \sphinxcode{\$db\_pass}, which are respectively the type of the database you are
using and the password for the \sphinxcode{bugs} database user you have created.
\sphinxcode{\$db\_driver} can be either \sphinxcode{mysql}, \sphinxcode{Pg} (PostgreSQL), \sphinxcode{Oracle} or
\sphinxcode{Sqlite}. All values are case sensitive.

Set the value of \sphinxcode{\$webservergroup} to the group your web server runs as.
\begin{itemize}
\item {} 
Fedora/Red Hat: \sphinxcode{apache}

\item {} 
Debian/Ubuntu: \sphinxcode{www-data}

\item {} 
Mac OS X: \sphinxcode{\_www}

\item {} 
Windows: ignore this setting; it does nothing

\end{itemize}

The other options in the \sphinxcode{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 \sphinxcode{\$db\_*} parameters.

\begin{sphinxadmonition}{note}{Note:}
If you are using Oracle, \sphinxcode{\$db\_name} should be set to
the SID name of your database (e.g. \sphinxcode{XE} if you are using Oracle XE).
\end{sphinxadmonition}


\subsection{checksetup.pl}
\label{\detokenize{installing/windows:checksetup-pl}}
Next, run \sphinxcode{checksetup.pl} an additional time:

\sphinxstyleliteralstrong{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 \sphinxcode{bugs}
user you created and the password you defined, and creates the
\sphinxcode{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.

\sphinxcode{checksetup.pl} will then finish. You may rerun
\sphinxcode{checksetup.pl} at any time if you wish.


\subsection{Success}
\label{\detokenize{installing/windows:success}}
Your Bugzilla should now be working. Check by running:

\sphinxstyleliteralstrong{testserver.pl http://\textless{}your-bugzilla-server\textgreater{}/}

If that passes, access \sphinxcode{http://\textless{}your-bugzilla-server\textgreater{}/} 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.

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
\sphinxcode{httpd.conf}. If you are on Windows 7 or later, this could be due to a
new feature called "VirtualStore". \sphinxhref{http://blog.netscraps.com/bugs/apache-httpd-conf-changes-ignored-in-windows-7.html}{This blog post}
may help to solve the problem.

If you get an "Internal Error..." message, it could be that
\sphinxcode{ScriptInterpreterSource Registry-Strict} is not set in your
{\hyperref[\detokenize{installing/apache-windows:apache-windows}]{\sphinxcrossref{\DUrole{std,std-ref}{Apache configuration}}}}. Check again if it is set
properly.

Next, do the {\hyperref[\detokenize{installing/essential-post-install-config:essential-post-install-config}]{\sphinxcrossref{\DUrole{std,std-ref}{Essential Post-Installation Configuration}}}}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Mac OS X}
\label{\detokenize{installing/mac-os-x:mac-os-x}}\label{\detokenize{installing/mac-os-x::doc}}\label{\detokenize{installing/mac-os-x:id1}}\phantomsection\label{\detokenize{installing/mac-os-x:macosx-install-packages}}
\begin{sphinxadmonition}{note}{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!
\end{sphinxadmonition}


\subsection{Install Packages}
\label{\detokenize{installing/mac-os-x:install-packages}}
OS X 10.7 provides Perl 5.12 and Apache 2.2. Install the following additional
packages:
\begin{itemize}
\item {} 
git: Download an installer from
\sphinxhref{http://www.git-scm.com/downloads}{the git website}.

\item {} 
MySQL: Download an installer from
\sphinxhref{http://dev.mysql.com/downloads/mysql/}{the MySQL website}.

\end{itemize}


\subsection{Bugzilla}
\label{\detokenize{installing/mac-os-x:bugzilla}}\label{\detokenize{installing/mac-os-x:macosx-install-bzfiles}}
The best way to get Bugzilla is to check it out from git:

\sphinxstyleliteralstrong{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 \sphinxcode{\$HOME/bugzilla}.

If that's not possible, you can
\sphinxhref{http://www.bugzilla.org/download/}{download a tarball of Bugzilla}.


\subsection{Additional System Libraries}
\label{\detokenize{installing/mac-os-x:additional-system-libraries}}\label{\detokenize{installing/mac-os-x:macosx-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 \sphinxhref{http://www.macports.org/}{MacPorts}, \sphinxhref{http://brew.sh/}{Homebrew} or
\sphinxhref{http://sourceforge.net/projects/fink/}{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 \sphinxcode{gd2} package
(MacPorts/Fink) or the \sphinxcode{gd} package (Brew).

The package manager may prompt you to install a number of dependencies; you
will need to agree to this.

\begin{sphinxadmonition}{note}{Note:}
To prevent creating conflicts with the software that Apple
installs by default, Fink creates its own directory tree at \sphinxcode{/sw}
where it installs most of
the software that it installs. This means your libraries and headers
will be at \sphinxcode{/sw/lib} and \sphinxcode{/sw/include} instead
of \sphinxcode{/usr/lib} and \sphinxcode{/usr/include}. When the
Perl module config script for the GD module asks where your \sphinxcode{libgd}
is, be sure to tell it \sphinxcode{/sw/lib}.
\end{sphinxadmonition}


\subsection{Perl Modules}
\label{\detokenize{installing/mac-os-x:perl-modules}}\label{\detokenize{installing/mac-os-x:macosx-install-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 \sphinxstyleliteralstrong{-{-}global}
option.

To check whether you have all the required modules and what is still missing,
run:

\sphinxstyleliteralstrong{perl checksetup.pl -{-}check-modules}

You can run this command as many times as necessary.

Install all missing modules locally like this:

\sphinxstyleliteralstrong{perl install-module.pl -{-}all}


\subsection{Web Server}
\label{\detokenize{installing/mac-os-x:web-server}}\label{\detokenize{installing/mac-os-x:macosx-config-webserver}}
Any web server that is capable of running CGI scripts can be made to work.
We have specific configuration instructions for the following:
\begin{itemize}
\item {} 
{\hyperref[\detokenize{installing/apache:apache}]{\sphinxcrossref{\DUrole{std,std-ref}{Apache}}}}

\end{itemize}

You'll need to create a symbolic link so the webserver can see Bugzilla:

\sphinxstyleliteralstrong{cd /Library/WebServer/Documents}

\sphinxstyleliteralstrong{sudo ln -s \$HOME/bugzilla bugzilla}

In \sphinxmenuselection{System Preferences} --\textgreater{} \sphinxmenuselection{Sharing}, enable the
\sphinxmenuselection{Web Sharing} checkbox to start Apache.


\subsection{Database Engine}
\label{\detokenize{installing/mac-os-x:macosx-config-database}}\label{\detokenize{installing/mac-os-x: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:
\begin{itemize}
\item {} 
{\hyperref[\detokenize{installing/mysql:mysql}]{\sphinxcrossref{\DUrole{std,std-ref}{MySQL}}}}

\item {} 
{\hyperref[\detokenize{installing/postgresql:postgresql}]{\sphinxcrossref{\DUrole{std,std-ref}{PostgreSQL}}}}

\item {} 
{\hyperref[\detokenize{installing/oracle:oracle}]{\sphinxcrossref{\DUrole{std,std-ref}{Oracle}}}}

\item {} 
{\hyperref[\detokenize{installing/sqlite:sqlite}]{\sphinxcrossref{\DUrole{std,std-ref}{SQLite}}}}

\end{itemize}


\subsection{localconfig}
\label{\detokenize{installing/mac-os-x:localconfig}}
You should now change into the Bugzilla directory and run
\sphinxcode{checksetup.pl}, without any parameters:

\sphinxstyleliteralstrong{perl checksetup.pl}

\sphinxcode{checksetup.pl} will write out a file called \sphinxcode{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 \sphinxcode{\$db\_driver}
and \sphinxcode{\$db\_pass}, which are respectively the type of the database you are
using and the password for the \sphinxcode{bugs} database user you have created.
\sphinxcode{\$db\_driver} can be either \sphinxcode{mysql}, \sphinxcode{Pg} (PostgreSQL), \sphinxcode{Oracle} or
\sphinxcode{Sqlite}. All values are case sensitive.

Set the value of \sphinxcode{\$webservergroup} to the group your web server runs as.
\begin{itemize}
\item {} 
Fedora/Red Hat: \sphinxcode{apache}

\item {} 
Debian/Ubuntu: \sphinxcode{www-data}

\item {} 
Mac OS X: \sphinxcode{\_www}

\item {} 
Windows: ignore this setting; it does nothing

\end{itemize}

The other options in the \sphinxcode{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 \sphinxcode{\$db\_*} parameters.

\begin{sphinxadmonition}{note}{Note:}
If you are using Oracle, \sphinxcode{\$db\_name} should be set to
the SID name of your database (e.g. \sphinxcode{XE} if you are using Oracle XE).
\end{sphinxadmonition}


\subsection{checksetup.pl}
\label{\detokenize{installing/mac-os-x:checksetup-pl}}
Next, run \sphinxcode{checksetup.pl} an additional time:

\sphinxstyleliteralstrong{perl 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 \sphinxcode{bugs}
user you created and the password you defined, and creates the
\sphinxcode{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.

\sphinxcode{checksetup.pl} will then finish. You may rerun
\sphinxcode{checksetup.pl} at any time if you wish.


\subsection{Success}
\label{\detokenize{installing/mac-os-x:success}}
Your Bugzilla should now be working. Check by running:

\sphinxstyleliteralstrong{perl testserver.pl http://\textless{}your-bugzilla-server\textgreater{}/}

If that passes, access \sphinxcode{http://\textless{}your-bugzilla-server\textgreater{}/} 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.

Next, do the {\hyperref[\detokenize{installing/essential-post-install-config:essential-post-install-config}]{\sphinxcrossref{\DUrole{std,std-ref}{Essential Post-Installation Configuration}}}}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Essential Post-Installation Configuration}
\label{\detokenize{installing/essential-post-install-config:essential-post-install-config}}\label{\detokenize{installing/essential-post-install-config:essential-post-installation-configuration}}\label{\detokenize{installing/essential-post-install-config::doc}}
Bugzilla is configured in the Administration Parameters. Log in with the
administrator account you defined in the last \sphinxcode{checksetup.pl} run,
then click \sphinxmenuselection{Administration} in the header, and then
\sphinxmenuselection{Parameters}. You will see the different parameter sections
down the left hand side of the page.


\subsection{Parameters}
\label{\detokenize{installing/essential-post-install-config:config-essential-params}}\label{\detokenize{installing/essential-post-install-config: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 \sphinxmenuselection{Required Settings} section.
\begin{itemize}
\item {} 
\DUrole{param}{urlbase}: this is the URL by which people should access
Bugzilla's front page.

\item {} 
\DUrole{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.

\item {} 
\DUrole{param}{ssl\_redirect}: Set this if you want everyone to be redirected
to use the SSL version. Recommended if you have set up SSL.

\item {} 
\DUrole{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.

\end{itemize}

You may want to put your email address in the \DUrole{param}{maintainer}
parameter in the \sphinxmenuselection{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
\DUrole{param}{requirelogin} parameter in the \sphinxmenuselection{User Authentication}
section, and change or clear the \DUrole{param}{createemailregexp} parameter.


\subsection{Email}
\label{\detokenize{installing/essential-post-install-config:email}}\label{\detokenize{installing/essential-post-install-config:id1}}
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 \sphinxmenuselection{Email} section
of the Parameters.


\subsubsection{Use Another Mail Server}
\label{\detokenize{installing/essential-post-install-config:install-mta}}\label{\detokenize{installing/essential-post-install-config:use-another-mail-server}}
This section corresponds to choosing a \DUrole{param}{mail\_delivery\_method} of
\DUrole{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:
\begin{itemize}
\item {} 
The domain name of the server (Parameter: \DUrole{param}{smtpserver})

\item {} 
The username and password to use (Parameters: \DUrole{param}{smtp\_username} and
\DUrole{param}{smtp\_password})

\item {} 
Whether the server uses SSL (Parameter: \DUrole{param}{smtp\_ssl})

\item {} 
The address you should be sending mail 'From' (Parameter:
\DUrole{param}{mailfrom})

\end{itemize}

If your organization does not run its own mail server, you can use the
services of one of any number of popular email providers.


\paragraph{Gmail}
\label{\detokenize{installing/essential-post-install-config:gmail}}
Visit \sphinxurl{https://gmail.com} and create a new Gmail account for your Bugzilla to
use. Then, set the following parameter values in the "Email" section:
\begin{itemize}
\item {} 
\DUrole{param}{mail\_delivery\_method}: \DUrole{paramval}{SMTP}

\item {} 
\DUrole{param}{mailfrom}: \DUrole{paramval}{new\_gmail\_address@gmail.com}

\item {} 
\DUrole{param}{smtpserver}: \DUrole{paramval}{smtp.gmail.com:465}

\item {} 
\DUrole{param}{smtp\_username}: \DUrole{paramval}{new\_gmail\_address@gmail.com}

\item {} 
\DUrole{param}{smtp\_password}: \DUrole{paramval}{new\_gmail\_password}

\item {} 
\DUrole{param}{smtp\_ssl}: \DUrole{paramval}{On}

\end{itemize}


\subsubsection{Run Your Own Mail Server}
\label{\detokenize{installing/essential-post-install-config:run-your-own-mail-server}}
This section corresponds to choosing a \DUrole{param}{mail\_delivery\_method} of
\DUrole{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, \sphinxhref{http://www.postfix.org/}{Postfix}
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 \DUrole{paramval}{Sendmail} with a little application called
\sphinxhref{http://glob.com.au/sendmail/}{sendmail.exe}, which provides
sendmail-compatible calling conventions and encapsulates the SMTP
communication to another mail server. Like Bugzilla, \sphinxstyleliteralstrong{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 \sphinxcode{mail} program
succeeds, then Bugzilla should also be fine.


\subsubsection{Troubleshooting}
\label{\detokenize{installing/essential-post-install-config: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
\sphinxhref{http://selinuxproject.org/page/ApacheRecipes\#Allow\_the\_Apache\_HTTP\_Server\_to\_send\_mail}{httpd\_can\_sendmail}
may need to be set to True.

If all those things don't help, activate the \DUrole{param}{smtp\_debug} parameter
and check your webserver logs.


\subsection{Products, Components, Versions and Milestones}
\label{\detokenize{installing/essential-post-install-config:products-components-versions-and-milestones}}\label{\detokenize{installing/essential-post-install-config:config-products}}
Bugs in Bugzilla are categorised into Products and, inside those Products,
Components (and, optionally, if you turn on the \DUrole{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 {\hyperref[\detokenize{installing/optional-post-install-config:optional-post-install-config}]{\sphinxcrossref{\DUrole{std,std-ref}{Optional Post-Install Configuration}}}}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Optional Post-Install Configuration}
\label{\detokenize{installing/optional-post-install-config:optional-post-install-config}}\label{\detokenize{installing/optional-post-install-config:optional-post-install-configuration}}\label{\detokenize{installing/optional-post-install-config::doc}}
Bugzilla has a number of optional features. This section describes how
to configure or enable them.


\subsection{Recurring Tasks}
\label{\detokenize{installing/optional-post-install-config:id1}}\label{\detokenize{installing/optional-post-install-config: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.


\subsubsection{Linux}
\label{\detokenize{installing/optional-post-install-config:linux}}
Run:

\sphinxstyleliteralstrong{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.


\subsubsection{Windows}
\label{\detokenize{installing/optional-post-install-config:windows}}
Windows comes with a Task Scheduler. To run a particular script, do the
following:
\begin{enumerate}
\item {} 
\sphinxmenuselection{Control Panel} --\textgreater{} \sphinxmenuselection{Scheduled Tasks} --\textgreater{}
\sphinxmenuselection{Add Scheduled Task}

\item {} 
Next

\item {} 
Browse

\item {} 
Find \sphinxcode{perl.exe} (normally \sphinxcode{C:\textbackslash{}Perl\textbackslash{}bin\textbackslash{}perl.exe})

\item {} 
Give the task a name, such as "Bugzilla \textless{}scriptname\textgreater{}"

\item {} 
Request the task be performed at your desired time and interval

\item {} 
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

\item {} 
Tick "Open Advanced Properties.." and click Finish

\item {} 
Append the script name to the end of the "Run" field. eg
\sphinxstyleliteralstrong{C:\textbackslash{}Perl\textbackslash{}bin\textbackslash{}perl.exe C:\textbackslash{}Bugzilla\textbackslash{}\textless{}scriptname\textgreater{}}

\item {} 
Change "start in" to the Bugzilla directory

\end{enumerate}


\subsection{Bug Graphs}
\label{\detokenize{installing/optional-post-install-config:bug-graphs}}\label{\detokenize{installing/optional-post-install-config:installation-bug-graphs}}
If you have installed the necessary Perl modules, as indicated by
\sphinxcode{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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
5 0 * * * cd \PYGZlt{}your\PYGZhy{}bugzilla\PYGZhy{}directory\PYGZgt{} \PYGZam{}\PYGZam{} ./collectstats.pl
\end{sphinxVerbatim}

On Windows, schedule the \sphinxcode{collectstats.pl} script to run daily.

After two days have passed you'll be able to view bug graphs from
the Reports page.


\subsection{Whining}
\label{\detokenize{installing/optional-post-install-config:whining}}\label{\detokenize{installing/optional-post-install-config:installation-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 {\hyperref[\detokenize{administering/whining:whining}]{\sphinxcrossref{\DUrole{std,std-ref}{Whining}}}}, but for it to work a Perl script must
be executed at regular intervals.

On Linux, use a cron line as follows:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
*/15 * * * * cd \PYGZlt{}your\PYGZhy{}bugzilla\PYGZhy{}directory\PYGZgt{} \PYGZam{}\PYGZam{} ./whine.pl
\end{sphinxVerbatim}

On Windows, schedule the \sphinxcode{whine.pl} script to run every 15 minutes.


\subsection{Whining at Untriaged Bugs}
\label{\detokenize{installing/optional-post-install-config:installation-whining-cron}}\label{\detokenize{installing/optional-post-install-config: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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
55 0 * * * cd \PYGZlt{}your\PYGZhy{}bugzilla\PYGZhy{}directory\PYGZgt{} \PYGZam{}\PYGZam{} ./whineatnews.pl
\end{sphinxVerbatim}

On Windows, schedule the \sphinxcode{whineatnews.pl} script to run daily.


\subsection{Dependency Graphs}
\label{\detokenize{installing/optional-post-install-config:dependency-graphs}}
Bugzilla can draw graphs of the dependencies (depends on/blocks relationships)
between bugs, if you install a package called \sphinxcode{dot}.


\subsubsection{Linux}
\label{\detokenize{installing/optional-post-install-config:id2}}
Put the complete path to the \sphinxcode{dot} command (from the \sphinxcode{graphviz}
package) in the \DUrole{param}{webdotbase} parameter. E.g. \DUrole{paramval}{/usr/bin/dot}.


\subsubsection{Windows}
\label{\detokenize{installing/optional-post-install-config:id3}}
Download and install Graphviz from
\sphinxhref{http://www.graphviz.org/Download\_windows.php}{the Graphviz website}. Put
the complete path to \sphinxcode{dot.exe} in the \DUrole{param}{webdotbase} parameter,
using forward slashes as path separators. E.g.
\DUrole{paramval}{C:/Program Files/ATT/Graphviz/bin/dot.exe}.


\subsection{Documentation}
\label{\detokenize{installing/optional-post-install-config:documentation}}
Bugzilla has extensive documentation and help, written in
\sphinxhref{http://sphinx-doc.org/rest.html}{reStructured Text}
format. A generic compiled copy exists on
\sphinxhref{https://bugzilla.readthedocs.org/}{bugzilla.readthedocs.org}, and
\sphinxmenuselection{Help} links point to it by default. If you want to build and use a
local copy of the documentation, perhaps because you have added Bugzilla
extensions which come with documentation, or because your users don't have
Internet access from their machines, then:
\begin{itemize}
\item {} 
Install \sphinxhref{http://sphinx-doc.org/}{Sphinx}
(\sphinxcode{python-sphinx} package on Debian/Ubuntu)

\end{itemize}

Then run \sphinxstyleliteralstrong{docs/makedocs.pl} in your Bugzilla directory.

Bugzilla will automatically detect that you've compiled the documentation
and link to it in preference to the copy on the Internet. Don't forget to
recompile it when you upgrade Bugzilla or install new extensions.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Migrating From Other Bug-Tracking Systems}
\label{\detokenize{installing/migrating:migrating-from-other-btses}}\label{\detokenize{installing/migrating:migrating-from-other-bug-tracking-systems}}\label{\detokenize{installing/migrating::doc}}
Bugzilla has a framework you can use for migrating from other bug-tracking
systems -
\sphinxhref{http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/Migrate.html}{Bugzilla::Migrate}.
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
\sphinxhref{https://www.gnu.org/software/gnats/}{Gnats}. If you write one for a
popular system, please share your code with us.

Alternatively, Bugzilla comes with a script, \sphinxcode{importxml.pl}, which
imports bugs in Bugzilla's XML format. You can see examples of this format
by clicking the \sphinxmenuselection{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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Moving Bugzilla Between Machines}
\label{\detokenize{installing/moving:moving}}\label{\detokenize{installing/moving::doc}}\label{\detokenize{installing/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 {\hyperref[\detokenize{installing/upgrading:upgrading}]{\sphinxcrossref{\DUrole{std,std-ref}{upgrade}}}} 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.
\begin{enumerate}
\item {} 
Shut down your Bugzilla by loading the front page, going to
\sphinxmenuselection{Administration} \textbar{} \sphinxmenuselection{Parameters} \textbar{} \sphinxmenuselection{General}
and putting some explanatory text into the \DUrole{param}{shutdownhtml} parameter.

\item {} 
Make a {\hyperref[\detokenize{installing/backups:backups}]{\sphinxcrossref{\DUrole{std,std-ref}{backup}}}} of the bugs database.

\item {} 
On your new machine, install Bugzilla using the instructions at
{\hyperref[\detokenize{installing/index:installing}]{\sphinxcrossref{\DUrole{std,std-ref}{Installation and Maintenance Guide}}}}. Look at the old machine if you need to know what values
you used for configuring e.g. MySQL.

\item {} 
Copy the \sphinxcode{data} directory and the \sphinxcode{localconfig} file from the
old Bugzilla installation to the new one.

\item {} 
If anything about your database configuration changed (location of the
server, username, password, etc.) as part of the move, update the
appropriate variables in \sphinxcode{localconfig}.

\item {} 
If the new URL to your new Bugzilla installation is different from the old
one, update the \DUrole{param}{urlbase} parameter in \sphinxcode{data/params.json}
using a text editor.

\item {} 
Copy the database backup file from your old server to the new one.

\item {} 
Create an empty \sphinxcode{bugs} database on the new server. For MySQL, that would
look like this:

\sphinxstyleliteralstrong{mysql -u root -p -e "CREATE DATABASE bugs DEFAULT CHARACTER SET utf8;"}

\item {} 
Import your backup file into your new \sphinxcode{bugs} database. Again, for MySQL:

\sphinxstyleliteralstrong{mysql -u root -p bugs \textless{} \$BACKUP\_FILE\_NAME}

If you get an error about "packet too large" or "MySQL server has gone
away", you need to adjust the \sphinxcode{max\_allowed\_packet} setting in
your \sphinxcode{my.cnf} file (usually \sphinxcode{/etc/my.cnf}) file to match or
exceed the value configured in the same file in your old version of MySQL.

If there are \sphinxstyleemphasis{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.

\item {} 
Run \sphinxcode{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.)

\sphinxstyleliteralstrong{./checksetup.pl}

\item {} 
Activate your new Bugzilla by loading the front page on the new server,
going to \sphinxmenuselection{Administration} \textbar{} \sphinxmenuselection{Parameters} \textbar{}
\sphinxmenuselection{General} and removing the text from the \DUrole{param}{shutdownhtml}
parameter.

\end{enumerate}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Upgrading}
\label{\detokenize{installing/upgrading:upgrading}}\label{\detokenize{installing/upgrading::doc}}\label{\detokenize{installing/upgrading:id1}}
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.

\begin{sphinxadmonition}{warning}{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.
\end{sphinxadmonition}

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 {\hyperref[\detokenize{installing/upgrading-with-git:upgrading-with-git}]{\sphinxcrossref{\DUrole{std,std-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:
\begin{enumerate}
\item {} 
Upgrade to the latest point release of your current Bugzilla version.

\item {} 
Move to Git while staying on exactly the same release.

\item {} 
Upgrade to the latest Bugzilla using the instructions for {\hyperref[\detokenize{installing/upgrading-with-git:upgrading-with-git}]{\sphinxcrossref{\DUrole{std,std-ref}{Upgrading with Git}}}}.

\end{enumerate}

See {\hyperref[\detokenize{installing/migrating-from-bzr:migrating-from-bazaar}]{\sphinxcrossref{\DUrole{std,std-ref}{Migrating from Bazaar}}}} or {\hyperref[\detokenize{installing/migrating-from-cvs:migrating-from-cvs}]{\sphinxcrossref{\DUrole{std,std-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:
\begin{itemize}
\item {} 
\sphinxcode{.git}: you installed using Git - follow {\hyperref[\detokenize{installing/upgrading-with-git:upgrading-with-git}]{\sphinxcrossref{\DUrole{std,std-ref}{Upgrading with Git}}}}.

\item {} 
\sphinxcode{.bzr}: you installed using Bazaar - follow {\hyperref[\detokenize{installing/migrating-from-bzr:migrating-from-bazaar}]{\sphinxcrossref{\DUrole{std,std-ref}{Migrating from Bazaar}}}}.

\item {} 
\sphinxcode{CVS}: you installed using CVS - follow {\hyperref[\detokenize{installing/migrating-from-cvs:migrating-from-cvs}]{\sphinxcrossref{\DUrole{std,std-ref}{Migrating from CVS}}}}.

\item {} 
None of the above: you installed using an old tarball - follow
{\hyperref[\detokenize{installing/migrating-from-a-tarball:migrating-from-a-tarball}]{\sphinxcrossref{\DUrole{std,std-ref}{Migrating from a Tarball}}}}.

\end{itemize}

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 {\hyperref[\detokenize{installing/upgrading-with-a-tarball:upgrading-with-a-tarball}]{\sphinxcrossref{\DUrole{std,std-ref}{Upgrading with a Tarball}}}}.

Whichever path you use, you may need help with
{\hyperref[\detokenize{installing/upgrading-customizations:upgrading-customizations}]{\sphinxcrossref{\DUrole{std,std-ref}{Upgrading a Customized or Extended Bugzilla}}}}.


\subsection{Upgrading with Git}
\label{\detokenize{installing/upgrading-with-git:upgrading-with-git}}\label{\detokenize{installing/upgrading-with-git::doc}}\label{\detokenize{installing/upgrading-with-git:id1}}
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 \sphinxcode{checksetup.pl} included
with Bugzilla that will automatically do all of the database migration
for you.


\subsubsection{Before You Upgrade}
\label{\detokenize{installing/upgrading-with-git:before-you-upgrade}}
Before you start your upgrade, there are a few important
steps to take:
\begin{enumerate}
\item {} 
Read the
\sphinxhref{http://www.bugzilla.org/releases/}{Release Notes} 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.

\item {} 
Run the {\hyperref[\detokenize{installing/sanity-check:sanity-check}]{\sphinxcrossref{\DUrole{std,std-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.

\item {} 
Work out how to {\hyperref[\detokenize{installing/backups:backups}]{\sphinxcrossref{\DUrole{std,std-ref}{back up}}}} your Bugzilla entirely, and
how to restore from a backup if need be.

\end{enumerate}


\paragraph{Customized Bugzilla?}
\label{\detokenize{installing/upgrading-with-git: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 {\hyperref[\detokenize{integrating/templates:template-method}]{\sphinxcrossref{\DUrole{std,std-ref}{Choosing a Customization 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.

You can see if you have local code customizations using:

\sphinxstyleliteralstrong{git diff}

If that comes up empty, then run:

\sphinxstyleliteralstrong{git log \textbar{} 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.


\subsubsection{Starting the Upgrade}
\label{\detokenize{installing/upgrading-with-git:start-upgrade-git}}\label{\detokenize{installing/upgrading-with-git:starting-the-upgrade}}
When you are ready to go:
\begin{enumerate}
\item {} 
Shut down your Bugzilla installation by putting some explanatory text
in the \DUrole{param}{shutdownhtml} parameter.

\item {} 
Make all necessary {\hyperref[\detokenize{installing/backups:backups}]{\sphinxcrossref{\DUrole{std,std-ref}{backups}}}}.
\sphinxstyleemphasis{THIS IS VERY IMPORTANT}. If anything goes wrong during the upgrade,
having a backup allows you to roll back to a known good state.

\end{enumerate}


\subsubsection{Getting The New Bugzilla}
\label{\detokenize{installing/upgrading-with-git:upgrade-files-git}}\label{\detokenize{installing/upgrading-with-git:getting-the-new-bugzilla}}
In the commands below, \sphinxcode{\$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:

\sphinxstyleliteralstrong{cd \$BUGZILLA\_HOME}

\sphinxstyleliteralstrong{git pull}

If you want to upgrade to a newer release of Bugzilla, then you will
additionally need to do:

\sphinxstyleliteralstrong{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").

\begin{sphinxadmonition}{note}{Note:}
Do not attempt to downgrade Bugzilla this way - it won't work.
\end{sphinxadmonition}

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.


\subsubsection{Upgrading the Database}
\label{\detokenize{installing/upgrading-with-git:upgrading-the-database}}
Run \sphinxcode{checksetup.pl}. This will do everything required to convert
your existing database and settings to the new version.

\sphinxstyleliteralstrong{cd \$BUGZILLA\_HOME}

\sphinxstyleliteralstrong{./checksetup.pl}
\begin{quote}

\begin{sphinxadmonition}{warning}{Warning:}
For some upgrades, running \sphinxcode{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.
\end{sphinxadmonition}
\end{quote}

\sphinxcode{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 \sphinxcode{install-module.pl}
script that \sphinxcode{checksetup.pl} recommends.


\subsubsection{Finishing The Upgrade}
\label{\detokenize{installing/upgrading-with-git:finishing-the-upgrade}}\begin{enumerate}
\item {} 
Reactivate Bugzilla by clear the text that you put into the
\DUrole{param}{shutdownhtml} parameter.

\item {} 
Run another {\hyperref[\detokenize{installing/sanity-check:sanity-check}]{\sphinxcrossref{\DUrole{std,std-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.

\end{enumerate}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Migrating from Bazaar}
\label{\detokenize{installing/migrating-from-bzr:migrating-from-bazaar}}\label{\detokenize{installing/migrating-from-bzr::doc}}\label{\detokenize{installing/migrating-from-bzr:id1}}
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.


\subsubsection{Download Code from Git}
\label{\detokenize{installing/migrating-from-bzr: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
\sphinxcode{Bugzilla/Constants.pm} in your Bugzilla directory and search for
\sphinxcode{BUGZILLA\_VERSION}.

Then, you need to download an additional copy of your \sphinxstyleemphasis{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 \sphinxcode{bugzilla}).

To do this, you will need a copy of the \sphinxstyleliteralstrong{git} program. All Linux
distributions have it; search your package manager for "git". On Windows or
Mac OS X, you can
\sphinxhref{http://www.git-scm.com/downloads}{download the official build}.

Once git is installed, run these commands to pull a copy of Bugzilla:

\sphinxstyleliteralstrong{git clone https://git.mozilla.org/bugzilla/bugzilla bugzilla-new}

\sphinxstyleliteralstrong{cd bugzilla-new}

\sphinxstyleliteralstrong{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.


\subsubsection{Save Any Local Customizations}
\label{\detokenize{installing/migrating-from-bzr:save-any-local-customizations}}
Go into your original Bugzilla directory and run this command:

\sphinxstyleliteralstrong{bzr diff \textgreater{} patch.diff}

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 \sphinxcode{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.


\subsubsection{Shut Down Bugzilla}
\label{\detokenize{installing/migrating-from-bzr: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 \DUrole{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 {\hyperref[\detokenize{installing/backups:backups}]{\sphinxcrossref{\DUrole{std,std-ref}{Backups}}}}. We shouldn't be affecting
the database, but you can't be too careful.


\subsubsection{Copy Across Data and Modules}
\label{\detokenize{installing/migrating-from-bzr:copy-across-data-and-modules}}
Copy the contents of the following directories from your current installation
of Bugzilla into the corresponding directory in \sphinxcode{bugzilla-new/}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
lib/
data/
template/en/custom (may or may not exist)
\end{sphinxVerbatim}

You also need to copy any extensions you have written or installed, which are
in the \sphinxcode{extensions/} directory. The command \sphinxstyleliteralstrong{bzr status extensions/} should help you work out what you added, if anything.

Lastly, copy the following file from your current installation of Bugzilla
into the corresponding place in \sphinxcode{bugzilla-new/}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
localconfig
\end{sphinxVerbatim}

This file contains your database password and access details. Because your
two versions of Bugzilla are the same, this should all work fine.


\subsubsection{Reapply Local Customizations}
\label{\detokenize{installing/migrating-from-bzr:reapply-local-customizations}}
If your \sphinxcode{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 \sphinxstyleliteralstrong{patch}
program, you can download it from
\sphinxhref{http://gnuwin32.sourceforge.net/packages/patch.htm}{GNUWin}. Once
downloaded, you must copy patch.exe into the Windows directory.

Copy \sphinxcode{patch.diff} into the \sphinxcode{bugzilla-new} directory and then do:

\sphinxstyleliteralstrong{patch -p0 -{-}dry-run \textless{} patch.diff}

The patch should apply cleanly because you have exactly the same version of
Bugzilla in both directories. If it does, remove the \sphinxstyleliteralstrong{-{-}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.


\subsubsection{Swap The New Version In}
\label{\detokenize{installing/migrating-from-bzr: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 \sphinxcode{bugzilla} and
\sphinxcode{bugzilla-new} directories, run:

\sphinxstyleliteralstrong{mv bugzilla bugzilla-old}

\sphinxstyleliteralstrong{mv bugzilla-new bugzilla}

\sphinxstyleliteralstrong{cd bugzilla}

\sphinxstyleliteralstrong{./checksetup.pl}

Running \sphinxcode{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.


\subsubsection{Re-enable Bugzilla}
\label{\detokenize{installing/migrating-from-bzr:re-enable-bugzilla}}
Go into the administrative interface and clear the contents of the
\DUrole{param}{shutdownhtml} parameter.


\subsubsection{Test Bugzilla}
\label{\detokenize{installing/migrating-from-bzr: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
{\hyperref[\detokenize{installing/upgrading-with-git:upgrading-with-git}]{\sphinxcrossref{\DUrole{std,std-ref}{Upgrading with Git}}}} to upgrade to the latest version of Bugzilla.


\subsubsection{Rolling Back}
\label{\detokenize{installing/migrating-from-bzr: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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Migrating from CVS}
\label{\detokenize{installing/migrating-from-cvs:migrating-from-cvs}}\label{\detokenize{installing/migrating-from-cvs::doc}}\label{\detokenize{installing/migrating-from-cvs:id1}}
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.


\subsubsection{Download Code from Git}
\label{\detokenize{installing/migrating-from-cvs: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
\sphinxcode{Bugzilla/Constants.pm} in your Bugzilla directory and search for
\sphinxcode{BUGZILLA\_VERSION}.

Then, you need to download an additional copy of your \sphinxstyleemphasis{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 \sphinxcode{bugzilla}).

To do this, you will need a copy of the \sphinxstyleliteralstrong{git} program. All Linux
distributions have it; search your package manager for "git". On Windows or
Mac OS X, you can
\sphinxhref{http://www.git-scm.com/downloads}{download the official build}.

Once git is installed, run these commands to pull a copy of Bugzilla:

\sphinxstyleliteralstrong{git clone https://git.mozilla.org/bugzilla/bugzilla bugzilla-new}

\sphinxstyleliteralstrong{cd bugzilla-new}

\sphinxstyleliteralstrong{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.


\subsubsection{Save Any Local Customizations}
\label{\detokenize{installing/migrating-from-cvs:save-any-local-customizations}}
Go into your original Bugzilla directory and run this command:

\sphinxstyleliteralstrong{cvs diff -puN \textgreater{} patch.diff}

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 \sphinxcode{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.


\subsubsection{Shut Down Bugzilla}
\label{\detokenize{installing/migrating-from-cvs: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 \DUrole{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 {\hyperref[\detokenize{installing/backups:backups}]{\sphinxcrossref{\DUrole{std,std-ref}{Backups}}}}. We shouldn't be affecting
the database, but you can't be too careful.


\subsubsection{Copy Across Data and Modules}
\label{\detokenize{installing/migrating-from-cvs:copy-across-data-and-modules}}
Copy the contents of the following directories from your current installation
of Bugzilla into the corresponding directory in \sphinxcode{bugzilla-new/}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
lib/
data/
template/en/custom (may or may not exist)
\end{sphinxVerbatim}

You also need to copy any extensions you have written or installed, which are
in the \sphinxcode{extensions/} directory. The command \sphinxstyleliteralstrong{cvs status extensions/} should help you work out what you added, if anything.

Lastly, copy the following file from your current installation of Bugzilla
into the corresponding place in \sphinxcode{bugzilla-new/}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
localconfig
\end{sphinxVerbatim}

This file contains your database password and access details. Because your
two versions of Bugzilla are the same, this should all work fine.


\subsubsection{Reapply Local Customizations}
\label{\detokenize{installing/migrating-from-cvs:reapply-local-customizations}}
If your \sphinxcode{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 \sphinxstyleliteralstrong{patch}
program, you can download it from
\sphinxhref{http://gnuwin32.sourceforge.net/packages/patch.htm}{GNUWin}. Once
downloaded, you must copy patch.exe into the Windows directory.

Copy \sphinxcode{patch.diff} into the \sphinxcode{bugzilla-new} directory and then do:

\sphinxstyleliteralstrong{patch -p0 -{-}dry-run \textless{} patch.diff}

The patch should apply cleanly because you have exactly the same version of
Bugzilla in both directories. If it does, remove the \sphinxstyleliteralstrong{-{-}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.


\subsubsection{Swap The New Version In}
\label{\detokenize{installing/migrating-from-cvs: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 \sphinxcode{bugzilla} and
\sphinxcode{bugzilla-new} directories, run:

\sphinxstyleliteralstrong{mv bugzilla bugzilla-old}

\sphinxstyleliteralstrong{mv bugzilla-new bugzilla}

\sphinxstyleliteralstrong{cd bugzilla}

\sphinxstyleliteralstrong{./checksetup.pl}

Running \sphinxcode{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.


\subsubsection{Re-enable Bugzilla}
\label{\detokenize{installing/migrating-from-cvs:re-enable-bugzilla}}
Go into the administrative interface and clear the contents of the
\DUrole{param}{shutdownhtml} parameter.


\subsubsection{Test Bugzilla}
\label{\detokenize{installing/migrating-from-cvs: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
{\hyperref[\detokenize{installing/upgrading-with-git:upgrading-with-git}]{\sphinxcrossref{\DUrole{std,std-ref}{Upgrading with Git}}}} to upgrade to the latest version of Bugzilla.


\subsubsection{Rolling Back}
\label{\detokenize{installing/migrating-from-cvs: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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Migrating from a Tarball}
\label{\detokenize{installing/migrating-from-a-tarball:migrating-from-a-tarball}}\label{\detokenize{installing/migrating-from-a-tarball::doc}}\label{\detokenize{installing/migrating-from-a-tarball:id1}}
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.


\subsubsection{Download Code from Git}
\label{\detokenize{installing/migrating-from-a-tarball: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
\sphinxcode{Bugzilla/Constants.pm} in your Bugzilla directory and search for
\sphinxcode{BUGZILLA\_VERSION}.

Then, you need to download an additional copy of your \sphinxstyleemphasis{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 \sphinxcode{bugzilla}).

To do this, you will need a copy of the \sphinxstyleliteralstrong{git} program. All Linux
distributions have it; search your package manager for "git". On Windows or
Mac OS X, you can
\sphinxhref{http://www.git-scm.com/downloads}{download the official build}.

Once git is installed, run these commands to pull a copy of Bugzilla:

\sphinxstyleliteralstrong{git clone https://git.mozilla.org/bugzilla/bugzilla bugzilla-new}

\sphinxstyleliteralstrong{cd bugzilla-new}

\sphinxstyleliteralstrong{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.


\subsubsection{Save Any Local Customizations}
\label{\detokenize{installing/migrating-from-a-tarball:save-any-local-customizations}}
Go into your original Bugzilla directory and run this command:

\sphinxstyleliteralstrong{diff -ru -x data -x lib -x docs -x .git -x CVS -x .cvsignore -x .bzr -x .bzrignore -x .bzrrev ../bugzilla-new . \textgreater{} ../patch.diff}

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 \sphinxcode{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.


\subsubsection{Shut Down Bugzilla}
\label{\detokenize{installing/migrating-from-a-tarball: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 \DUrole{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 {\hyperref[\detokenize{installing/backups:backups}]{\sphinxcrossref{\DUrole{std,std-ref}{Backups}}}}. We shouldn't be affecting
the database, but you can't be too careful.


\subsubsection{Copy Across Data and Modules}
\label{\detokenize{installing/migrating-from-a-tarball:copy-across-data-and-modules}}
Copy the contents of the following directories from your current installation
of Bugzilla into the corresponding directory in \sphinxcode{bugzilla-new/}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
lib/
data/
template/en/custom (may or may not exist)
\end{sphinxVerbatim}

You also need to copy any extensions you have written or installed, which are
in the \sphinxcode{extensions/} directory. Copy across any subdirectories which do not exist
in your new install.

Lastly, copy the following file from your current installation of Bugzilla
into the corresponding place in \sphinxcode{bugzilla-new/}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
localconfig
\end{sphinxVerbatim}

This file contains your database password and access details. Because your
two versions of Bugzilla are the same, this should all work fine.


\subsubsection{Reapply Local Customizations}
\label{\detokenize{installing/migrating-from-a-tarball:reapply-local-customizations}}
If your \sphinxcode{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 \sphinxstyleliteralstrong{patch}
program, you can download it from
\sphinxhref{http://gnuwin32.sourceforge.net/packages/patch.htm}{GNUWin}. Once
downloaded, you must copy patch.exe into the Windows directory.

Copy \sphinxcode{patch.diff} into the \sphinxcode{bugzilla-new} directory and then do:

\sphinxstyleliteralstrong{patch -p0 -{-}dry-run \textless{} patch.diff}

The patch should apply cleanly because you have exactly the same version of
Bugzilla in both directories. If it does, remove the \sphinxstyleliteralstrong{-{-}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.


\subsubsection{Swap The New Version In}
\label{\detokenize{installing/migrating-from-a-tarball: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 \sphinxcode{bugzilla} and
\sphinxcode{bugzilla-new} directories, run:

\sphinxstyleliteralstrong{mv bugzilla bugzilla-old}

\sphinxstyleliteralstrong{mv bugzilla-new bugzilla}

\sphinxstyleliteralstrong{cd bugzilla}

\sphinxstyleliteralstrong{./checksetup.pl}

Running \sphinxcode{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.


\subsubsection{Re-enable Bugzilla}
\label{\detokenize{installing/migrating-from-a-tarball:re-enable-bugzilla}}
Go into the administrative interface and clear the contents of the
\DUrole{param}{shutdownhtml} parameter.


\subsubsection{Test Bugzilla}
\label{\detokenize{installing/migrating-from-a-tarball: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
{\hyperref[\detokenize{installing/upgrading-with-git:upgrading-with-git}]{\sphinxcrossref{\DUrole{std,std-ref}{Upgrading with Git}}}} to upgrade to the latest version of Bugzilla.


\subsubsection{Rolling Back}
\label{\detokenize{installing/migrating-from-a-tarball: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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Upgrading with a Tarball}
\label{\detokenize{installing/upgrading-with-a-tarball:upgrading-with-a-tarball}}\label{\detokenize{installing/upgrading-with-a-tarball::doc}}\label{\detokenize{installing/upgrading-with-a-tarball:id1}}
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.


\subsubsection{Before You Upgrade}
\label{\detokenize{installing/upgrading-with-a-tarball:before-you-upgrade}}
Before you start your upgrade, there are a few important
steps to take:
\begin{enumerate}
\item {} 
Read the
\sphinxhref{http://www.bugzilla.org/releases/}{Release Notes} 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.

\item {} 
Run the {\hyperref[\detokenize{installing/sanity-check:sanity-check}]{\sphinxcrossref{\DUrole{std,std-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.

\item {} 
Work out how to {\hyperref[\detokenize{installing/backups:backups}]{\sphinxcrossref{\DUrole{std,std-ref}{back up}}}} your Bugzilla entirely, and
how to restore from a backup if need be.

\end{enumerate}


\paragraph{Customized Bugzilla?}
\label{\detokenize{installing/upgrading-with-a-tarball: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 {\hyperref[\detokenize{integrating/templates:template-method}]{\sphinxcrossref{\DUrole{std,std-ref}{Choosing a Customization 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.

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 \sphinxstyleemphasis{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
{\hyperref[\detokenize{installing/migrating-from-a-tarball:migrating-from-a-tarball}]{\sphinxcrossref{\DUrole{std,std-ref}{rebasing your install on top of git}}}}.


\subsubsection{Getting The New Bugzilla}
\label{\detokenize{installing/upgrading-with-a-tarball:getting-the-new-bugzilla}}\label{\detokenize{installing/upgrading-with-a-tarball:upgrade-files-tarball}}
Download a copy of the latest version of Bugzilla from the
\sphinxhref{http://www.bugzilla.org/download/}{Download Page} into a separate
directory (which we will call \sphinxcode{bugzilla-new}) alongside your existing
Bugzilla installation (which we will assume is in a directory called
\sphinxcode{bugzilla}).


\subsubsection{Copy Across Data and Modules}
\label{\detokenize{installing/upgrading-with-a-tarball:copy-across-data-and-modules}}
Copy the contents of the following directories from your current installation
of Bugzilla into the corresponding directory in \sphinxcode{bugzilla-new/}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
lib/
data/
template/en/custom (may or may not exist)
\end{sphinxVerbatim}

You also need to copy any extensions you have written or installed, which are
in the \sphinxcode{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 \sphinxcode{disabled} file - those are not enabled.

Lastly, copy the following file from your current installation of Bugzilla
into the corresponding place in \sphinxcode{bugzilla-new/}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
localconfig
\end{sphinxVerbatim}

This file contains your database password and access details.


\subsubsection{Swap The New Version In}
\label{\detokenize{installing/upgrading-with-a-tarball:swap-the-new-version-in}}
Now we swap the directories over. From the directory containing the
\sphinxcode{bugzilla} and \sphinxcode{bugzilla-new} directories, run:

\sphinxstyleliteralstrong{mv bugzilla bugzilla-old}

\sphinxstyleliteralstrong{mv bugzilla-new bugzilla}

\sphinxstyleliteralstrong{cd bugzilla}


\subsubsection{Upgrading the Database}
\label{\detokenize{installing/upgrading-with-a-tarball:upgrading-the-database}}
Run \sphinxcode{checksetup.pl}. This will do everything required to convert
your existing database and settings to the new version.

\sphinxstyleliteralstrong{cd \$BUGZILLA\_HOME}

\sphinxstyleliteralstrong{./checksetup.pl}
\begin{quote}

\begin{sphinxadmonition}{warning}{Warning:}
For some upgrades, running \sphinxcode{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.
\end{sphinxadmonition}
\end{quote}

\sphinxcode{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 \sphinxcode{install-module.pl}
script that \sphinxcode{checksetup.pl} recommends.


\subsubsection{Finishing The Upgrade}
\label{\detokenize{installing/upgrading-with-a-tarball:finishing-the-upgrade}}\begin{enumerate}
\item {} 
Reactivate Bugzilla by clear the text that you put into the
\DUrole{param}{shutdownhtml} parameter.

\item {} 
Run another {\hyperref[\detokenize{installing/sanity-check:sanity-check}]{\sphinxcrossref{\DUrole{std,std-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.

\end{enumerate}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Upgrading a Customized or Extended Bugzilla}
\label{\detokenize{installing/upgrading-customizations:upgrading-customizations}}\label{\detokenize{installing/upgrading-customizations::doc}}\label{\detokenize{installing/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 \sphinxcode{extension-convert.pl} in the
\sphinxcode{contrib} directory which may be able to help you with that.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.

Bugzilla can automatically notify administrators when new releases are
available if the \DUrole{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 \DUrole{param}{proxy\_url} parameter accordingly. If
the proxy requires authentication, use the
\DUrole{paramval}{http://user:pass@proxy\_url/} syntax.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Backups}
\label{\detokenize{installing/backups:backups}}\label{\detokenize{installing/backups::doc}}\label{\detokenize{installing/backups:id1}}

\subsection{Database}
\label{\detokenize{installing/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.


\subsubsection{MySQL}
\label{\detokenize{installing/backups:mysql}}
\sphinxstyleliteralstrong{mysqldump -{-}max-allowed-packet=32M -u \$USERNAME -p \$DATABASENAME \textgreater{} backup.sql}

The value for \sphinxstyleliteralstrong{max-allowed-packet} should be the value you've set in
your {\hyperref[\detokenize{installing/mysql:mysql}]{\sphinxcrossref{\DUrole{std,std-ref}{MySQL configuration file}}}}, and should be larger than the
largest attachment in your database. See the
\sphinxhref{http://dev.mysql.com/doc/mysql/en/mysqldump.html}{mysqldump documentation}
for more information on \sphinxcode{mysqldump}.


\subsubsection{PostgreSQL}
\label{\detokenize{installing/backups:postgresql}}
\sphinxstyleliteralstrong{pg\_dump -{-}no-privileges -{-}no-owner -h localhost -U \$USERNAME \textgreater{} bugs.sql}


\subsection{Bugzilla}
\label{\detokenize{installing/backups: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.

\sphinxstyleliteralstrong{cp -rp \$BUGZILLA\_HOME /var/backups/bugzilla}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Sanity Check}
\label{\detokenize{installing/sanity-check:sanity-check}}\label{\detokenize{installing/sanity-check::doc}}\label{\detokenize{installing/sanity-check:id1}}
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
\sphinxmenuselection{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 \sphinxcode{sanitycheck.pl}. The script can also be run as
a \sphinxstyleliteralstrong{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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Merging Accounts}
\label{\detokenize{installing/merging-accounts:merging-accounts}}\label{\detokenize{installing/merging-accounts::doc}}
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 \sphinxcode{contrib} directory, there is a script
called \sphinxcode{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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{One Installation, Multiple Instances}
\label{\detokenize{installing/multiple-bugzillas:multiple-bz-dbs}}\label{\detokenize{installing/multiple-bugzillas::doc}}\label{\detokenize{installing/multiple-bugzillas: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 \sphinxcode{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
\sphinxcode{localconfig.\textless{}PROJECT\textgreater{}} in the same location as
the default one (\sphinxcode{localconfig}). It also checks for
customized templates in a directory named
\sphinxcode{\textless{}PROJECT\textgreater{}} in the same location as the
default one (\sphinxcode{template/\textless{}langcode\textgreater{}}). By default
this is \sphinxcode{template/en/default} so \sphinxcode{PROJECT}'s templates
would be located at \sphinxcode{template/en/PROJECT}.

To set up an alternate installation, just export \sphinxcode{PROJECT=foo} before
running \sphinxstyleliteralstrong{checksetup.pl} for the first time. It will
result in a file called \sphinxcode{localconfig.foo} instead of
\sphinxcode{localconfig}. Edit this file as described above, with
reference to a new database, and re-run \sphinxstyleliteralstrong{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.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nt}{\PYGZlt{}VirtualHost} \PYG{l+s}{12.34.56.78:80}\PYG{n+nt}{\PYGZgt{}}
    \PYG{n+nb}{ServerName} bugzilla.example.com
    \PYG{n+nb}{SetEnv} PROJECT foo
\PYG{n+nt}{\PYGZlt{}/VirtualHost}\PYG{n+nt}{\PYGZgt{}}
\end{sphinxVerbatim}

Don't forget to also export this variable before accessing Bugzilla
by other means, such as repeating tasks like those above.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{Administration Guide}
\label{\detokenize{administering/index:administration-guide}}\label{\detokenize{administering/index:administering}}\label{\detokenize{administering/index::doc}}
For those with \DUrole{group}{admin} privileges, Bugzilla can be administered using
the \sphinxmenuselection{Administration} link in the header. The administrative
controls are divided into several sections:


\section{Parameters}
\label{\detokenize{administering/parameters::doc}}\label{\detokenize{administering/parameters:parameters}}\label{\detokenize{administering/parameters:id1}}
Bugzilla is configured by changing various parameters, accessed
from the \sphinxmenuselection{Parameters} link, which is found on the Administration
page. The parameters are divided into several categories,
accessed via the menu on the left.


\subsection{Required Settings}
\label{\detokenize{administering/parameters:param-required-settings}}\label{\detokenize{administering/parameters:required-settings}}
The core required parameters for any Bugzilla installation are set
here. \DUrole{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.
\begin{description}
\item[{urlbase}] \leavevmode
Defines the fully qualified domain name and web
server path to this Bugzilla installation.
For example, if the Bugzilla query page is
\sphinxcode{http://www.foo.com/bugzilla/query.cgi},
the \DUrole{param}{urlbase} should be set
to \DUrole{paramval}{http://www.foo.com/bugzilla/}.

\item[{ssl\_redirect}] \leavevmode
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 \DUrole{param}{sslbase} in emails instead of \DUrole{param}{urlbase}.

\item[{sslbase}] \leavevmode
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
\sphinxcode{https://www.foo.com/bugzilla/index.cgi},
the \DUrole{param}{sslbase} should be set
to \DUrole{paramval}{https://www.foo.com/bugzilla/}.

\item[{cookiepath}] \leavevmode
Defines a path, relative to the web document root, that Bugzilla
cookies will be restricted to. For example, if the
\DUrole{param}{urlbase} is set to
\sphinxcode{http://www.foo.com/bugzilla/}, the
\DUrole{param}{cookiepath} should be set to
\DUrole{paramval}{/bugzilla/}. Setting it to \DUrole{paramval}{/} will allow all sites
served by this web server or virtual host to read Bugzilla cookies.

\end{description}


\subsection{General}
\label{\detokenize{administering/parameters:param-general}}\label{\detokenize{administering/parameters:general}}\begin{description}
\item[{maintainer}] \leavevmode
Email address of the person
responsible for maintaining this Bugzilla installation.
The address need not be that of a valid Bugzilla account.

\item[{utf8}] \leavevmode
Use UTF-8 (Unicode) encoding for all text in Bugzilla. Installations where
this parameter is set to \DUrole{paramval}{off} should set it to \DUrole{paramval}{on} only
after the data has been converted from existing legacy character
encodings to UTF-8, using the
\sphinxcode{contrib/recode.pl} script.

\begin{sphinxadmonition}{note}{Note:}
If you turn this parameter from \DUrole{paramval}{off} to \DUrole{paramval}{on},
you must re-run \sphinxcode{checksetup.pl} immediately afterward.
\end{sphinxadmonition}

\item[{shutdownhtml}] \leavevmode
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.

\item[{announcehtml}] \leavevmode
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 \sphinxcode{\textless{}div\textgreater{}}
tag. Any style attributes from the CSS can be applied. For example,
to make the text green inside of a red box, add \sphinxcode{id=message}
to the \sphinxcode{\textless{}div\textgreater{}} tag.

\item[{upgrade\_notification}] \leavevmode
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 \DUrole{paramval}{disabled}
to turn off the notification. Otherwise, choose which version of
Bugzilla you want to be notified about: \DUrole{paramval}{development\_snapshot} is the
latest release from the master branch, \DUrole{paramval}{latest\_stable\_release} is the most
recent release available on the most recent stable branch, and
\DUrole{paramval}{stable\_branch\_release} is the most recent release on the branch
this installation is based on.

\end{description}


\subsection{Administrative Policies}
\label{\detokenize{administering/parameters:param-administrative-policies}}\label{\detokenize{administering/parameters: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.
\begin{description}
\item[{allowbugdeletion}] \leavevmode
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.

\item[{allowemailchange}] \leavevmode
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.

\item[{allowuserdeletion}] \leavevmode
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.

\item[{last\_visit\_keep\_days}] \leavevmode
This option controls how many days Bugzilla will remember that users have visited specific bugs.

\end{description}


\subsection{User Authentication}
\label{\detokenize{administering/parameters:user-authentication}}\label{\detokenize{administering/parameters:param-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.
\begin{description}
\item[{auth\_env\_id}] \leavevmode
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.

\item[{auth\_env\_email}] \leavevmode
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.

\item[{auth\_env\_realname}] \leavevmode
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.

\item[{user\_info\_class}] \leavevmode
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:
\begin{itemize}
\item {} 
\DUrole{paramval}{CGI}: asks for username and password via CGI form interface.

\item {} 
\DUrole{paramval}{Env}: info for a pre-authenticated user is passed in system environment variables.

\end{itemize}

\item[{user\_verify\_class}] \leavevmode
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:
\begin{itemize}
\item {} 
\DUrole{paramval}{DB}: Bugzilla's built-in authentication. This is the most common choice.

\item {} 
\DUrole{paramval}{RADIUS}: RADIUS authentication using a RADIUS server. Using this method requires additional parameters to be set. Please see {\hyperref[\detokenize{administering/parameters:param-radius}]{\sphinxcrossref{\DUrole{std,std-ref}{RADIUS}}}} for more information.

\item {} 
\DUrole{paramval}{LDAP}: LDAP authentication using an LDAP server. Using this method requires additional parameters to be set. Please see {\hyperref[\detokenize{administering/parameters:param-ldap}]{\sphinxcrossref{\DUrole{std,std-ref}{LDAP}}}} for more information.

\end{itemize}

\item[{rememberlogin}] \leavevmode
Controls management of session cookies.
\begin{itemize}
\item {} 
\DUrole{paramval}{on} - Session cookies never expire (the user has to login only once per browser).

\item {} 
\DUrole{paramval}{off} - Session cookies last until the users session ends (the user will have to login in each new browser session).

\item {} 
\DUrole{paramval}{defaulton}/\DUrole{paramval}{defaultoff} - Default behavior as described above, but user can choose whether Bugzilla will remember their login or not.

\end{itemize}

\item[{requirelogin}] \leavevmode
If this option is set, all access to the system beyond the front page will require a login. No anonymous users will be permitted.

\item[{webservice\_email\_filter}] \leavevmode
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.

\item[{emailregexp}] \leavevmode
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 \DUrole{paramval}{\textasciicircum{}{[}\textasciicircum{}@{]}+}, which means 'local usernames, no @ allowed.'

\item[{emailregexpdesc}] \leavevmode
This description is shown to the user to explain which email addresses are allowed by the \DUrole{param}{emailregexp} param.

\item[{emailsuffix}] \leavevmode
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 \DUrole{param}{emailregexp} param to only allow local usernames, but you want the mail to be delivered to username@my.local.hostname.

\item[{createemailregexp}] \leavevmode
This defines the (case-insensitive) regexp to use for email addresses that are permitted to self-register. The default (\DUrole{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.

\item[{password\_complexity}] \leavevmode
Set the complexity required for passwords. In all cases must the passwords be at least 6 characters long.
\begin{itemize}
\item {} 
\DUrole{paramval}{no\_constraints} - No complexity required.

\item {} 
\DUrole{paramval}{mixed\_letters} - Passwords must contain at least one UPPER and one lower case letter.

\item {} 
\DUrole{paramval}{letters\_numbers} - Passwords must contain at least one UPPER and one lower case letter and a number.

\item {} 
\DUrole{paramval}{letters\_numbers\_specialchars} - Passwords must contain at least one letter, a number and a special character.

\end{itemize}

\item[{password\_check\_on\_login}] \leavevmode
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.

\end{description}


\subsection{Attachments}
\label{\detokenize{administering/parameters:param-attachments}}\label{\detokenize{administering/parameters: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.
\begin{description}
\item[{allow\_attachment\_display}] \leavevmode
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 \DUrole{param}{attachment\_base} parameter (see below). Untrusted users may upload attachments that could be potentially damaging if viewed directly in the browser.

\item[{attachment\_base}] \leavevmode
When the \DUrole{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 \DUrole{param}{urlbase} or \DUrole{param}{sslbase}. That is, a different domain name that resolves to this exact same Bugzilla installation.

Note that if you have set the \DUrole{param}{cookiedomain} parameter, you should set \DUrole{param}{attachment\_base} to use a domain that would not be matched by \DUrole{param}{cookiedomain}.

For added security, you can insert \sphinxcode{\%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.

\item[{allow\_attachment\_deletion}] \leavevmode
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.

\item[{maxattachmentsize}] \leavevmode
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 \DUrole{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 \sphinxhref{http://dev.mysql.com/doc/refman/5.1/en/packet-too-large.html}{max\_allowed\_packet}, whose default varies by distribution. Setting \DUrole{param}{maxattachmentsize} higher than your current setting for this value will produce an error.

\item[{maxlocalattachment}] \leavevmode
The maximum size (in megabytes) of attachments to be stored locally on the web server. If set to a value lower than the \DUrole{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.

\end{description}


\subsection{Bug Change Policies}
\label{\detokenize{administering/parameters:param-bug-change-policies}}\label{\detokenize{administering/parameters: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.
\begin{description}
\item[{duplicate\_or\_move\_bug\_status}] \leavevmode
When a bug is marked as a duplicate of another one, use this bug status.

\item[{letsubmitterchoosepriority}] \leavevmode
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.

\item[{letsubmitterchoosemilestone}] \leavevmode
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.

\item[{musthavemilestoneonaccept}] \leavevmode
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?

\item[{commenton*}] \leavevmode
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.

\begin{sphinxadmonition}{note}{Note:}
It is generally far better to require a developer comment
when resolving bugs than not. Few things are more annoying to bug
database users than having a developer mark a bug "fixed" without
any comment as to what the fix was (or even that it was truly
fixed!)
\end{sphinxadmonition}

\item[{noresolveonopenblockers}] \leavevmode
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.

\end{description}


\subsection{Bug Fields}
\label{\detokenize{administering/parameters:bug-fields}}\label{\detokenize{administering/parameters:param-bugfields}}
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
\DUrole{field}{Target Milestone} field or the \DUrole{field}{Status Whiteboard} field.
\begin{description}
\item[{useclassification}] \leavevmode
If this is on, Bugzilla will associate each product with a specific
classification. But you must have \DUrole{group}{editclassification} permissions
enabled in order to edit classifications.

\item[{usetargetmilestone}] \leavevmode
Do you wish to use the \DUrole{field}{Target Milestone} field?

\item[{useqacontact}] \leavevmode
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.

\item[{usestatuswhiteboard}] \leavevmode
This defines whether you wish to have a free-form, overwritable field
associated with each bug. The advantage of the \DUrole{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.

\item[{use\_see\_also}] \leavevmode
Do you wish to use the \DUrole{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.

\item[{defaultpriority}] \leavevmode
This is the priority that newly entered bugs are set to.

\item[{defaultseverity}] \leavevmode
This is the severity that newly entered bugs are set to.

\item[{defaultplatform}] \leavevmode
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.

\item[{defaultopsys}] \leavevmode
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.

\item[{collapsed\_comment\_tags}] \leavevmode
A comma-separated list of tags which, when applied to comments, will
cause them to be collapsed by default.

\end{description}


\subsection{Graphs}
\label{\detokenize{administering/parameters:param-dependency-graphs}}\label{\detokenize{administering/parameters:graphs}}
Bugzilla can draw graphs of bug-dependency relationships, using a tool called
\sphinxcode{dot} (from the \sphinxhref{http://graphviz.org/}{GraphViz project}) 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.
\begin{description}
\item[{webdotbase}] \leavevmode
You may set this parameter to any of the following:
\begin{itemize}
\item {} 
A complete file path to \sphinxstyleliteralstrong{dot} (part of GraphViz), which will
generate the graphs locally.

\item {} 
A URL prefix pointing to an installation of the Web Dot package, which
will generate the graphs remotely.

\item {} 
A blank value, which will disable dependency graphing.

\end{itemize}

The default value is blank. We recommend using a local install of
\sphinxcode{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 \sphinxcode{.htaccess} file; for other systems the
needed measures may vary. You can run \sphinxstyleliteralstrong{checksetup.pl} to
recreate the \sphinxcode{.htaccess} file if it has been lost.

\item[{font\_file}] \leavevmode
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.

\end{description}


\subsection{Group Security}
\label{\detokenize{administering/parameters:group-security}}\label{\detokenize{administering/parameters:param-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 \sphinxmenuselection{Groups} and \sphinxmenuselection{Product} pages of the
\sphinxmenuselection{Administration} area.
The options on this page control global default behavior.
For more information on Groups and Group Security, see
{\hyperref[\detokenize{administering/groups:groups}]{\sphinxcrossref{\DUrole{std,std-ref}{Groups and Security}}}}.
\begin{description}
\item[{makeproductgroups}] \leavevmode
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.

\item[{chartgroup}] \leavevmode
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.

\item[{insidergroup}] \leavevmode
The name of the group of users who can see/change private comments and attachments.

\item[{timetrackinggroup}] \leavevmode
The name of the group of users who can see/change time tracking information.

\item[{querysharegroup}] \leavevmode
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 {\hyperref[\detokenize{using/preferences:saved-searches}]{\sphinxcrossref{\DUrole{std,std-ref}{Saved Searches}}}}.

\item[{comment\_taggers\_group}] \leavevmode
The name of the group of users who can tag comments. Setting this to empty disables comment tagging.

\item[{debug\_group}] \leavevmode
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.

\item[{usevisibilitygroups}] \leavevmode
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 {\hyperref[\detokenize{administering/groups:edit-groups}]{\sphinxcrossref{\DUrole{std,std-ref}{Editing Groups and Assigning Group Permissions}}}}.

\item[{or\_groups}] \leavevmode
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.

\end{description}


\subsection{LDAP}
\label{\detokenize{administering/parameters:param-ldap}}\label{\detokenize{administering/parameters: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 \DUrole{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.

\begin{sphinxadmonition}{warning}{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 \sphinxcode{bugzilla\_ldapsync.rb}
script in the \sphinxcode{contrib}
directory. Another possible solution is fixing \sphinxhref{https://bugzilla.mozilla.org/show\_bug.cgi?id=201069}{bug  201069}.
\end{sphinxadmonition}

Parameters required to use LDAP Authentication:
\begin{description}
\item[{user\_verify\_class (in the Authentication section)}] \leavevmode
If you want to list \DUrole{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
\sphinxcode{data/params.json} and set \DUrole{param}{user\_verify\_class} to
\DUrole{paramval}{DB}.

\item[{LDAPserver}] \leavevmode
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: \DUrole{paramval}{ldap.company.com}
or \DUrole{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.

\begin{sphinxadmonition}{note}{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 \DUrole{paramval}{ldap://ldap.company.com}, LDAP over
SSL \DUrole{paramval}{ldaps://ldap.company.com}, or LDAP over a UNIX
domain socket \DUrole{paramval}{ldapi://\%2fvar\%2flib\%2fldap\_sock}.
\end{sphinxadmonition}

\item[{LDAPstarttls}] \leavevmode
Whether to require encrypted communication once a normal LDAP connection
is achieved with the server.

\item[{LDAPbinddn {[}Optional{]}}] \leavevmode
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 \DUrole{param}{LDAPbinddn} parameter to the user account Bugzilla
should use instead of the anonymous bind.
Ex. \DUrole{paramval}{cn=default,cn=user:password}

\item[{LDAPBaseDN}] \leavevmode
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. \DUrole{paramval}{ou=People,o=Company}

\item[{LDAPuidattribute}] \leavevmode
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. \DUrole{paramval}{uid}

\item[{LDAPmailattribute}] \leavevmode
The name of the
attribute which contains the email address your users will enter
into the Bugzilla login boxes.
Ex. \DUrole{paramval}{mail}

\item[{LDAPfilter}] \leavevmode
LDAP filter to AND with the LDAPuidattribute for filtering the list of
valid users.

\end{description}


\subsection{RADIUS}
\label{\detokenize{administering/parameters:param-radius}}\label{\detokenize{administering/parameters: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.

\begin{sphinxadmonition}{note}{Note:}
Most caveats that apply to LDAP authentication apply to RADIUS
authentication as well. See {\hyperref[\detokenize{administering/parameters:param-ldap}]{\sphinxcrossref{\DUrole{std,std-ref}{LDAP}}}} for details.
\end{sphinxadmonition}

Parameters required to use RADIUS Authentication:
\begin{description}
\item[{user\_verify\_class (in the Authentication section)}] \leavevmode
If you want to list \DUrole{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
\sphinxcode{data/params.json} and set \DUrole{param}{user\_verify\_class} to
\DUrole{paramval}{DB}.

\item[{RADIUS\_server}] \leavevmode
The name (and optionally the port) of your RADIUS server.

\item[{RADIUS\_secret}] \leavevmode
The RADIUS server's secret.

\item[{RADIUS\_NAS\_IP}] \leavevmode
The NAS-IP-Address attribute to be used when exchanging data with your
RADIUS server. If unspecified, 127.0.0.1 will be used.

\item[{RADIUS\_email\_suffix}] \leavevmode
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 \DUrole{param}{RADIUS\_email\_suffix} parameter.
If this simple solution does not work for you, you'll
probably need to modify
\sphinxcode{Bugzilla/Auth/Verify/RADIUS.pm} to match your
requirements.

\end{description}


\subsection{Email}
\label{\detokenize{administering/parameters:email}}\label{\detokenize{administering/parameters:param-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.
\begin{description}
\item[{mail\_delivery\_method}] \leavevmode
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.
\DUrole{paramval}{Test} does not send mail, but instead saves it in
\sphinxcode{data/mailer.testfile} for later review.
\DUrole{paramval}{None} disables email sending entirely.

\item[{mailfrom}] \leavevmode
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.

\item[{use\_mailer\_queue}] \leavevmode
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 \sphinxcode{checksetup.pl} for this feature), and that you are running the \sphinxcode{jobqueue.pl} daemon (otherwise your mail won't get sent). This affects all mail sent by Bugzilla, not just bug updates.

\item[{smtpserver}] \leavevmode
The SMTP server address, if the \DUrole{param}{mail\_delivery\_method}
parameter is set to \DUrole{paramval}{SMTP}.  Use \DUrole{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.

\item[{smtp\_username}] \leavevmode
Username to use for SASL authentication to the SMTP server.  Leave
this parameter empty if your server does not require authentication.

\item[{smtp\_password}] \leavevmode
Password to use for SASL authentication to the SMTP server. This
parameter will be ignored if the \DUrole{param}{smtp\_username}
parameter is left empty.

\item[{smtp\_ssl}] \leavevmode
Enable SSL support for connection to the SMTP server.

\item[{smtp\_debug}] \leavevmode
This parameter allows you to enable detailed debugging output.
Log messages are printed the web server's error log.

\item[{whinedays}] \leavevmode
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 {\hyperref[\detokenize{installing/optional-post-install-config:installation-whining}]{\sphinxcrossref{\DUrole{std,std-ref}{whining cron job}}}} described
in the installation instructions, or set this value to "0" (never whine).

\item[{globalwatchers}] \leavevmode
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.

\end{description}


\subsection{Query Defaults}
\label{\detokenize{administering/parameters:query-defaults}}\label{\detokenize{administering/parameters:param-querydefaults}}
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.
\begin{description}
\item[{quip\_list\_entry\_control}] \leavevmode
Controls how easily users can add entries to the quip list.
\begin{itemize}
\item {} 
\DUrole{paramval}{open} - Users may freely add to the quip list, and their entries will immediately be available for viewing.

\item {} 
\DUrole{paramval}{moderated} - Quips can be entered but need to be approved by a moderator before they will be shown.

\item {} 
\DUrole{paramval}{closed} - No new additions to the quips list are allowed.

\end{itemize}

\item[{mybugstemplate}] \leavevmode
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.

\item[{defaultquery}] \leavevmode
This is the default query that initially comes up when you access
the advanced query page. It's in URL-parameter format.

\item[{search\_allow\_no\_criteria}] \leavevmode
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.

\item[{default\_search\_limit}] \leavevmode
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.

\item[{max\_search\_results}] \leavevmode
The maximum number of bugs that a search can ever return. Tabular and graphical reports are exempted from this limit, however.

\end{description}


\subsection{Shadow Database}
\label{\detokenize{administering/parameters:param-shadowdatabase}}\label{\detokenize{administering/parameters: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 \DUrole{param}{shadowdbhost}
and \DUrole{param}{shadowdbport}. If it's on the same machine, specify
\DUrole{param}{shadowdbsock}.
\begin{description}
\item[{shadowdbhost}] \leavevmode
The host the shadow database is on.

\item[{shadowdbport}] \leavevmode
The port the shadow database is on.

\item[{shadowdbsock}] \leavevmode
The socket used to connect to the shadow database, if the host is the
local machine.

\item[{shadowdb}] \leavevmode
The database name of the shadow database.

\end{description}


\subsection{Memcached}
\label{\detokenize{administering/parameters:memcached}}\label{\detokenize{administering/parameters:admin-memcached}}\begin{description}
\item[{memcached\_servers}] \leavevmode
If this option is set, Bugzilla will integrate with \sphinxhref{http://www.memcached.org/}{Memcached}. Specify one or more servers, separated by
spaces, using hostname:port notation (for example:
\DUrole{paramval}{127.0.0.1:11211}).

\item[{memcached\_namespace}] \leavevmode
Specify a string to prefix each key on Memcached.

\end{description}


\subsection{User Matching}
\label{\detokenize{administering/parameters:admin-usermatching}}\label{\detokenize{administering/parameters: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 \DUrole{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.
\begin{description}
\item[{usemenuforusers}] \leavevmode
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.

\item[{ajax\_user\_autocompletion}] \leavevmode
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.

\item[{maxusermatches}] \leavevmode
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.

\item[{confirmuniqueusermatch}] \leavevmode
Whether a confirmation screen should be displayed when only one user matches a search entry.

\end{description}


\subsection{Advanced}
\label{\detokenize{administering/parameters:admin-advanced}}\label{\detokenize{administering/parameters:advanced}}\begin{description}
\item[{cookiedomain}] \leavevmode
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
\sphinxcode{https://bugzilla.example.com/}, setting this to
\DUrole{paramval}{.example.com/} will also allow
\sphinxcode{attachments.example.com/} to access Bugzilla cookies.

\item[{inbound\_proxies}] \leavevmode
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 \sphinxcode{X-Forwarded-For} header sent from those IPs, and use the value of that header as the end user's IP address.

\item[{proxy\_url}] \leavevmode
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
\DUrole{param}{upgrade\_notification} parameter. If the
proxy requires authentication, use the syntax:
\DUrole{paramval}{http://user:pass@proxy\_url/}.

\item[{strict\_transport\_security}] \leavevmode
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 \DUrole{param}{ssl\_redirect} parameter turned on, Bugzilla is the only thing running on its domain (i.e., your \DUrole{param}{urlbase} is something like \DUrole{paramval}{http://bugzilla.example.com/}), and you never plan to stop supporting SSL.
\begin{itemize}
\item {} 
\DUrole{paramval}{off} - Don't send the Strict-Transport-Security header with requests.

\item {} 
\DUrole{paramval}{this\_domain\_only} - Send the Strict-Transport-Security header with all requests, but only support it for the current domain.

\item {} 
\DUrole{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 \DUrole{param}{attachment\_base} that exists as (a) subdomain(s) under the main Bugzilla domain.

\end{itemize}

\end{description}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Default Preferences}
\label{\detokenize{administering/preferences::doc}}\label{\detokenize{administering/preferences:default-preferences}}\label{\detokenize{administering/preferences:id1}}
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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Users}
\label{\detokenize{administering/users::doc}}\label{\detokenize{administering/users:users}}\label{\detokenize{administering/users:id1}}

\subsection{Creating Admin Users}
\label{\detokenize{administering/users:creating-admin-users}}\label{\detokenize{administering/users:defaultuser}}
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.


\subsection{Searching For Users}
\label{\detokenize{administering/users:searching-for-users}}\label{\detokenize{administering/users:user-account-search}}
If you have \sphinxcode{editusers} privileges or if you are allowed
to grant privileges for some groups, the \sphinxmenuselection{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 \DUrole{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 \sphinxstyleemphasis{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.


\subsection{Modifying Users}
\label{\detokenize{administering/users:modifyusers}}\label{\detokenize{administering/users:modifying-users}}
Once you have found your user, you can change the following
fields:
\begin{itemize}
\item {} 
\sphinxstyleemphasis{Login Name}:
This is generally the user's full email address. However, if you
have are using the \DUrole{param}{emailsuffix} parameter, this may
just be the user's login name. Unless you turn off the
\DUrole{param}{allowemailchange} parameter, users can change their
login names themselves (to any valid email address).

\item {} 
\sphinxstyleemphasis{Real Name}: The user's real name. Note that
Bugzilla does not require this to create an account.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{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
\sphinxcode{Bugmail Disabled} checkbox above.

\begin{sphinxadmonition}{note}{Note:}
Even users whose accounts have been disabled can still
submit bugs via the email gateway, if one exists.
The email gateway should \sphinxstyleemphasis{not} be
enabled for secure installations of Bugzilla.
\end{sphinxadmonition}

\begin{sphinxadmonition}{warning}{Warning:}
Don't disable all the administrator accounts!
\end{sphinxadmonition}

\item {} 
\sphinxstyleemphasis{\textless{}groupname\textgreater{}}:
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.

\item {} 
\sphinxstyleemphasis{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).

\item {} 
\sphinxstyleemphasis{creategroups}:
This option will allow a user to create and destroy groups in
Bugzilla.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{tweakparams}:
This flag allows a user to change Bugzilla's Params
(using \sphinxcode{editparams.cgi}.)

\item {} 
\sphinxstyleemphasis{\textless{}productname\textgreater{}}:
This allows an administrator to specify the products
in which a user can see bugs. If you turn on the
\DUrole{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 \DUrole{group}{editbugs}
privilege to edit bugs in these products.

\end{itemize}


\subsection{Creating New Users}
\label{\detokenize{administering/users:createnewusers}}\label{\detokenize{administering/users:creating-new-users}}

\subsubsection{Self-Registration}
\label{\detokenize{administering/users:self-registration}}\label{\detokenize{administering/users:id2}}
By default, users can create their own user accounts by clicking the
\sphinxcode{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 \DUrole{param}{createemailregexp}
parameter in the \sphinxcode{Configuration} page; see
{\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-ref}{Parameters}}}}.


\subsubsection{Administrator Registration}
\label{\detokenize{administering/users:administrator-registration}}\label{\detokenize{administering/users:user-account-creation}}
Users with \sphinxcode{editusers} privileges, such as administrators,
can create user accounts for other users:
\begin{enumerate}
\item {} 
After logging in, click the "Users" link at the footer of
the query page, and then click "Add a new user".

\item {} 
Fill out the form presented. This page is self-explanatory.
When done, click "Submit".

\begin{sphinxadmonition}{note}{Note:}
Adding a user this way will \sphinxstyleemphasis{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 \sphinxcode{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.
\end{sphinxadmonition}

\end{enumerate}


\subsection{Deleting Users}
\label{\detokenize{administering/users:user-account-deletion}}\label{\detokenize{administering/users:deleting-users}}
If the \DUrole{param}{allowuserdeletion} parameter is turned on (see
{\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-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!


\subsection{Impersonating Users}
\label{\detokenize{administering/users:impersonatingusers}}\label{\detokenize{administering/users:impersonating-users}}
There may be times when an administrator would like to do something as
another user.  The \sphinxstyleliteralstrong{sudo} feature may be used to do
this.

\begin{sphinxadmonition}{note}{Note:}
To use the sudo feature, you must be in the
\sphinxstyleemphasis{bz\_sudoers} group.  By default, all
administrators are in this group.
\end{sphinxadmonition}

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.

\begin{sphinxadmonition}{warning}{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.
\end{sphinxadmonition}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Classifications, Products, Components, Versions, and Milestones}
\label{\detokenize{administering/categorization:classifications-products-components-versions-and-milestones}}\label{\detokenize{administering/categorization:categorization}}\label{\detokenize{administering/categorization::doc}}
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.


\subsection{Classifications}
\label{\detokenize{administering/categorization:classifications}}\label{\detokenize{administering/categorization:id1}}
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
\sphinxcode{Common} classification, containing products representing units of
technology used in multiple games, and perhaps an \sphinxcode{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 \DUrole{param}{useclassification} parameter
in the \sphinxstyleemphasis{Bug Fields} section of {\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-ref}{Parameters}}}}.

Access to the administration of classifications is controlled using
the \sphinxstyleemphasis{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.


\subsection{Products}
\label{\detokenize{administering/categorization:id2}}\label{\detokenize{administering/categorization: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:
\begin{description}
\item[{Product}] \leavevmode
The name of the product

\item[{Description}] \leavevmode
A brief description of the product

\item[{Open for bug entry}] \leavevmode
Deselect this box to prevent new bugs from being
entered against this product.

\item[{Enable the UNCONFIRMED status in this product}] \leavevmode
Select this option if you want to use the UNCONFIRMED status
(see {\hyperref[\detokenize{administering/workflow:workflow}]{\sphinxcrossref{\DUrole{std,std-ref}{Workflow}}}})

\item[{Default milestone}] \leavevmode
Select the default milestone for this product.

\item[{Version}] \leavevmode
Specify the default version for this product.

\item[{Create chart datasets for this product}] \leavevmode
Select to make chart datasets available for this product.

\end{description}

It is compulsory to create at least one {\hyperref[\detokenize{administering/categorization:components}]{\sphinxcrossref{\DUrole{std,std-ref}{component}}}} 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 {\hyperref[\detokenize{administering/categorization:product-group-controls}]{\sphinxcrossref{\DUrole{std,std-ref}{Assigning Group Controls to Products}}}}.


\subsubsection{Creating New Products}
\label{\detokenize{administering/categorization:create-product}}\label{\detokenize{administering/categorization:creating-new-products}}
To create a new product:
\begin{enumerate}
\item {} 
Select \sphinxcode{Administration} from the footer and then
choose \sphinxcode{Products} from the main administration page.

\item {} 
Select the \sphinxcode{Add} link in the bottom right.

\item {} 
Enter the details as outlined above.

\end{enumerate}


\subsubsection{Editing Products}
\label{\detokenize{administering/categorization:editing-products}}\label{\detokenize{administering/categorization:edit-products}}
To edit an existing product, click the "Products" link from the
"Administration" page. If the \DUrole{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 \DUrole{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.


\subsubsection{Adding or Editing Components, Versions and Target Milestones}
\label{\detokenize{administering/categorization:adding-or-editing-components-versions-and-target-milestones}}\label{\detokenize{administering/categorization:comps-vers-miles-products}}
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 {\hyperref[\detokenize{administering/categorization:components}]{\sphinxcrossref{\DUrole{std,std-ref}{Components}}}}.

For more information on versions, see {\hyperref[\detokenize{administering/categorization:versions}]{\sphinxcrossref{\DUrole{std,std-ref}{Versions}}}}.

For more information on milestones, see {\hyperref[\detokenize{administering/categorization:milestones}]{\sphinxcrossref{\DUrole{std,std-ref}{Milestones}}}}.


\subsubsection{Assigning Group Controls to Products}
\label{\detokenize{administering/categorization:assigning-group-controls-to-products}}\label{\detokenize{administering/categorization:product-group-controls}}
On the \sphinxcode{Edit Product} page, there is a link called
\sphinxcode{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 {\hyperref[\detokenize{administering/groups:groups}]{\sphinxcrossref{\DUrole{std,std-ref}{Groups and Security}}}}.

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
{\hyperref[\detokenize{administering/categorization:group-control-examples}]{\sphinxcrossref{\DUrole{std,std-ref}{Common Applications of Group Controls}}}} for examples of
product and group relationships.

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}

If any group has \sphinxstyleemphasis{Entry} selected, then the
product will restrict bug entry to only those users
who are members of \sphinxstyleemphasis{all} the groups with
\sphinxstyleemphasis{Entry} selected.

If any group has \sphinxstyleemphasis{Canedit} selected,
then the product will be read-only for any users
who are not members of \sphinxstyleemphasis{all} of the groups with
\sphinxstyleemphasis{Canedit} selected. \sphinxstyleemphasis{Only} users who
are members of all the \sphinxstyleemphasis{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 \sphinxstyleemphasis{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 \sphinxstyleemphasis{editcomponents}
selected  allows users who are in this group to edit all
aspects of this product, including components, milestones,
and versions.

Any group having \sphinxstyleemphasis{canconfirm} selected
allows users who are in this group to confirm bugs
in this product.

Any group having \sphinxstyleemphasis{editbugs} selected allows
users who are in this group to edit all fields of
bugs in this product.

The \sphinxstyleemphasis{MemberControl} and
\sphinxstyleemphasis{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.


\subsubsection{Common Applications of Group Controls}
\label{\detokenize{administering/categorization:common-applications-of-group-controls}}\label{\detokenize{administering/categorization:group-control-examples}}
The use of groups is best explained by providing examples that illustrate
configurations for common use cases. The examples follow a common syntax:
\sphinxstyleemphasis{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.


\paragraph{Basic Product/Group Restriction}
\label{\detokenize{administering/categorization: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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Product} \PYG{n}{Bar}\PYG{p}{:}
\PYG{n}{foo}\PYG{p}{:} \PYG{n}{ENTRY}\PYG{p}{,} \PYG{n}{MANDATORY}\PYG{o}{/}\PYG{n}{MANDATORY}\PYG{p}{,} \PYG{n}{CANEDIT}
\end{sphinxVerbatim}

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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Product} \PYG{n}{Bar}\PYG{p}{:}
\PYG{n}{foo}\PYG{p}{:} \PYG{n}{ENTRY}\PYG{p}{,} \PYG{n}{SHOWN}\PYG{o}{/}\PYG{n}{SHOWN}\PYG{p}{,} \PYG{n}{EDITCOMPONENTS}\PYG{p}{,} \PYG{n}{CANCONFIRM}\PYG{p}{,} \PYG{n}{EDITBUGS}
\end{sphinxVerbatim}


\paragraph{General User Access With Security Group}
\label{\detokenize{administering/categorization: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":

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Product} \PYG{n}{A}\PYG{p}{:}
\PYG{n}{security}\PYG{p}{:} \PYG{n}{SHOWN}\PYG{o}{/}\PYG{n}{SHOWN}
\end{sphinxVerbatim}


\paragraph{General User Access With A Security Product}
\label{\detokenize{administering/categorization: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):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Product} \PYG{n}{Security}\PYG{p}{:}
\PYG{n}{securityworkers}\PYG{p}{:} \PYG{n}{DEFAULT}\PYG{o}{/}\PYG{n}{MANDATORY}
\end{sphinxVerbatim}


\paragraph{Product Isolation With a Common Group}
\label{\detokenize{administering/categorization: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:
\begin{enumerate}
\item {} 
Support Group: Contains members of the support staff.

\item {} 
AccessA Group: Contains users of product A and the Support group.

\item {} 
AccessB Group: Contains users of product B and the Support group.

\end{enumerate}

Once these three groups are defined, the product group controls
can be set to:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Product} \PYG{n}{A}\PYG{p}{:}
\PYG{n}{AccessA}\PYG{p}{:} \PYG{n}{ENTRY}\PYG{p}{,} \PYG{n}{MANDATORY}\PYG{o}{/}\PYG{n}{MANDATORY}
\PYG{n}{Product} \PYG{n}{B}\PYG{p}{:}
\PYG{n}{AccessB}\PYG{p}{:} \PYG{n}{ENTRY}\PYG{p}{,} \PYG{n}{MANDATORY}\PYG{o}{/}\PYG{n}{MANDATORY}
\end{sphinxVerbatim}

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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Product} \PYG{n}{A}\PYG{p}{:}
\PYG{n}{AccessA}\PYG{p}{:} \PYG{n}{ENTRY}\PYG{p}{,} \PYG{n}{MANDATORY}\PYG{o}{/}\PYG{n}{MANDATORY}
\PYG{n}{Support}\PYG{p}{:} \PYG{n}{SHOWN}\PYG{o}{/}\PYG{n}{NA}
\PYG{n}{Product} \PYG{n}{B}\PYG{p}{:}
\PYG{n}{AccessB}\PYG{p}{:} \PYG{n}{ENTRY}\PYG{p}{,} \PYG{n}{MANDATORY}\PYG{o}{/}\PYG{n}{MANDATORY}
\PYG{n}{Support}\PYG{p}{:} \PYG{n}{SHOWN}\PYG{o}{/}\PYG{n}{NA}
\PYG{n}{Product} \PYG{n}{Common}\PYG{p}{:}
\PYG{n}{Support}\PYG{p}{:} \PYG{n}{ENTRY}\PYG{p}{,} \PYG{n}{DEFAULT}\PYG{o}{/}\PYG{n}{MANDATORY}\PYG{p}{,} \PYG{n}{CANEDIT}
\end{sphinxVerbatim}


\paragraph{Make a Product Read Only}
\label{\detokenize{administering/categorization: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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Product} \PYG{n}{A}\PYG{p}{:}
\PYG{n}{ReadOnly}\PYG{p}{:} \PYG{n}{ENTRY}\PYG{p}{,} \PYG{n}{NA}\PYG{o}{/}\PYG{n}{NA}\PYG{p}{,} \PYG{n}{CANEDIT}
\end{sphinxVerbatim}

\begin{sphinxadmonition}{note}{Note:}
For more information on Groups outside of how they relate to products
see {\hyperref[\detokenize{administering/groups:groups}]{\sphinxcrossref{\DUrole{std,std-ref}{Groups and Security}}}}.
\end{sphinxadmonition}


\subsection{Components}
\label{\detokenize{administering/categorization:id3}}\label{\detokenize{administering/categorization: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 {\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-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 \sphinxstyleemphasis{default assignments};
these can be changed on bug submission, or at any later point in
a bug's life.

To create a new Component:
\begin{enumerate}
\item {} 
Select the \sphinxcode{Edit components} link
from the \sphinxcode{Edit product} page.

\item {} 
Select the \sphinxcode{Add} link in the bottom right.

\item {} 
Fill out the \sphinxcode{Component} field, a
short \sphinxcode{Description}, the
\sphinxcode{Default Assignee}, \sphinxcode{Default CC List},
and \sphinxcode{Default QA Contact} (if enabled).
The \sphinxcode{Component Description} field may contain a
limited subset of HTML tags. The \sphinxcode{Default Assignee}
field must be a login name already existing in the Bugzilla database.

\end{enumerate}


\subsection{Versions}
\label{\detokenize{administering/categorization:id4}}\label{\detokenize{administering/categorization: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:
\begin{enumerate}
\item {} 
From the "Edit product" screen, select "Edit Versions".

\item {} 
You will notice that the product already has the default
version "undefined". Click the "Add" link in the bottom right.

\item {} 
Enter the name of the Version. This field takes text only.
Then click the "Add" button.

\end{enumerate}


\subsection{Milestones}
\label{\detokenize{administering/categorization:milestones}}\label{\detokenize{administering/categorization:id5}}
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.

\begin{sphinxadmonition}{note}{Note:}
Milestone options will only appear for a Product if you turned
on the \DUrole{param}{usetargetmilestone} parameter in the "Bug Fields" tab of
the {\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-ref}{Parameters}}}} page.
\end{sphinxadmonition}

To create new Milestones and set Default Milestones:
\begin{enumerate}
\item {} 
Select "Edit milestones" from the "Edit product" page.

\item {} 
Select "Add" in the bottom right corner.

\item {} 
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".

\end{enumerate}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Flags}
\label{\detokenize{administering/flags:flags-admin}}\label{\detokenize{administering/flags:flags}}\label{\detokenize{administering/flags::doc}}
If you have the \DUrole{group}{editcomponents} permission, you can
edit Flag Types from the main administration page. Clicking the
\sphinxmenuselection{Flags} link will bring you to the \sphinxmenuselection{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.


\subsection{Flag Properties}
\label{\detokenize{administering/flags:flags-edit}}\label{\detokenize{administering/flags:flag-properties}}\begin{description}
\item[{Name}] \leavevmode
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.

\item[{Description}] \leavevmode
The description describes the flag in more detail. It is visible
in a tooltip when hovering over a flag either in the \sphinxmenuselection{Show Bug}
or \sphinxmenuselection{Edit Attachment} pages. This field can be as
long as you like and can contain any character you want.

\item[{Category}] \leavevmode
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 \sphinxcode{\_\_Any\_\_:\_\_Any\_\_}
is already entered in the \sphinxmenuselection{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 \sphinxcode{\_\_Any\_\_:\_\_Any\_\_} from the \sphinxmenuselection{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 \sphinxcode{\_\_Any\_\_} for Product translates to
"all the products in this Bugzilla".
Selecting  \sphinxcode{\_\_Any\_\_} in the Component field means
"all components in the selected product.")
Selections made, press \sphinxmenuselection{Include}, and your
Product/Component pairing will show up in the \sphinxmenuselection{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
\sphinxmenuselection{Exclude}. The Product/Component pairing will show up in the
\sphinxmenuselection{Exclusions} box on the right.

This flag \sphinxstyleemphasis{will} appear and \sphinxstyleemphasis{can} be set for any
products/components appearing in the \sphinxmenuselection{Inclusions} box
(or which fall under the appropriate \sphinxcode{\_\_Any\_\_}).
This flag \sphinxstyleemphasis{will not} appear (and therefore \sphinxstyleemphasis{cannot} be set) on
any products appearing in the \sphinxmenuselection{Exclusions} box.
\sphinxstyleemphasis{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.

\sphinxstyleemphasis{Example:} Let's say you have a product called
\sphinxcode{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 \sphinxcode{fixInNext}.
However, one component in \sphinxcode{Jet Plane} is
called \sphinxcode{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 \sphinxcode{Jet Plane:\_\_Any\_\_} and you exclude
\sphinxcode{Jet Plane:Pilot}.

\item[{Sort Key}] \leavevmode
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.

\item[{Active}] \leavevmode
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 \sphinxmenuselection{active}. Deactivated
flags will still show up in the UI if they are \sphinxcode{?}, \sphinxcode{+}, or \sphinxcode{-}, 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.

\item[{Requestable}] \leavevmode
New flags are, by default, "requestable", meaning that they
offer users the \sphinxcode{?} option, as well as \sphinxcode{+}
and \sphinxcode{-}.
To remove the \sphinxcode{?} option, uncheck "requestable".

\item[{Specifically Requestable}] \leavevmode
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).

\item[{Multiplicable}] \leavevmode
Any flag with \sphinxmenuselection{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.

\item[{CC List}] \leavevmode
If you want certain users to be notified every time this flag is
set to \sphinxcode{?}, \sphinxcode{-}, or \sphinxcode{+}, or is unset, add them here. This is a comma-separated
list of email addresses that need not be restricted to Bugzilla usernames.

\item[{Grant Group}] \leavevmode
When this field is set to some given group, only users in the group
can set the flag to \sphinxcode{+} and \sphinxcode{-}. This
field does not affect who can request or cancel the flag. For that,
see the \sphinxmenuselection{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.

\item[{Request Group}] \leavevmode
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 \sphinxmenuselection{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.

\end{description}


\subsection{Deleting a Flag}
\label{\detokenize{administering/flags:flags-delete}}\label{\detokenize{administering/flags:deleting-a-flag}}
When you are at the \sphinxmenuselection{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 \sphinxmenuselection{Delete} link next to
the flag description.

\begin{sphinxadmonition}{warning}{Warning:}
Once you delete a flag, it is \sphinxstyleemphasis{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 \sphinxmenuselection{active} in the flag Edit form.
\end{sphinxadmonition}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Custom Fields}
\label{\detokenize{administering/custom-fields:custom-fields}}\label{\detokenize{administering/custom-fields::doc}}\label{\detokenize{administering/custom-fields:id1}}
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.

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}

Administrators can manage Custom Fields using the
\sphinxcode{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".


\subsection{Adding Custom Fields}
\label{\detokenize{administering/custom-fields:adding-custom-fields}}\label{\detokenize{administering/custom-fields:add-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:
\begin{itemize}
\item {} 
\sphinxstyleemphasis{Name:}
The name of the field in the database, used internally. This name
MUST begin with \sphinxcode{cf\_} to prevent confusion with
standard fields. If this string is omitted, it will
be automatically added to the name entered.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{Type:}
The type of field to create. There are
several types available:
\begin{description}
\item[{Bug ID:}] \leavevmode
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.

\item[{Large Text Box:}] \leavevmode
A multiple line box for entering free text.

\item[{Free Text:}] \leavevmode
A single line box for entering free text.

\item[{Multiple-Selection Box:}] \leavevmode
A list box where multiple options
can be selected. After creating this field, it must be edited
to add the selection options. See
{\hyperref[\detokenize{administering/field-values:edit-values-list}]{\sphinxcrossref{\DUrole{std,std-ref}{Viewing/Editing Legal Values}}}} for information about
editing legal values.

\item[{Drop Down:}] \leavevmode
A list box where only one option can be selected.
After creating this field, it must be edited to add the
selection options. See
{\hyperref[\detokenize{administering/field-values:edit-values-list}]{\sphinxcrossref{\DUrole{std,std-ref}{Viewing/Editing Legal Values}}}} for information about
editing legal values.

\item[{Date/Time:}] \leavevmode
A date field. This field appears with a
calendar widget for choosing the date.

\end{description}

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{Reverse Relationship Description:}
When the custom field is of type \sphinxcode{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.

\item {} 
\sphinxstyleemphasis{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 {\hyperref[\detokenize{using/filing:filing}]{\sphinxcrossref{\DUrole{std,std-ref}{Filing a Bug}}}}
for information about filing bugs.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{Is obsolete:}
Boolean that determines whether this field should
be displayed at all. Obsolete Custom Fields are hidden.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{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.

\item {} 
\sphinxstyleemphasis{Field that controls the values that appear in this field:}
When the custom field is of type \sphinxcode{Drop Down} or
\sphinxcode{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 \sphinxcode{Field only appears when}
setting. For instance, you may decide that some given value
\sphinxcode{valueY} is only available when the bug status
is RESOLVED while the value \sphinxcode{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
{\hyperref[\detokenize{administering/field-values:edit-values-list}]{\sphinxcrossref{\DUrole{std,std-ref}{Viewing/Editing Legal Values}}}}.

\end{itemize}


\subsection{Editing Custom Fields}
\label{\detokenize{administering/custom-fields:edit-custom-fields}}\label{\detokenize{administering/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 {\hyperref[\detokenize{administering/field-values:edit-values-list}]{\sphinxcrossref{\DUrole{std,std-ref}{Viewing/Editing Legal Values}}}}. All
other attributes can be edited as described above.


\subsection{Deleting Custom Fields}
\label{\detokenize{administering/custom-fields:deleting-custom-fields}}\label{\detokenize{administering/custom-fields:delete-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 \sphinxcode{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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Field Values}
\label{\detokenize{administering/field-values:id1}}\label{\detokenize{administering/field-values::doc}}\label{\detokenize{administering/field-values:field-values}}
Legal values for the operating system, platform, bug priority and
severity, and custom fields of type \sphinxcode{Drop Down} and
\sphinxcode{Multiple-Selection Box} (see {\hyperref[\detokenize{administering/custom-fields:custom-fields}]{\sphinxcrossref{\DUrole{std,std-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.


\subsection{Viewing/Editing Legal Values}
\label{\detokenize{administering/field-values:viewing-editing-legal-values}}\label{\detokenize{administering/field-values:edit-values-list}}
Editing legal values requires \sphinxcode{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.


\subsection{Deleting Legal Values}
\label{\detokenize{administering/field-values:deleting-legal-values}}\label{\detokenize{administering/field-values:edit-values-delete}}
Legal values from Custom Fields can be deleted, but only if the
following two conditions are respected:
\begin{enumerate}
\item {} 
The value is not set as the default for the field.

\item {} 
No bug is currently using this value.

\end{enumerate}

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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Workflow}
\label{\detokenize{administering/workflow:id1}}\label{\detokenize{administering/workflow::doc}}\label{\detokenize{administering/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 {\hyperref[\detokenize{administering/field-values:field-values}]{\sphinxcrossref{\DUrole{std,std-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 {\hyperref[\detokenize{administering/categorization:categorization}]{\sphinxcrossref{\DUrole{std,std-ref}{Classifications, Products, Components, Versions, and Milestones}}}}).
The status referred to by the \DUrole{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
\sphinxhref{https://bugzilla.mozilla.org/show\_bug.cgi?id=1007605}{bug 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 \DUrole{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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Groups and Security}
\label{\detokenize{administering/groups:groups-and-security}}\label{\detokenize{administering/groups::doc}}\label{\detokenize{administering/groups:groups}}
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:
\begin{enumerate}
\item {} 
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.

\item {} 
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 {\hyperref[\detokenize{administering/parameters:param-group-security}]{\sphinxcrossref{\DUrole{std,std-ref}{Group Security}}}}.

\item {} 
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 {\hyperref[\detokenize{administering/categorization:product-group-controls}]{\sphinxcrossref{\DUrole{std,std-ref}{Assigning Group Controls to Products}}}}.

\item {} 
Group access for users. See {\hyperref[\detokenize{administering/groups:users-and-groups}]{\sphinxcrossref{\DUrole{std,std-ref}{Assigning Users to Groups}}}} for
details on how users are assigned group access.

\end{enumerate}

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 \sphinxstyleemphasis{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 {\hyperref[\detokenize{administering/categorization:product-group-controls}]{\sphinxcrossref{\DUrole{std,std-ref}{Assigning Group Controls to Products}}}}.

\begin{sphinxadmonition}{note}{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 \sphinxcode{Users in the roles selected below...}
and un-checking the box next to either 'Reporter' or 'CC List' (or both).
\end{sphinxadmonition}


\subsection{Creating Groups}
\label{\detokenize{administering/groups:create-groups}}\label{\detokenize{administering/groups:creating-groups}}
To create a new group, follow the steps below:
\begin{enumerate}
\item {} 
Select the \sphinxcode{Administration} link in the page footer,
and then select the \sphinxcode{Groups} link from the
Administration page.

\item {} 
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
\sphinxcode{Add Group} link under the table of existing groups.

\item {} 
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).

\begin{sphinxadmonition}{note}{Note:}
If \sphinxcode{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.
\end{sphinxadmonition}

\begin{sphinxadmonition}{warning}{Warning:}
If specifying a domain in the regular expression, end
the regexp with a "\$". Otherwise, when granting access to
"@mycompany\textbackslash{}.com", access will also be granted to
\sphinxhref{mailto:'badperson@mycompany.com.cracker.net}{'badperson@mycompany.com.cracker.net}'. Use the syntax,
\sphinxhref{mailto:'@mycompany}{'@mycompany}\textbackslash{}.com\$' for the regular expression.
\end{sphinxadmonition}

\item {} 
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 {\hyperref[\detokenize{administering/groups:edit-groups}]{\sphinxcrossref{\DUrole{std,std-ref}{Editing Groups and Assigning Group Permissions}}}}.

\end{enumerate}


\subsection{Editing Groups and Assigning Group Permissions}
\label{\detokenize{administering/groups:editing-groups-and-assigning-group-permissions}}\label{\detokenize{administering/groups:edit-groups}}
To access the "Edit Groups" page, select the
\sphinxcode{Administration} link in the page footer,
and then select the \sphinxcode{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 \DUrole{param}{usevisibilitygroups} parameter is in use (see
{\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-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 \sphinxstyleemphasis{inheritance}.
Each of the six permissions is described below.
\begin{description}
\item[{\sphinxstyleemphasis{Groups That Are a Member of This Group}}] \leavevmode
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.

\item[{\sphinxstyleemphasis{Groups That This Group Is a Member Of}}] \leavevmode
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.

\item[{\sphinxstyleemphasis{Groups That Can Grant Membership in This Group}}] \leavevmode
The members of any group selected here will be able add users
to this group, even if they themselves are not in this group.

\item[{\sphinxstyleemphasis{Groups That This Group Can Grant Membership In}}] \leavevmode
Members of this group can add users to any group selected here,
even if they themselves are not in the selected groups.

\item[{\sphinxstyleemphasis{Groups That Can See This Group}}] \leavevmode
Members of any selected group can see the users in this group.
This setting is only visible if the \DUrole{param}{usevisibilitygroups} parameter
is enabled on the Bugzilla Configuration page. See
{\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-ref}{Parameters}}}} for information on configuring Bugzilla.

\item[{\sphinxstyleemphasis{Groups That This Group Can See}}] \leavevmode
Members of this group can see members in any of the selected groups.
This setting is only visible if the \DUrole{param}{usevisibilitygroups} parameter
is enabled on the the Bugzilla Configuration page. See
{\hyperref[\detokenize{administering/parameters:parameters}]{\sphinxcrossref{\DUrole{std,std-ref}{Parameters}}}} for information on configuring Bugzilla.

\end{description}


\subsection{Assigning Users to Groups}
\label{\detokenize{administering/groups:assigning-users-to-groups}}\label{\detokenize{administering/groups:users-and-groups}}
A User can become a member of a group in several ways:
\begin{enumerate}
\item {} 
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 {\hyperref[\detokenize{administering/users:users}]{\sphinxcrossref{\DUrole{std,std-ref}{Users}}}}.

\item {} 
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 {\hyperref[\detokenize{administering/groups:edit-groups}]{\sphinxcrossref{\DUrole{std,std-ref}{Editing Groups and Assigning Group Permissions}}}} for details on group inheritance.

\item {} 
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 {\hyperref[\detokenize{administering/groups:create-groups}]{\sphinxcrossref{\DUrole{std,std-ref}{Creating Groups}}}} for details on
the regular expression option when creating groups.

\end{enumerate}


\subsection{Assigning Group Controls to Products}
\label{\detokenize{administering/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 {\hyperref[\detokenize{administering/categorization:product-group-controls}]{\sphinxcrossref{\DUrole{std,std-ref}{Assigning Group Controls to Products}}}}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Keywords}
\label{\detokenize{administering/keywords:keywords}}\label{\detokenize{administering/keywords::doc}}\label{\detokenize{administering/keywords:id1}}
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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Whining}
\label{\detokenize{administering/whining:whining}}\label{\detokenize{administering/whining::doc}}\label{\detokenize{administering/whining:id1}}
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.

\begin{sphinxadmonition}{warning}{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.
\end{sphinxadmonition}

\begin{sphinxadmonition}{note}{Note:}
For whining to work, a special Perl script must be executed at regular
intervals.  More information on this is available in {\hyperref[\detokenize{installing/optional-post-install-config:installation-whining}]{\sphinxcrossref{\DUrole{std,std-ref}{Whining}}}}.
\end{sphinxadmonition}

\begin{sphinxadmonition}{note}{Note:}
This section does not cover the whineatnews.pl script.
See {\hyperref[\detokenize{installing/optional-post-install-config:installation-whining-cron}]{\sphinxcrossref{\DUrole{std,std-ref}{Whining at Untriaged Bugs}}}} for more information on
The Whining Cron.
\end{sphinxadmonition}


\subsection{The Event}
\label{\detokenize{administering/whining:the-event}}\label{\detokenize{administering/whining:whining-overview}}
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).


\subsection{Whining Schedule}
\label{\detokenize{administering/whining:id2}}\label{\detokenize{administering/whining: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.

\begin{sphinxadmonition}{warning}{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.
\end{sphinxadmonition}

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.

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}


\subsection{Whining Searches}
\label{\detokenize{administering/whining:whining-searches}}\label{\detokenize{administering/whining:whining-query}}
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 {\hyperref[\detokenize{using/finding:list}]{\sphinxcrossref{\DUrole{std,std-ref}{Bug Lists}}}}).

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}

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.

\begin{sphinxadmonition}{warning}{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!
\end{sphinxadmonition}


\subsection{Saving Your Changes}
\label{\detokenize{administering/whining: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.

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Quips}
\label{\detokenize{administering/quips::doc}}\label{\detokenize{administering/quips:quips}}\label{\detokenize{administering/quips:id1}}
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 \DUrole{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 \sphinxstyleemphasis{display\_quips}
user preference.  Possible values are "on" and "off".


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Installed Extensions}
\label{\detokenize{administering/extensions:installed-extensions-admin}}\label{\detokenize{administering/extensions::doc}}\label{\detokenize{administering/extensions:installed-extensions}}
Bugzilla can be enhanced using extensions (see {\hyperref[\detokenize{integrating/extensions:extensions}]{\sphinxcrossref{\DUrole{std,std-ref}{Extensions}}}}). If an
extension comes with documentation in the appropriate format, and you build
your own copy of the Bugzilla documentation using \sphinxcode{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):


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{Integration and Customization Guide}
\label{\detokenize{integrating/index:integration-and-customization-guide}}\label{\detokenize{integrating/index::doc}}\label{\detokenize{integrating/index:integrating}}
You may find that Bugzilla already does what you want it to do, you just
need to configure it correctly. Read the {\hyperref[\detokenize{administering/index:administering}]{\sphinxcrossref{\DUrole{std,std-ref}{Administration Guide}}}} 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.


\section{Customization FAQ}
\label{\detokenize{integrating/faq::doc}}\label{\detokenize{integrating/faq:customization-faq}}\label{\detokenize{integrating/faq:id1}}
How do I...
\begin{description}
\item[{...add a new field on a bug?}] \leavevmode
Use {\hyperref[\detokenize{administering/custom-fields:custom-fields}]{\sphinxcrossref{\DUrole{std,std-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 {\hyperref[\detokenize{integrating/templates:custom-bug-entry}]{\sphinxcrossref{\DUrole{std,std-ref}{custom bug entry form}}}}.

\item[{...change the name of a built-in bug field?}] \leavevmode
{\hyperref[\detokenize{integrating/templates:templates}]{\sphinxcrossref{\DUrole{std,std-ref}{Edit}}}} the relevant value in the template
\sphinxcode{template/en/default/global/field-descs.none.tmpl}.

\item[{...use a word other than 'bug' to describe bugs?}] \leavevmode
{\hyperref[\detokenize{integrating/templates:templates}]{\sphinxcrossref{\DUrole{std,std-ref}{Edit or override}}}} the appropriate values in the template
\sphinxcode{template/en/default/global/variables.none.tmpl}.

\item[{...call the system something other than 'Bugzilla'?}] \leavevmode
{\hyperref[\detokenize{integrating/templates:templates}]{\sphinxcrossref{\DUrole{std,std-ref}{Edit or override}}}} the appropriate value in the template
\sphinxcode{template/en/default/global/variables.none.tmpl}.

\item[{...alter who can change what field when?}] \leavevmode
See {\hyperref[\detokenize{integrating/extensions:who-can-change-what}]{\sphinxcrossref{\DUrole{std,std-ref}{Altering Who Can Change What}}}}.

\end{description}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Languages}
\label{\detokenize{integrating/languages:languages}}\label{\detokenize{integrating/languages::doc}}
Bugzilla's templates can be localized, although it's a \sphinxhref{https://wiki.mozilla.org/Bugzilla:L10n:Guide}{big job}. 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
\sphinxcode{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 \sphinxcode{Accept-Language} header.

Many language templates can be obtained from
\sphinxhref{http://www.bugzilla.org/download.html\#localizations}{the localization section of the Bugzilla website}. Instructions
for submitting new languages are also available from that location. There's
also a \sphinxhref{https://wiki.mozilla.org/Bugzilla:L10n:Localization\_Teams}{list of localization teams}; you might
want to contact someone to ask about the status of their localization.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Skins}
\label{\detokenize{integrating/skins:id1}}\label{\detokenize{integrating/skins::doc}}\label{\detokenize{integrating/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
\sphinxhref{https://wiki.mozilla.org/Bugzilla:Addons\#Skins}{on the wiki}, and there
are a couple more which are part of
\sphinxhref{http://git.mozilla.org/?p=webtools/bmo/bugzilla.git}{bugzilla.mozilla.org}.
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 \sphinxcode{skins/standard/}, and put your directory in
\sphinxcode{skins/contrib/}. Then, add your CSS to the appropriate files.

After you put the directory there, make sure to run \sphinxcode{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 \sphinxmenuselection{Preferences}, on the \sphinxmenuselection{General} tab. If you would
like to force a particular skin on all users, just select that skin in the
\sphinxmenuselection{Default Preferences} in the \sphinxmenuselection{Administration} UI, and
then uncheck "Enabled" on the preference, so users cannot change it.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Templates}
\label{\detokenize{integrating/templates:templates}}\label{\detokenize{integrating/templates::doc}}\label{\detokenize{integrating/templates:id1}}
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 {\hyperref[\detokenize{integrating/extensions:extensions}]{\sphinxcrossref{\DUrole{std,std-ref}{extension}}}} to add or modify the
behaviour of templates using a stable interface.


\subsection{Template Directory Structure}
\label{\detokenize{integrating/templates:template-directory-structure}}\label{\detokenize{integrating/templates:template-directory}}
The template directory structure starts with top level directory
named \sphinxcode{template}, which contains a directory
for each installed localization. Bugzilla comes with English
templates, so the directory name is \sphinxcode{en},
and we will discuss \sphinxcode{template/en} throughout
the documentation. Below \sphinxcode{template/en} is the
\sphinxcode{default} directory, which contains all the
standard templates shipped with Bugzilla.

\begin{sphinxadmonition}{warning}{Warning:}
A directory \sphinxcode{data/template} also exists;
this is where Template Toolkit puts the compiled versions (i.e. Perl code)
of the templates. \sphinxstyleemphasis{Do not} directly edit the files in this
directory, or all your changes will be lost the next time
Template Toolkit recompiles the templates.
\end{sphinxadmonition}


\subsection{Choosing a Customization Method}
\label{\detokenize{integrating/templates:choosing-a-customization-method}}\label{\detokenize{integrating/templates:template-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.
\begin{enumerate}
\item {} 
You can directly edit the templates found in \sphinxcode{template/en/default}.

\item {} 
You can copy the templates to be modified into a mirrored directory
structure under \sphinxcode{template/en/custom}. Templates in this
directory structure automatically override any identically-named
and identically-located templates in the
\sphinxcode{template/en/default} directory. (The \sphinxcode{custom} directory does
not exist by default and must be created if you want to use it.)

\item {} 
You can use the hooks built into many of the templates to add or modify
the UI from an {\hyperref[\detokenize{integrating/extensions:extensions}]{\sphinxcrossref{\DUrole{std,std-ref}{extension}}}}. Hooks generally don't go away
and have a stable interface.

\end{enumerate}

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 \sphinxcode{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 \sphinxcode{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
\sphinxcode{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, \sphinxstyleliteralstrong{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 \sphinxstyleliteralstrong{git diff}, which you
can't if you fork the file into the \sphinxcode{custom} directory.


\subsection{How To Edit Templates}
\label{\detokenize{integrating/templates:how-to-edit-templates}}\label{\detokenize{integrating/templates:template-edit}}
\begin{sphinxadmonition}{note}{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
\sphinxhref{http://www.bugzilla.org/docs/developer.html}{Developers' Guide}.
\end{sphinxadmonition}

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 \sphinxhref{http://www.template-toolkit.org}{Template Toolkit home page}.

One thing you should take particular care about is the need
to properly HTML filter data that has been passed into the template.
This means that if the data can possibly contain special HTML characters
such as \sphinxcode{\textless{}}, and the data was not intended to be HTML, they need to be
converted to entity form, i.e. \sphinxcode{\&lt;}.  You use the \sphinxcode{html} filter in the
Template Toolkit to do this (or the \sphinxcode{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 \sphinxstyleliteralstrong{./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.


\subsection{Template Formats and Types}
\label{\detokenize{integrating/templates:template-formats}}\label{\detokenize{integrating/templates:template-formats-and-types}}
Some CGI's have the ability to use more than one template. For example,
\sphinxcode{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 {\hyperref[\detokenize{api/index:apis}]{\sphinxcrossref{\DUrole{std,std-ref}{WebService API Reference}}}} to integrate with
Bugzilla.

To see if a CGI supports multiple output formats and types, grep the
CGI for \sphinxcode{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. \sphinxcode{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
\sphinxcode{Bugzilla/Constants.pm} file in the \sphinxcode{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
\sphinxcode{\textless{}stubname\textgreater{}-\textless{}formatname\textgreater{}.\textless{}contenttypetag\textgreater{}.tmpl}.
Try out the template by calling the CGI as
\sphinxcode{\textless{}cginame\textgreater{}.cgi?format=\textless{}formatname\textgreater{}}. Add \sphinxcode{\&ctype=\textless{}type\textgreater{}} if the type is
not HTML.


\subsection{Particular Templates}
\label{\detokenize{integrating/templates:template-specific}}\label{\detokenize{integrating/templates:particular-templates}}
There are a few templates you may be particularly interested in
customizing for your installation.
\begin{description}
\item[{\sphinxcode{index.html.tmpl}:}] \leavevmode
This is the Bugzilla front page.

\item[{\sphinxcode{global/header.html.tmpl}:}] \leavevmode
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.

\item[{\sphinxcode{global/banner.html.tmpl}:}] \leavevmode
This contains the \sphinxcode{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.

\item[{\sphinxcode{global/footer.html.tmpl}:}] \leavevmode
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.

\item[{\sphinxcode{global/variables.none.tmpl}:}] \leavevmode
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").

\item[{\sphinxcode{list/table.html.tmpl}:}] \leavevmode
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.

\item[{\sphinxcode{bug/create/user-message.html.tmpl}:}] \leavevmode
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.

\item[{\sphinxcode{bug/process/midair.html.tmpl}:}] \leavevmode
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.

\end{description}
\phantomsection\label{\detokenize{integrating/templates:custom-bug-entry}}\begin{description}
\item[{\sphinxcode{bug/create/create.html.tmpl} and \sphinxcode{bug/create/comment.txt.tmpl}:}] \leavevmode
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 \sphinxhref{http://landfill.bugzilla.org/bugzilla-tip/enter\_bug.cgi?product=WorldControl;format=guided}{guided bug submission form}.
The code for this comes with the Bugzilla distribution as an example for
you to copy. It can be found in the files
\sphinxcode{create-guided.html.tmpl} and \sphinxcode{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 \sphinxcode{create-guided.html.tmpl}, then

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{o}{\PYGZlt{}}\PYG{n+nb}{input} \PYG{n+nb}{type}\PYG{o}{=}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{hidden}\PYG{l+s+s2}{\PYGZdq{}} \PYG{n}{name}\PYG{o}{=}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{format}\PYG{l+s+s2}{\PYGZdq{}} \PYG{n}{value}\PYG{o}{=}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{guided}\PYG{l+s+s2}{\PYGZdq{}}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

is used inside the form.

So to use this feature, create a custom template for
\sphinxcode{enter\_bug.cgi}. The default template, on which you
could base it, is
\sphinxcode{default/bug/create/create.html.tmpl}.
Call it \sphinxcode{custom/bug/create/create-\textless{}formatname\textgreater{}.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
\sphinxcode{default/bug/create/comment.txt.tmpl}, and call it
\sphinxcode{custom/bug/create/comment-\textless{}formatname\textgreater{}.txt.tmpl}.
It needs a couple of lines of boilerplate at the top like this:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}\PYG{o}{\PYGZpc{}} \PYG{n}{USE} \PYG{n}{Bugzilla} \PYG{o}{\PYGZpc{}}\PYG{p}{]}
\PYG{p}{[}\PYG{o}{\PYGZpc{}} \PYG{n}{cgi} \PYG{o}{=} \PYG{n}{Bugzilla}\PYG{o}{.}\PYG{n}{cgi} \PYG{o}{\PYGZpc{}}
\end{sphinxVerbatim}

Then, this template can reference the form fields you have created using
the syntax \sphinxcode{{[}\% 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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{o}{\PYGZlt{}}\PYG{n+nb}{input} \PYG{n+nb}{type}\PYG{o}{=}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{text}\PYG{l+s+s2}{\PYGZdq{}} \PYG{n}{name}\PYG{o}{=}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{buildid}\PYG{l+s+s2}{\PYGZdq{}} \PYG{n}{size}\PYG{o}{=}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{30}\PYG{l+s+s2}{\PYGZdq{}}\PYG{o}{\PYGZgt{}}
\end{sphinxVerbatim}

and then your comment.txt.tmpl had:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}\PYG{o}{\PYGZpc{}} \PYG{n}{USE} \PYG{n}{Bugzilla} \PYG{o}{\PYGZpc{}}\PYG{p}{]}
\PYG{p}{[}\PYG{o}{\PYGZpc{}} \PYG{n}{cgi} \PYG{o}{=} \PYG{n}{Bugzilla}\PYG{o}{.}\PYG{n}{cgi} \PYG{o}{\PYGZpc{}}\PYG{p}{]}
\PYG{n}{Build} \PYG{n}{Identifier}\PYG{p}{:} \PYG{p}{[}\PYG{o}{\PYGZpc{}}\PYG{o}{+} \PYG{n}{cgi}\PYG{o}{.}\PYG{n}{param}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{buildid}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)} \PYG{o}{\PYGZpc{}}\PYG{p}{]}
\end{sphinxVerbatim}

then something like:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{Build} \PYG{n}{Identifier}\PYG{p}{:} \PYG{l+m+mi}{20140303}
\end{sphinxVerbatim}

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.

\end{description}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{Extensions}
\label{\detokenize{integrating/extensions:extensions}}\label{\detokenize{integrating/extensions::doc}}\label{\detokenize{integrating/extensions:id1}}
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
\sphinxhref{https://wiki.mozilla.org/Bugzilla:Addons}{list of available extensions}
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 \sphinxhref{http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/Extension.html}{Bugzilla Extension
documentation}
for the core documentation on how to do that. It would make sense to read
the section on {\hyperref[\detokenize{integrating/templates:templates}]{\sphinxcrossref{\DUrole{std,std-ref}{Templates}}}}. There is also a sample extension in
\sphinxcode{\$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.


\subsection{Adding A New Page to Bugzilla}
\label{\detokenize{integrating/extensions: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 \sphinxcode{page.cgi} and the \sphinxcode{page\_before\_template} hook.


\subsection{Altering Data On An Existing Page}
\label{\detokenize{integrating/extensions:altering-data-on-an-existing-page}}
The \sphinxcode{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.


\subsection{Adding New Fields To Bugs}
\label{\detokenize{integrating/extensions:adding-new-fields-to-bugs}}
To add new fields to a bug, you need to do the following:
\begin{itemize}
\item {} 
Add an \sphinxcode{install\_update\_db} hook to add the fields by calling
\sphinxcode{Bugzilla::Field-\textgreater{}create} (only if the field doesn't already exist).
Here's what it might look like for a single field:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{my} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{field} \PYG{o}{=} \PYG{k}{new} \PYG{n+nn}{Bugzilla::}\PYG{n}{Field}\PYG{p}{(}\PYG{p}{\PYGZob{}} \PYG{n}{name} \PYG{o}{=}\PYG{o}{\PYGZgt{}} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{name} \PYG{p}{\PYGZcb{}}\PYG{p}{)}\PYG{p}{;}
\PYG{k}{return} \PYG{k}{if} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{field}\PYG{p}{;}

\PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{field} \PYG{o}{=} \PYG{n+nn}{Bugzilla::Field}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{n}{create}\PYG{p}{(}\PYG{p}{\PYGZob{}}
    \PYG{n}{name}        \PYG{o}{=}\PYG{o}{\PYGZgt{}} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{name}\PYG{p}{,}
    \PYG{n}{description} \PYG{o}{=}\PYG{o}{\PYGZgt{}} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{description}\PYG{p}{,}
    \PYG{n}{type}        \PYG{o}{=}\PYG{o}{\PYGZgt{}} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{type}\PYG{p}{,}        \PYG{c+c1}{\PYGZsh{} From list in Constants.pm}
    \PYG{n}{enter\PYGZus{}bug}   \PYG{o}{=}\PYG{o}{\PYGZgt{}} \PYG{l+m+mi}{0}\PYG{p}{,}
    \PYG{n}{buglist}     \PYG{o}{=}\PYG{o}{\PYGZgt{}} \PYG{l+m+mi}{0}\PYG{p}{,}
    \PYG{n}{custom}      \PYG{o}{=}\PYG{o}{\PYGZgt{}} \PYG{l+m+mi}{1}\PYG{p}{,}
\PYG{p}{\PYGZcb{}}\PYG{p}{)}\PYG{p}{;}
\end{sphinxVerbatim}

\item {} 
Push the name of the field onto the relevant arrays in the \sphinxcode{bug\_columns}
and \sphinxcode{bug\_fields} hooks.

\item {} 
If you want direct accessors, or other functions on the object, you need to
add a BEGIN block to your Extension.pm:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{BEGIN} \PYG{p}{\PYGZob{}}
   \PYG{o}{*}\PYG{n+nn}{Bugzilla::Bug::}\PYG{n}{is\PYGZus{}foopy} \PYG{o}{=} \PYG{o}{\PYGZbs{}}\PYG{o}{\PYGZam{}}\PYG{n}{\PYGZus{}bug\PYGZus{}is\PYGZus{}foopy}\PYG{p}{;}
\PYG{p}{\PYGZcb{}}

\PYG{o}{...}

\PYG{k}{sub} \PYG{n+nf}{\PYGZus{}bug\PYGZus{}is\PYGZus{}foopy} \PYG{p}{\PYGZob{}}
    \PYG{k}{return} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{\PYGZus{}}\PYG{p}{[}\PYG{l+m+mi}{0}\PYG{p}{]}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{p}{\PYGZob{}}\PYG{l+s}{\PYGZsq{}is\PYGZus{}foopy\PYGZsq{}}\PYG{p}{\PYGZcb{}}\PYG{p}{;}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\item {} 
You don't have to change \sphinxcode{Bugzilla/DB/Schema.pm}.

\item {} 
You can use \sphinxcode{bug\_end\_of\_create}, \sphinxcode{bug\_end\_of\_create\_validators}, and
\sphinxcode{bug\_end\_of\_update} to create or update the values for your new field.

\end{itemize}


\subsection{Adding New Fields To Other Things}
\label{\detokenize{integrating/extensions: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:
\begin{itemize}
\item {} 
In \sphinxcode{install\_update\_db}, use \sphinxcode{bz\_add\_column} instead

\item {} 
Push on the columns in \sphinxcode{object\_columns} and \sphinxcode{object\_update\_columns}
instead of \sphinxcode{bug\_columns}.

\item {} 
Add validators for the values in \sphinxcode{object\_validators}

\end{itemize}

The process for adding accessor functions is the same.

You can use the hooks \sphinxcode{object\_end\_of\_create},
\sphinxcode{object\_end\_of\_create\_validators}, \sphinxcode{object\_end\_of\_set\_all}, and
\sphinxcode{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 \sphinxcode{products} table:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{sub} \PYG{n+nf}{object\PYGZus{}end\PYGZus{}of\PYGZus{}create} \PYG{p}{\PYGZob{}}
    \PYG{k}{my} \PYG{p}{(}\PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{self}\PYG{p}{,} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{args}\PYG{p}{)} \PYG{o}{=} \PYG{n+nv}{@}\PYG{n+nv}{\PYGZus{}}\PYG{p}{;}
    \PYG{k}{my} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{class} \PYG{o}{=} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{args}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{p}{\PYGZob{}}\PYG{l+s}{\PYGZsq{}class\PYGZsq{}}\PYG{p}{\PYGZcb{}}\PYG{p}{;}
    \PYG{k}{my} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{object} \PYG{o}{=} \PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{args}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{p}{\PYGZob{}}\PYG{l+s}{\PYGZsq{}object\PYGZsq{}}\PYG{p}{\PYGZcb{}}\PYG{p}{;}
    \PYG{k}{if} \PYG{p}{(}\PYG{n+nv}{\PYGZdl{}}\PYG{n+nv}{class}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{n}{isa}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}Bugzilla::Product\PYGZsq{}}\PYG{p}{)} \PYG{p}{\PYGZob{}}
        \PYG{p}{[}\PYG{o}{...}\PYG{p}{]}
    \PYG{p}{\PYGZcb{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

You will need to do this filtering for most of the hooks whose names begin with
\sphinxcode{object\_}.


\subsection{Adding Admin Configuration Panels}
\label{\detokenize{integrating/extensions: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 \sphinxcode{config\_add\_panels} hook, you will need a template to
define the UI strings for the panel. See the templates in
\sphinxcode{template/en/default/admin/params} for examples, and put your own
template in \sphinxcode{template/en/default/admin/params} in your extension's
directory.

You can access param values from Templates using:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}\PYG{o}{\PYGZpc{}} \PYG{n}{Param}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{param\PYGZus{}name}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} \PYG{o}{\PYGZpc{}}\PYG{p}{]}
\end{sphinxVerbatim}

and from code using:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nn}{Bugzilla}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{n+nn}{params}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZgt{}}\PYG{p}{\PYGZob{}}\PYG{l+s}{\PYGZsq{}param\PYGZus{}name\PYGZsq{}}\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\subsection{Adding User Preferences}
\label{\detokenize{integrating/extensions:adding-user-preferences}}
To add a new user preference:
\begin{itemize}
\item {} 
Call \sphinxcode{add\_setting('setting\_name', {[}'some\_option', 'another\_option'{]},
'some\_option')} in the \sphinxcode{install\_before\_final\_checks} hook. (The last
parameter is the name of the option which should be the default.)

\item {} 
Add descriptions for the identifiers for your setting and choices
(setting\_name, some\_option etc.) to the hash defined in
\sphinxcode{global/setting-descs.none.tmpl}. Do this in a template hook:
\sphinxcode{hook/global/setting-descs-settings.none.tmpl}. Your code can see the
hash variable; just set more members in it.

\item {} 
To change behaviour based on the setting, reference it in templates using
\sphinxcode{{[}\% user.settings.setting\_name.value \%{]}}. Reference it in code using
\sphinxcode{\$user-\textgreater{}settings-\textgreater{}\{'setting\_name'\}-\textgreater{}\{'value'\}}. The value will be one of
the option tag names (e.g. some\_option).

\end{itemize}


\subsection{Altering Who Can Change What}
\label{\detokenize{integrating/extensions:who-can-change-what}}\label{\detokenize{integrating/extensions: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 \sphinxstyleemphasis{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
\sphinxstyleemphasis{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 {\hyperref[\detokenize{integrating/extensions:extensions}]{\sphinxcrossref{\DUrole{std,std-ref}{Extensions}}}} can call. It's called
\sphinxcode{bug\_check\_can\_change\_field}, and it's documented \sphinxhref{http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/Hook.html\#bug\_check\_can\_change\_field}{in the Hooks
documentation}.


\subsection{Checking Syntax}
\label{\detokenize{integrating/extensions:checking-syntax}}
It's not immediately obvious how to check the syntax of your extension's
Perl modules, if it contains any. Running \sphinxstyleliteralstrong{checksetup.pl} might do
some of it, but the errors aren't necessarily massively informative.

\sphinxstyleliteralstrong{perl -Mlib=lib -MBugzilla -e 'BEGIN \{ Bugzilla-\textgreater{}extensions; \} use Bugzilla::Extension::ExtensionName::Class;'}

(run from \sphinxcode{\$BUGZILLA\_HOME}) is what you need.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\section{APIs}
\label{\detokenize{integrating/apis::doc}}\label{\detokenize{integrating/apis:api-list}}\label{\detokenize{integrating/apis: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
{\hyperref[\detokenize{api/index:apis}]{\sphinxcrossref{\DUrole{std,std-ref}{REST WebService API v1}}}}
should be used for all new integrations, but keep an eye out for version 2,
coming soon.

The APIs currently available are as follows:


\subsection{Ad-Hoc APIs}
\label{\detokenize{integrating/apis: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.


\subsection{XML-RPC}
\label{\detokenize{integrating/apis:xml-rpc}}
Bugzilla has an \sphinxhref{http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Server/XMLRPC.html}{XML-RPC API}.
This will receive no further updates and will be removed in a future version
of Bugzilla.

Endpoint: \sphinxcode{/xmlrpc.cgi}


\subsection{JSON-RPC}
\label{\detokenize{integrating/apis:json-rpc}}
Bugzilla has a \sphinxhref{http://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Server/JSONRPC.html}{JSON-RPC API}.
This will receive no further updates and will be removed in a future version
of Bugzilla.

Endpoint: \sphinxcode{/jsonrpc.cgi}


\subsection{REST}
\label{\detokenize{integrating/apis:rest}}
Bugzilla has a {\hyperref[\detokenize{api/index:apis}]{\sphinxcrossref{\DUrole{std,std-ref}{REST API}}}} 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.

\sphinxstylestrong{This is the currently-recommended API for new development.}

Endpoint: \sphinxcode{/rest}


\subsection{BzAPI/BzAPI-Compatible REST}
\label{\detokenize{integrating/apis:bzapi-bzapi-compatible-rest}}
The first ever REST API for Bugzilla was implemented using an external proxy
called \sphinxhref{https://wiki.mozilla.org/Bugzilla:BzAPI}{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.


\subsection{REST v2}
\label{\detokenize{integrating/apis: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.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{WebService API Reference}
\label{\detokenize{api/index:webservice-api-reference}}\label{\detokenize{api/index::doc}}\label{\detokenize{api/index:apis}}
This Bugzilla installation has the following WebService APIs available
(as of the last time you compiled the documentation):


\section{Core API v1}
\label{\detokenize{api/core/v1/index:core-api-v1}}\label{\detokenize{api/core/v1/index::doc}}

\subsection{General}
\label{\detokenize{api/core/v1/general::doc}}\label{\detokenize{api/core/v1/general:general}}
This is the standard REST API for external programs that want to interact
with Bugzilla. It provides a REST interface to various Bugzilla functions.


\subsubsection{Basic Information}
\label{\detokenize{api/core/v1/general:basic-information}}
\sphinxstylestrong{Browsing}

If the \sphinxcode{Accept} header of a request is set to \sphinxcode{text/html} (as it is by an
ordinary web browser) then the API will return the JSON data as a HTML
page which the browser can display. In other words, you can play with the
API using just your browser to see results in a human-readable form.
This is a good way to try out the various GET calls, even if you can't use
it for POST or PUT.

\sphinxstylestrong{Data Format}

The REST API only supports JSON input, and either JSON or JSONP output.
So objects sent and received must be in JSON format.

On every request, you must set both the \sphinxcode{Accept} and \sphinxcode{Content-Type} HTTP
headers to the MIME type of the data format you are using to communicate with
the API. \sphinxcode{Content-Type} tells the API how to interpret your request, and
\sphinxcode{Accept} tells it how you want your data back. \sphinxcode{Content-Type} must be
\sphinxcode{application/json}. \sphinxcode{Accept} can be either that, or
\sphinxcode{application/javascript} for JSONP. In the latter{}`case, add a \sphinxcode{callback}
parameter to name your callback.

Parameters may also be passed in as part of the query string for non-GET
requests and will override any matching parameters in the request body.

Example request which returns the current version of Bugzilla:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nf}{GET} \PYG{n+nn}{/rest/version} \PYG{k+kr}{HTTP}\PYG{o}{/}\PYG{l+m}{1.1}
\PYG{n+na}{Host}\PYG{o}{:} \PYG{l}{bugzilla.example.com}
\PYG{n+na}{Accept}\PYG{o}{:} \PYG{l}{application/json}
\end{sphinxVerbatim}

Example response:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k+kr}{HTTP}\PYG{o}{/}\PYG{l+m}{1.1} \PYG{l+m}{200} \PYG{n+ne}{OK}
\PYG{n+na}{Vary}\PYG{o}{:} \PYG{l}{Accept}
\PYG{n+na}{Content\PYGZhy{}Type}\PYG{o}{:} \PYG{l}{application/json}

\PYG{p}{\PYGZob{}}
  \PYG{n+nt}{\PYGZdq{}version\PYGZdq{}} \PYG{p}{:} \PYG{l+s+s2}{\PYGZdq{}4.2.9+\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxstylestrong{Errors}

When an error occurs over REST, an object is returned with the key \sphinxcode{error}
set to \sphinxcode{true}.

The error contents look similar to:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}error\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}message\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Some message here\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}code\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{123}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\subsubsection{Common Data Types}
\label{\detokenize{api/core/v1/general:common-data-types}}
The Bugzilla API uses the following various types of parameters:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
int
&
Integer.
\\
\hline
double
&
A floating-point number.
\\
\hline
string
&
A string.
\\
\hline
email
&
A string representing an email address. This value, when returned,
may be filtered based on if the user is logged in or not.
\\
\hline
date
&
A specific date. Example format: \sphinxcode{YYYY-MM-DD}.
\\
\hline
datetime
&
A date/time. Timezone should be in UTC unless otherwise noted.
Example format: \sphinxcode{YYYY-MM-DDTHH24:MI:SSZ}.
\\
\hline
boolean
&
\sphinxcode{true} or \sphinxcode{false}.
\\
\hline
base64
&
A base64-encoded string. This is the only way to transfer
binary data via the API.
\\
\hline
array
&
An array. There may be mixed types in an array. \sphinxcode{{[}} and \sphinxcode{{]}} are
used to represent the beginning and end of arrays.
\\
\hline
object
&
A mapping of keys to values. Called a "hash", "dict", or "map" in
some other programming languages. The keys are strings, and the
values can be any type. \sphinxcode{\{} and \sphinxcode{\}} are used to represent the
beginning and end of objects.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Parameters that are required will be displayed in \sphinxstylestrong{bold} in the parameters
table for each API method.


\subsubsection{Authentication}
\label{\detokenize{api/core/v1/general:authentication}}
Some methods do not require you to log in. An example of this is
{\hyperref[\detokenize{api/core/v1/bug:rest-single-bug}]{\sphinxcrossref{\DUrole{std,std-ref}{Get Bug}}}}. However, authenticating yourself allows you to see
non-public information, for example, a bug that is not publicly visible.

There are two ways to authenticate yourself:

\sphinxstylestrong{API Keys}

You can specify \sphinxcode{Bugzilla\_api\_key} or simply \sphinxcode{api\_key} as an argument to
any call, and you will be logged in as that user if the key is correct and has
not been revoked. You can set up an API key by using the 'API Key' tab in the
Preferences pages.

\sphinxstylestrong{Login and Password}

You can specify \sphinxcode{Bugzilla\_login} and \sphinxcode{Bugzilla\_password} or simply
\sphinxcode{login} and \sphinxcode{password} respectively, as arguments to any call, and you will
be logged in as that user if your credentials are correct.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{Bugzilla\_login}
&
string
&
A user's login name.
\\
\hline
\sphinxstylestrong{Bugzilla\_password}
&
string
&
That user's password.
\\
\hline
Bugzilla\_restrictlogin
&
boolean
&
If true, then your login will only be
valid for your IP address.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

The \sphinxcode{Bugzilla\_restrictlogin} option is only used when you have also
specified \sphinxcode{Bugzilla\_login} and \sphinxcode{Bugzilla\_password}.

There is also a deprecated method of authentication described below that will be
removed in the version after Bugzilla 5.0.

\sphinxstylestrong{Bugzilla Tokens}

You can use {\hyperref[\detokenize{api/core/v1/user:rest-user-login}]{\sphinxcrossref{\DUrole{std,std-ref}{Login}}}} to log in as a Bugzilla user. This issues a
token that you must then use in future calls. Just use the value for \sphinxcode{token}
and pass as either \sphinxcode{Bugzilla\_token} or simply \sphinxcode{token} as arguments to an
API call.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{Bugzilla\_token}
&
string
&
You can specify this as argument to any call,
and you will be logged in as that user if the
token is correct. This is the token returned
when calling {\hyperref[\detokenize{api/core/v1/user:rest-user-login}]{\sphinxcrossref{\DUrole{std,std-ref}{Login}}}} mentioned
above.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

An error is thrown if you pass an invalid token; you will need to log in again
to get a new token.

Also starting with Bugzilla 5.0, login cookies are no longer returned by
{\hyperref[\detokenize{api/core/v1/user:rest-user-login}]{\sphinxcrossref{\DUrole{std,std-ref}{Login}}}} due to security concerns.


\subsubsection{Useful Parameters}
\label{\detokenize{api/core/v1/general:useful-parameters}}
Many calls take common arguments. These are documented below and linked from
the individual calls where these parameters are used.

\sphinxstylestrong{Including Fields}

Many calls return an array of objects with various fields in the objects. (For
example, {\hyperref[\detokenize{api/core/v1/bug:rest-single-bug}]{\sphinxcrossref{\DUrole{std,std-ref}{Get Bug}}}} returns a list of \sphinxcode{bugs} that have fields like
\sphinxcode{id}, \sphinxcode{summary},  \sphinxcode{creation\_time}, etc.)

These parameters allow you to limit what fields are present in the objects, to
improve performance or save some bandwidth.

\sphinxcode{include\_fields}: The (case-sensitive) names of fields in the response data.
Only the fields specified in the object will be returned, the rest will not be
included. Fields should be comma delimited.

Invalid field names are ignored.

Example request to {\hyperref[\detokenize{api/core/v1/user:rest-user-get}]{\sphinxcrossref{\DUrole{std,std-ref}{Get User}}}}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/user/1?include\PYGZus{}fields=id,name
\end{sphinxVerbatim}

would return something like:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}users\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{1}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@domain.com\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxstylestrong{Excluding Fields}

\sphinxcode{exclude\_fields}: The (case-sensitive) names of fields in the return value. Thefields specified will not be included in the returned hashes. Fields should
be comma delimited.

Invalid field names are ignored.

Specifying fields here overrides \sphinxcode{include\_fields}, so if you specify a
field in both, it will be excluded, not included.

Example request to {\hyperref[\detokenize{api/core/v1/user:rest-user-get}]{\sphinxcrossref{\DUrole{std,std-ref}{Get User}}}}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nx}{GET} \PYG{o}{/}\PYG{n+nx}{rest}\PYG{o}{/}\PYG{n+nx}{user}\PYG{o}{/}\PYG{l+m+mi}{1}\PYG{o}{?}\PYG{n+nx}{exclude\PYGZus{}fields}\PYG{o}{=}\PYG{n+nx}{name}
\end{sphinxVerbatim}

would return something like:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}users\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{1}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}real\PYGZus{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}John Smith\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Some calls support specifying "subfields". If a call states that it supports
"subfield" restrictions, you can restrict what information is returned within
the first field. For example, if you call {\hyperref[\detokenize{api/core/v1/product:rest-product-get}]{\sphinxcrossref{\DUrole{std,std-ref}{Get Product}}}} with an
\sphinxcode{include\_fields} of \sphinxcode{components.name}, then only the component name would be
returned (and nothing else). You can include the main field, and exclude a
subfield.

There are several shortcut identifiers to ask for only certain groups of
fields to be returned or excluded:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
value
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\_all
&
All possible fields are returned if this is specified in
\sphinxcode{include\_fields}.
\\
\hline
\_default
&
Default fields are returned if \sphinxcode{include\_fields} is empty or
this is specified. This is useful if you want the default
fields in addition to a field that is not normally returned.
\\
\hline
\_extra
&
Extra fields are not returned by default and need to be manually
specified in \sphinxcode{include\_fields} either by exact field name, or adding
\sphinxcode{\_extra}.
\\
\hline
\_custom
&
Custom fields are normally returned by default unless this is added
to \sphinxcode{exclude\_fields}. Also you can use it in \sphinxcode{include\_fields} if
for example you want specific field names plus all custom fields.
Custom fields are normally only relevant to bug objects.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Attachments}
\label{\detokenize{api/core/v1/attachment::doc}}\label{\detokenize{api/core/v1/attachment:attachments}}
The Bugzilla API for creating, changing, and getting the details of attachments.


\subsubsection{Get Attachment}
\label{\detokenize{api/core/v1/attachment:get-attachment}}\label{\detokenize{api/core/v1/attachment:rest-attachments}}
This allows you to get data about attachments, given a list of bugs and/or
attachment IDs. Private attachments will only be returned if you are in the
appropriate group or if you are the submitter of the attachment.

\sphinxstylestrong{Request}

To get all current attachments for a bug:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/(bug\PYGZus{}id)/attachment
\end{sphinxVerbatim}

To get a specific attachment based on attachment ID:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/attachment/(attachment\PYGZus{}id)
\end{sphinxVerbatim}

One of the below must be specified.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{bug\_id}
&
int
&
Integer bug ID.
\\
\hline
\sphinxstylestrong{attachment\_id}
&
int
&
Integer attachment ID.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
   \PYG{l+s+s2}{\PYGZdq{}bugs\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}1345\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
         \PYG{p}{\PYGZob{}} \PYG{p}{(}\PYG{n+nx}{attachment}\PYG{p}{)} \PYG{p}{\PYGZcb{}}\PYG{p}{,}
         \PYG{p}{\PYGZob{}} \PYG{p}{(}\PYG{n+nx}{attachment}\PYG{p}{)} \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}9874\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
         \PYG{p}{\PYGZob{}} \PYG{p}{(}\PYG{n+nx}{attachment}\PYG{p}{)} \PYG{p}{\PYGZcb{}}\PYG{p}{,}
         \PYG{p}{\PYGZob{}} \PYG{p}{(}\PYG{n+nx}{attachment}\PYG{p}{)} \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
   \PYG{p}{\PYGZcb{}}\PYG{p}{,}
   \PYG{l+s+s2}{\PYGZdq{}attachments\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}234\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}} \PYG{p}{(}\PYG{n+nx}{attachment}\PYG{p}{)} \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}123\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}} \PYG{p}{(}\PYG{n+nx}{attachment}\PYG{p}{)} \PYG{p}{\PYGZcb{}}\PYG{p}{,}
   \PYG{p}{\PYGZcb{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

An object containing two elements: \sphinxcode{bugs} and \sphinxcode{attachments}.

The attachments for the bug that you specified in the \sphinxcode{bug\_id} argument in
input are returned in \sphinxcode{bugs} on output. \sphinxcode{bugs} is a object that has integer
bug IDs for keys and the values are arrays of objects as attachments.
(Fields for attachments are described below.)

For the attachment that you specified directly in \sphinxcode{attachment\_id}, they
are returned in \sphinxcode{attachments} on output. This is a object where the attachment
ids point directly to objects describing the individual attachment.

The fields for each attachment (where it says \sphinxcode{(attachment)} in the
sample response above) are:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
data
&
base64
&
The raw data of the attachment, encoded as Base64.
\\
\hline
size
&
int
&
The length (in bytes) of the attachment.
\\
\hline
creation\_time
&
datetime
&
The time the attachment was created.
\\
\hline
last\_change\_time
&
datetime
&
The last time the attachment was modified.
\\
\hline
id
&
int
&
The numeric ID of the attachment.
\\
\hline
bug\_id
&
int
&
The numeric ID of the bug that the attachment is
attached to.
\\
\hline
file\_name
&
string
&
The file name of the attachment.
\\
\hline
summary
&
string
&
A short string describing the attachment.
\\
\hline
content\_type
&
string
&
The MIME type of the attachment.
\\
\hline
is\_private
&
boolean
&
\sphinxcode{true} if the attachment is private (only visible
to a certain group called the "insidergroup",
\sphinxcode{false} otherwise.
\\
\hline
is\_obsolete
&
boolean
&
\sphinxcode{true} if the attachment is obsolete, \sphinxcode{false}
otherwise.
\\
\hline
is\_patch
&
boolean
&
\sphinxcode{true} if the attachment is a patch, \sphinxcode{false}
otherwise.
\\
\hline
creator
&
string
&
The login name of the user that created the
attachment.
\\
\hline
flags
&
array
&
Array of objects, each containing the information
about the flag currently set for each attachment.
Each flag object contains items descibed in the
Flag object below.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Flag object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the flag.
\\
\hline
name
&
string
&
The name of the flag.
\\
\hline
type\_id
&
int
&
The type ID of the flag.
\\
\hline
creation\_date
&
datetime
&
The timestamp when this flag was originally created.
\\
\hline
modification\_date
&
datetime
&
The timestamp when the flag was last modified.
\\
\hline
status
&
string
&
The current status of the flag such as ?, +, or -.
\\
\hline
setter
&
string
&
The login name of the user who created or last
modified the flag.
\\
\hline
requestee
&
string
&
The login name of the user this flag has been
requested to be granted or denied. Note, this field
is only returned if a requestee is set.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Create Attachment}
\label{\detokenize{api/core/v1/attachment:create-attachment}}\label{\detokenize{api/core/v1/attachment:rest-add-attachment}}
This allows you to add an attachment to a bug in Bugzilla.

\sphinxstylestrong{Request}

To create attachment on a current bug:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/bug/(bug\PYGZus{}id)/attachment
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}} \PYG{o}{:} \PYG{p}{[} \PYG{l+m+mi}{35} \PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}patch\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}comment\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}This is a new attachment comment\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}summary\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Test Attachment\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}content\PYGZus{}type\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}text/plain\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}data\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}(Some patch content)\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}file\PYGZus{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}test\PYGZus{}attachment.patch\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}obsoletes\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}private\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}flags\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}review\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}status\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}?\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}requestee\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}new\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{true}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

The params to include in the POST body, as well as the returned
data format, are the same as below. The \sphinxcode{bug\_id} param will be
overridden as it it pulled from the URL path.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{ids}
&
array
&
The IDs or aliases of bugs that you want to add this
attachment to. The same attachment and comment will be
added to all these bugs.
\\
\hline
\sphinxstylestrong{data}
&
string
&
The content of the attachment. If the content of the
attachment is not ASCII text such as
\sphinxcode{application/octet-stream} you must encode it in
base64 using an appropriate client library such as
\sphinxcode{MIME::Base64} for Perl.
\\
\hline
\sphinxstylestrong{file\_name}
&
string
&
The "file name" that will be displayed in the UI for
this attachment and also downloaded copies will be
given.
\\
\hline
\sphinxstylestrong{summary}
&
string
&
A short string describing the attachment.
\\
\hline
\sphinxstylestrong{content\_type}
&
string
&
The MIME type of the attachment, like \sphinxcode{text/plain}
or \sphinxcode{image/png}.
\\
\hline
comment
&
string
&
A comment to add along with this attachment.
\\
\hline
is\_patch
&
boolean
&
\sphinxcode{true} if Bugzilla should treat this attachment as a
patch. If you specify this, you do not need to specify
a \sphinxcode{content\_type}. The \sphinxcode{content\_type} of the
attachment will be forced to \sphinxcode{text/plain}. Defaults
to \sphinxcode{false} if not specified.
\\
\hline
is\_private
&
boolean
&
\sphinxcode{true} if the attachment should be private
(restricted to the "insidergroup"), \sphinxcode{false} if the
attachment should be public. Defaults to \sphinxcode{false} if
not specified.
\\
\hline
flags
&
array
&
Flags objects to add to the attachment. The object
format is described in the Flag object below.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Flag object:

To create a flag, at least the \sphinxcode{status} and the \sphinxcode{type\_id} or \sphinxcode{name} must
be provided. An optional requestee can be passed if the flag type is requestable
to a specific user.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
The name of the flag type.
\\
\hline
type\_id
&
int
&
The internal flag type ID.
\\
\hline
status
&
string
&
The flags new status (i.e. "?", "+", "-" or "X" to clear a
flag).
\\
\hline
requestee
&
string
&
The login of the requestee if the flag type is requestable to
a specific user.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
    \PYG{l+s+s2}{\PYGZdq{}2797\PYGZdq{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
ids
&
array
&
Attachment IDs created.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Update Attachment}
\label{\detokenize{api/core/v1/attachment:rest-update-attachment}}\label{\detokenize{api/core/v1/attachment:update-attachment}}
This allows you to update attachment metadata in Bugzilla.

\sphinxstylestrong{Request}

To update attachment metadata on a current attachment:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
PUT /rest/bug/attachment/(attachment\PYGZus{}id)
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}} \PYG{o}{:} \PYG{p}{[} \PYG{l+m+mi}{2796} \PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}summary\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Test XML file\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}comment\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Changed this from a patch to a XML file\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}content\PYGZus{}type\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}text/xml\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}patch\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{0}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{attachment\_id}
&
int
&
Integer attachment ID.
\\
\hline
\sphinxstylestrong{ids}
&
array
&
The IDs of the attachments you want to update.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
file\_name
&
string
&
The "file name" that will be displayed in the UI for this
attachment.
\\
\hline
summary
&
string
&
A short string describing the attachment.
\\
\hline
comment
&
string
&
An optional comment to add to the attachment's bug.
\\
\hline
content\_type
&
string
&
The MIME type of the attachment, like \sphinxcode{text/plain}
or \sphinxcode{image/png}.
\\
\hline
is\_patch
&
boolean
&
\sphinxcode{true} if Bugzilla should treat this attachment as a
patch. If you specify this, you do not need to specify a
\sphinxcode{content\_type}. The \sphinxcode{content\_type} of the attachment
will be forced to \sphinxcode{text/plain}.
\\
\hline
is\_private
&
boolean
&
\sphinxcode{true} if the attachment should be private (restricted
to the "insidergroup"), \sphinxcode{false} if the attachment
should be public.
\\
\hline
is\_obsolete
&
boolean
&
\sphinxcode{true} if the attachment is obsolete, \sphinxcode{false}
otherwise.
\\
\hline
flags
&
array
&
An array of Flag objects with changes to the flags. The
object format is described in the Flag object below.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Flag object:

The following values can be specified. At least the \sphinxcode{status} and one of
\sphinxcode{type\_id}, \sphinxcode{id}, or \sphinxcode{name} must be specified. If a type\_id or name matches
a single currently set flag, the flag will be updated unless \sphinxcode{new} is specified.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
The name of the flag that will be created or updated.
\\
\hline
type\_id
&
int
&
The internal flag type ID that will be created or updated.
You will need to specify the \sphinxcode{type\_id} if more than one
flag type of the same name exists.
\\
\hline
status
&
string
&
The flags new status (i.e. "?", "+", "-" or "X" to clear a
flag).
\\
\hline
requestee
&
string
&
The login of the requestee if the flag type is requestable
to a specific user.
\\
\hline
id
&
int
&
Use ID to specify the flag to be updated. You will need to
specify the \sphinxcode{id} if more than one flag is set of the same
name.
\\
\hline
new
&
boolean
&
Set to true if you specifically want a new flag to be
created.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}attachments\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}changes\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
        \PYG{l+s+s2}{\PYGZdq{}content\PYGZus{}type\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}text/xml\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}text/plain\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}patch\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}summary\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Test XML file\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}test patch\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{2796}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}last\PYGZus{}change\PYGZus{}time\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}29T14:41:53Z\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{attachments} (array) Change objects with the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the attachment that was updated.
\\
\hline
last\_change\_time
&
datetime
&
The exact time that this update was done at, for this
attachment. If no update was done (that is, no fields
had their values changed and no comment was added)
then this will instead be the last time the
attachment was updated.
\\
\hline
changes
&
object
&
The changes that were actually done on this
attachment. The keys are the names of the fields that
were changed, and the values are an object with two
items:
\begin{itemize}
\item {} 
added: (string) The values that were added to this
field. Possibly a comma-and-space-separated list
if multiple values were added.

\item {} 
removed: (string) The values that were removed from
this field.

\end{itemize}
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Bugs}
\label{\detokenize{api/core/v1/bug::doc}}\label{\detokenize{api/core/v1/bug:bugs}}
The REST API for creating, changing, and getting the details of bugs.

This part of the Bugzilla REST API allows you to file new bugs in Bugzilla and
to get information about existing bugs.


\subsubsection{Get Bug}
\label{\detokenize{api/core/v1/bug:rest-single-bug}}\label{\detokenize{api/core/v1/bug:get-bug}}
Gets information about particular bugs in the database.

\sphinxstylestrong{Request}

To get information about a particular bug using its ID or alias:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/(id\PYGZus{}or\PYGZus{}alias)
\end{sphinxVerbatim}

You can also use {\hyperref[\detokenize{api/core/v1/bug:rest-search-bugs}]{\sphinxcrossref{\DUrole{std,std-ref}{Search Bugs}}}} to return more than one bug at a time
by specifying bug IDs as the search terms.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug?id=12434,43421
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id\_or\_alias}
&
mixed
&
An integer bug ID or a bug alias string.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}faults\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}bugs\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}assigned\PYGZus{}to\PYGZus{}detail\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
        \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{2}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}real\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Test User\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}email\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}
      \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}flags\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}type\PYGZus{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{11}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}modification\PYGZus{}date\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}28T21:03:47Z\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}blocker\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}status\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}?\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{2906}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}setter\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}creation\PYGZus{}date\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}28T21:03:47Z\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}resolution\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}INVALID\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{35}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}qa\PYGZus{}contact\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}version\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1.0\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}status\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}RESOLVED\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}creator\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cf\PYGZus{}drop\PYGZus{}down\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZhy{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}summary\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}test bug\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}last\PYGZus{}change\PYGZus{}time\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}23T19:12:17Z\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}platform\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}All\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}url\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}classification\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Unclassified\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cc\PYGZus{}detail\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{786}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}real\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Foo Bar\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}foo@bar.com\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}email\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}foo@bar.com\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}priority\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P1\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}confirmed\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}creation\PYGZus{}time\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2000\PYGZhy{}07\PYGZhy{}25T13:50:04Z\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}assigned\PYGZus{}to\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}flags\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}alias\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cf\PYGZus{}large\PYGZus{}text\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}groups\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}op\PYGZus{}sys\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}All\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cf\PYGZus{}bug\PYGZus{}id\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}depends\PYGZus{}on\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}cc\PYGZus{}accessible\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}open\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cf\PYGZus{}qa\PYGZus{}list\PYGZus{}4\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZhy{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}keywords\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cc\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{l+s+s2}{\PYGZdq{}foo@bar.com\PYGZdq{}}\PYG{p}{,}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}see\PYGZus{}also\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}deadline\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}creator\PYGZus{}accessible\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}whiteboard\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}dupe\PYGZus{}of\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}target\PYGZus{}milestone\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZhy{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cf\PYGZus{}mulitple\PYGZus{}select\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}component\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}SaltSprinkler\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}severity\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}critical\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cf\PYGZus{}date\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}product\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}FoodReplicator\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}creator\PYGZus{}detail\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
        \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{28}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}real\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}hello\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}email\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}namachi@netscape.com\PYGZdq{}}
      \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}cf\PYGZus{}free\PYGZus{}text\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}blocks\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{bugs} (array) Each bug object contains information about the bugs with valid
ids containing the following items:

These fields are returned by default or by specifying \sphinxcode{\_default} in
\sphinxcode{include\_fields}.


\begin{savenotes}\sphinxatlongtablestart\begin{longtable}{|l|l|l|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\endfirsthead

\multicolumn{3}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} -- continued from previous page}}}\\
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\endhead

\hline
\multicolumn{3}{r}{\makebox[0pt][r]{\sphinxtablecontinued{Continued on next page}}}\\
\endfoot

\endlastfoot

actual\_time
&
double
&
The total number of hours that this bug has
taken so far. If you are not in the time-tracking
group, this field will not be included in the
return value.
\\
\hline
alias
&
array
&
The unique aliases of this bug. An empty array
will be returned if this bug has no aliases.
\\
\hline
assigned\_to
&
string
&
The login name of the user to whom the bug is
assigned.
\\
\hline
assigned\_to\_detail
&
object
&
An object containing detailed user information
for the assigned\_to. To see the keys included
in the user detail object, see below.
\\
\hline
blocks
&
array
&
The IDs of bugs that are "blocked" by this bug.
\\
\hline
cc
&
array
&
The login names of users on the CC list of this
bug.
\\
\hline
cc\_detail
&
array
&
Array of objects containing detailed user
information for each of the cc list members.
To see the keys included in the user detail
object, see below.
\\
\hline
classification
&
string
&
The name of the current classification the bug
is in.
\\
\hline
component
&
string
&
The name of the current component of this bug.
\\
\hline
creation\_time
&
datetime
&
When the bug was created.
\\
\hline
creator
&
string
&
The login name of the person who filed this bug
(the reporter).
\\
\hline
creator\_detail
&
object
&
An object containing detailed user information
for the creator. To see the keys included in the
user detail object, see below.
\\
\hline
deadline
&
string
&
The day that this bug is due to be completed, in
the format \sphinxcode{YYYY-MM-DD}.
\\
\hline
depends\_on
&
array
&
The IDs of bugs that this bug "depends on".
\\
\hline
dupe\_of
&
int
&
The bug ID of the bug that this bug is a
duplicate of. If this bug isn't a duplicate of
any bug, this will be null.
\\
\hline
estimated\_time
&
double
&
The number of hours that it was estimated that
this bug would take. If you are not in the
time-tracking group, this field will not be
included in the return value.
\\
\hline
flags
&
array
&
An array of objects containing the information
about flags currently set for the bug. Each flag
objects contains the following items
\\
\hline
groups
&
array
&
The names of all the groups that this bug is in.
\\
\hline
id
&
int
&
The unique numeric ID of this bug.
\\
\hline
is\_cc\_accessible
&
boolean
&
If true, this bug can be accessed by members of
the CC list, even if they are not in the groups
the bug is restricted to.
\\
\hline
is\_confirmed
&
boolean
&
\sphinxcode{true} if the bug has been confirmed. Usually
this means that the bug has at some point been
moved out of the \sphinxcode{UNCONFIRMED} status and into
another open status.
\\
\hline
is\_open
&
boolean
&
\sphinxcode{true} if this bug is open, \sphinxcode{false} if it
is closed.
\\
\hline
is\_creator\_accessible
&
boolean
&
If \sphinxcode{true}, this bug can be accessed by the
creator of the bug, even if they are not a
member of the groups the bug is restricted to.
\\
\hline
keywords
&
array
&
Each keyword that is on this bug.
\\
\hline
last\_change\_time
&
datetime
&
When the bug was last changed.
\\
\hline
op\_sys
&
string
&
The name of the operating system that the bug
was filed against.
\\
\hline
platform
&
string
&
The name of the platform (hardware) that the bug
was filed against.
\\
\hline
priority
&
string
&
The priority of the bug.
\\
\hline
product
&
string
&
The name of the product this bug is in.
\\
\hline
qa\_contact
&
string
&
The login name of the current QA Contact on the
bug.
\\
\hline
qa\_contact\_detail
&
object
&
An object containing detailed user information
for the qa\_contact. To see the keys included in
the user detail object, see below.
\\
\hline
remaining\_time
&
double
&
The number of hours of work remaining until work
on this bug is complete. If you are not in the
time-tracking group, this field will not be
included in the return value.
\\
\hline
resolution
&
string
&
The current resolution of the bug, or an empty
string if the bug is open.
\\
\hline
see\_also
&
array
&
The URLs in the See Also field on the bug.
\\
\hline
severity
&
string
&
The current severity of the bug.
\\
\hline
status
&
string
&
The current status of the bug.
\\
\hline
summary
&
string
&
The summary of this bug.
\\
\hline
target\_milestone
&
string
&
The milestone that this bug is supposed to be
fixed by, or for closed bugs, the milestone that
it was fixed for.
\\
\hline
update\_token
&
string
&
The token that you would have to pass to the
\sphinxcode{process\_bug.cgi} page in order to update this
bug. This changes every time the bug is updated.
This field is not returned to logged-out users.
\\
\hline
url
&
string
&
A URL that demonstrates the problem described in
the bug, or is somehow related to the bug report.
\\
\hline
version
&
string
&
The version the bug was reported against.
\\
\hline
whiteboard
&
string
&
The value of the "status whiteboard" field on
the bug.
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}

Custom fields:

Every custom field in this installation will also be included in the
return value. Most fields are returned as strings. However, some field types have
different return values.

Normally custom fields are returned by default similar to normal bug fields or
you can specify only custom fields by using \sphinxcode{\_custom} in \sphinxcode{include\_fields}.

Extra fields:

These fields are returned only by specifying \sphinxcode{\_extra} or the field name in
\sphinxcode{include\_fields}.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
tags
&
array
&
Each array item is a tag name. Note that tags are
personal to the currently logged in user and are not the same as
comment tags.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

User object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The user ID for this user.
\\
\hline
real\_name
&
string
&
The 'real' name for this user, if any.
\\
\hline
name
&
string
&
The user's Bugzilla login.
\\
\hline
email
&
string
&
The user's email address. Currently this is the same value as
the name.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Flag object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the flag.
\\
\hline
name
&
string
&
The name of the flag.
\\
\hline
type\_id
&
int
&
The type ID of the flag.
\\
\hline
creation\_date
&
datetime
&
The timestamp when this flag was originally created.
\\
\hline
modification\_date
&
datetime
&
The timestamp when the flag was last modified.
\\
\hline
status
&
string
&
The current status of the flag.
\\
\hline
setter
&
string
&
The login name of the user who created or last
modified the flag.
\\
\hline
requestee
&
string
&
The login name of the user this flag has been
requested to be granted or denied. Note, this field
is only returned if a requestee is set.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Custom field object:

You can specify to only return custom fields by specifying \sphinxcode{\_custom} or the
field name in \sphinxcode{include\_fields}.
\begin{itemize}
\item {} 
Bug ID Fields: (int)

\item {} 
Multiple-Selection Fields: (array of strings)

\item {} 
Date/Time Fields: (datetime)

\end{itemize}


\subsubsection{Bug History}
\label{\detokenize{api/core/v1/bug:rest-history}}\label{\detokenize{api/core/v1/bug:bug-history}}
Gets the history of changes for particular bugs in the database.

\sphinxstylestrong{Request}

To get the history for a specific bug ID:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/(id)/history
\end{sphinxVerbatim}

To get the history for a bug since a specific date:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/(id)/history?new\PYGZus{}since=YYYY\PYGZhy{}MM\PYGZhy{}DD
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id}
&
mixed
&
An integer bug ID or alias.
\\
\hline
new\_since
&
datetime
&
A datetime timestamp to only show history since.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}bugs\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}alias\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}history\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}when\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}23T19:12:17Z\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}who\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}changes\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
            \PYG{p}{\PYGZob{}}
              \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P1\PYGZdq{}}\PYG{p}{,}
              \PYG{l+s+s2}{\PYGZdq{}field\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}priority\PYGZdq{}}\PYG{p}{,}
              \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P2\PYGZdq{}}
            \PYG{p}{\PYGZcb{}}\PYG{p}{,}
            \PYG{p}{\PYGZob{}}
              \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}blocker\PYGZdq{}}\PYG{p}{,}
              \PYG{l+s+s2}{\PYGZdq{}field\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}severity\PYGZdq{}}\PYG{p}{,}
              \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}critical\PYGZdq{}}
            \PYG{p}{\PYGZcb{}}
          \PYG{p}{]}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}when\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}28T21:03:47Z\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}who\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}changes\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
            \PYG{p}{\PYGZob{}}
              \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}blocker?\PYGZdq{}}\PYG{p}{,}
              \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
              \PYG{l+s+s2}{\PYGZdq{}field\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}flagtypes.name\PYGZdq{}}
            \PYG{p}{\PYGZcb{}}
          \PYG{p}{]}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{35}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{bugs} (array) Bug objects each containing the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The numeric ID of the bug.
\\
\hline
alias
&
array
&
The unique aliases of this bug. An empty array will be returned
if this bug has no aliases.
\\
\hline
history
&
array
&
An array of History objects.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

History object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
when
&
datetime
&
The date the bug activity/change happened.
\\
\hline
who
&
string
&
The login name of the user who performed the bug change.
\\
\hline
changes
&
array
&
An array of Change objects which contain all the changes that
happened to the bug at this time (as specified by \sphinxcode{when}).
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Change object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
field\_name
&
string
&
The name of the bug field that has changed.
\\
\hline
removed
&
string
&
The previous value of the bug field which has been
deleted by the change.
\\
\hline
added
&
string
&
The new value of the bug field which has been added
by the change.
\\
\hline
attachment\_id
&
int
&
The ID of the attachment that was changed.
This only appears if the change was to an attachment,
otherwise \sphinxcode{attachment\_id} will not be present in this
object.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Search Bugs}
\label{\detokenize{api/core/v1/bug:rest-search-bugs}}\label{\detokenize{api/core/v1/bug:search-bugs}}
Allows you to search for bugs based on particular criteria.

\sphinxstylestrong{Request}

To search for bugs:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug
\end{sphinxVerbatim}

Unless otherwise specified in the description of a parameter, bugs are
returned if they match \sphinxstyleemphasis{exactly} the criteria you specify in these
parameters. That is, we don't match against substrings--if a bug is in
the "Widgets" product and you ask for bugs in the "Widg" product, you
won't get anything.

Criteria are joined in a logical AND. That is, you will be returned
bugs that match \sphinxstyleemphasis{all} of the criteria, not bugs that match \sphinxstyleemphasis{any} of
the criteria.

Each parameter can be either the type it says, or a list of the types
it says. If you pass an array, it means "Give me bugs with \sphinxstyleemphasis{any} of
these values." For example, if you wanted bugs that were in either
the "Foo" or "Bar" products, you'd pass:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug?product=Foo\PYGZam{}product=Bar
\end{sphinxVerbatim}

Some Bugzillas may treat your arguments case-sensitively, depending
on what database system they are using. Most commonly, though, Bugzilla is
not case-sensitive with the arguments passed (because MySQL is the
most-common database to use with Bugzilla, and MySQL is not case sensitive).

In addition to the fields listed below, you may also use criteria that
is similar to what is used in the Advanced Search screen of the Bugzilla
UI. This includes fields specified by \sphinxcode{Search by Change History} and
\sphinxcode{Custom Search}. The easiest way to determine what the field names are and what
format Bugzilla expects is to first construct your query using the
Advanced Search UI, execute it and use the query parameters in they URL
as your query for the REST call.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
alias
&
array
&
The unique aliases of this bug. An empty array will
be returned if this bug has no aliases.
\\
\hline
assigned\_to
&
string
&
The login name of a user that a bug is assigned to.
\\
\hline
component
&
string
&
The name of the Component that the bug is in. Note
that if there are multiple Components with the same
name, and you search for that name, bugs in \sphinxstyleemphasis{all}
those Components will be returned. If you don't want
this, be sure to also specify the \sphinxcode{product} argument.
\\
\hline
creation\_time
&
datetime
&
Searches for bugs that were created at this time or
later. May not be an array.
\\
\hline
creator
&
string
&
The login name of the user who created the bug. You
can also pass this argument with the name
\sphinxcode{reporter}, for backwards compatibility with
older Bugzillas.
\\
\hline
id
&
int
&
The numeric ID of the bug.
\\
\hline
last\_change\_time
&
datetime
&
Searches for bugs that were modified at this time
or later. May not be an array.
\\
\hline
limit
&
int
&
Limit the number of results returned. If the limit
is more than zero and higher than the maximum limit
set by the administrator, then the maximum limit will
be used instead. If you set the limit equal to zero,
then all matching results will be returned instead.
\\
\hline
offset
&
int
&
Used in conjunction with the \sphinxcode{limit} argument,
\sphinxcode{offset} defines the starting position for the
search. For example, given a search that would
return 100 bugs, setting \sphinxcode{limit} to 10 and
\sphinxcode{offset} to 10 would return bugs 11 through 20
from the set of 100.
\\
\hline
op\_sys
&
string
&
The "Operating System" field of a bug.
\\
\hline
platform
&
string
&
The Platform (sometimes called "Hardware") field of
a bug.
\\
\hline
priority
&
string
&
The Priority field on a bug.
\\
\hline
product
&
string
&
The name of the Product that the bug is in.
\\
\hline
resolution
&
string
&
The current resolution--only set if a bug is closed.
You can find open bugs by searching for bugs with an
empty resolution.
\\
\hline
severity
&
string
&
The Severity field on a bug.
\\
\hline
status
&
string
&
The current status of a bug (not including its
resolution, if it has one, which is a separate field
above).
\\
\hline
summary
&
string
&
Searches for substrings in the single-line Summary
field on bugs. If you specify an array, then bugs
whose summaries match \sphinxstyleemphasis{any} of the passed substrings
will be returned. Note that unlike searching in the
Bugzilla UI, substrings are not split on spaces. So
searching for \sphinxcode{foo bar} will match "This is a foo
bar" but not "This foo is a bar". \sphinxcode{{[}'foo', 'bar'{]}},
would, however, match the second item.
\\
\hline
tags
&
string
&
Searches for a bug with the specified tag. If you
specify an array, then any bugs that match \sphinxstyleemphasis{any} of
the tags will be returned. Note that tags are
personal to the currently logged in user.
\\
\hline
target\_milestone
&
string
&
The Target Milestone field of a bug. Note that even
if this Bugzilla does not have the Target Milestone
field enabled, you can still search for bugs by
Target Milestone. However, it is likely that in that
case, most bugs will not have a Target Milestone set
(it defaults to "---" when the field isn't enabled).
\\
\hline
qa\_contact
&
string
&
The login name of the bug's QA Contact. Note that
even if this Bugzilla does not have the QA Contact
field enabled, you can still search for bugs by QA
Contact (though it is likely that no bug will have a
QA Contact set, if the field is disabled).
\\
\hline
url
&
string
&
The "URL" field of a bug.
\\
\hline
version
&
string
&
The Version field of a bug.
\\
\hline
whiteboard
&
string
&
Search the "Status Whiteboard" field on bugs for a
substring. Works the same as the \sphinxcode{summary} field
described above, but searches the Status Whiteboard
field.
\\
\hline
quicksearch
&
string
&
Search for bugs using quicksearch syntax.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

The same as {\hyperref[\detokenize{api/core/v1/bug:rest-single-bug}]{\sphinxcrossref{\DUrole{std,std-ref}{Get Bug}}}}.


\subsubsection{Create Bug}
\label{\detokenize{api/core/v1/bug:rest-create-bug}}\label{\detokenize{api/core/v1/bug:create-bug}}
This allows you to create a new bug in Bugzilla. If you specify any
invalid fields, an error will be thrown stating which field is invalid.
If you specify any fields you are not allowed to set, they will just be
set to their defaults or ignored.

You cannot currently set all the items here that you can set on enter\_bug.cgi.

The WebService interface may allow you to set things other than those listed
here, but realize that anything undocumented here may likely change in the
future.

\sphinxstylestrong{Request}

To create a new bug in Bugzilla.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/bug
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}product\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}TestProduct\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}component\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}TestComponent\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}version\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}unspecified\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}summary\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZsq{}This is a test bug \PYGZhy{} please disregard\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}alias\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}SomeAlias\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}op\PYGZus{}sys\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}All\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}priority\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P1\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}rep\PYGZus{}platform\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}All\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Some params must be set, or an error will be thrown. These params are
marked in \sphinxstylestrong{bold}.

Some parameters can have defaults set in Bugzilla, by the administrator.
If these parameters have defaults set, you can omit them. These parameters
are marked (defaulted).

Clients that want to be able to interact uniformly with multiple
Bugzillas should always set both the params marked required and those
marked (defaulted), because some Bugzillas may not have defaults set
for (defaulted) parameters, and then this method will throw an error
if you don't specify them.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{product}
&
string
&
The name of the product the bug is being filed
against.
\\
\hline
\sphinxstylestrong{component}
&
string
&
The name of a component in the product above.
\\
\hline
\sphinxstylestrong{summary}
&
string
&
A brief description of the bug being filed.
\\
\hline
\sphinxstylestrong{version}
&
string
&
A version of the product above; the version the
bug was found in.
\\
\hline
description
&
string
&
(defaulted) The initial description for this bug.
Some Bugzilla installations require this to not be
blank.
\\
\hline
op\_sys
&
string
&
(defaulted) The operating system the bug was
discovered on.
\\
\hline
platform
&
string
&
(defaulted) What type of hardware the bug was
experienced on.
\\
\hline
priority
&
string
&
(defaulted) What order the bug will be fixed in by
the developer, compared to the developer's other
bugs.
\\
\hline
severity
&
string
&
(defaulted) How severe the bug is.
\\
\hline
alias
&
array
&
One or more brief aliases for the bug that can be
used instead of a bug number when accessing this bug.
Must be unique in all of this Bugzilla.
\\
\hline
assigned\_to
&
string
&
A user to assign this bug to, if you don't want it
to be assigned to the component owner.
\\
\hline
cc
&
array
&
An array of usernames to CC on this bug.
\\
\hline
comment\_is\_private
&
boolean
&
If set to true, the description is private,
otherwise it is assumed to be public.
\\
\hline
groups
&
array
&
An array of group names to put this bug into. You
can see valid group names on the Permissions tab of
the Preferences screen, or, if you are an
administrator, in the Groups control panel. If you
don't specify this argument, then the bug will be
added into all the groups that are set as being
"Default" for this product. (If you want to avoid
that, you should specify \sphinxcode{groups} as an empty
array.)
\\
\hline
qa\_contact
&
string
&
If this installation has QA Contacts enabled, you
can set the QA Contact here if you don't want to
use the component's default QA Contact.
\\
\hline
status
&
string
&
The status that this bug should start out as. Note
that only certain statuses can be set on bug
creation.
\\
\hline
resolution
&
string
&
If you are filing a closed bug, then you will have
to specify a resolution. You cannot currently
specify a resolution of \sphinxcode{DUPLICATE}   for new
bugs, though. That must be done with
{\hyperref[\detokenize{api/core/v1/bug:rest-update-bug}]{\sphinxcrossref{\DUrole{std,std-ref}{Update Bug}}}}.
\\
\hline
target\_milestone
&
string
&
A valid target milestone for this product.
\\
\hline
flags
&
array
&
Flags objects to add to the bug. The object format
is described in the Flag object below.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Flag object:

To create a flag, at least the \sphinxcode{status} and the \sphinxcode{type\_id} or \sphinxcode{name} must
be provided. An optional requestee can be passed if the flag type is requestable
to a specific user.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
The name of the flag type.
\\
\hline
type\_id
&
int
&
The internal flag type ID.
\\
\hline
status
&
string
&
The flags new status (i.e. "?", "+", "-" or "X" to clear flag).
\\
\hline
requestee
&
string
&
The login of the requestee if the flag type is requestable
to a specific user.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

In addition to the above parameters, if your installation has any custom
fields, you can set them just by passing in the name of the field and
its value as a string.

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{12345}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
This is the ID of the newly-filed bug.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Update Bug}
\label{\detokenize{api/core/v1/bug:update-bug}}\label{\detokenize{api/core/v1/bug:rest-update-bug}}
Allows you to update the fields of a bug. Automatically sends emails
out about the changes.

\sphinxstylestrong{Request}

To update the fields of a current bug.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
PUT /rest/bug/(id\PYGZus{}or\PYGZus{}alias)
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{l+m+mi}{35}\PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}status\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}IN\PYGZus{}PROGRESS\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}keywords\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
    \PYG{l+s+s2}{\PYGZdq{}add\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{l+s+s2}{\PYGZdq{}funny\PYGZdq{}}\PYG{p}{,} \PYG{l+s+s2}{\PYGZdq{}stupid\PYGZdq{}}\PYG{p}{]}
  \PYG{p}{\PYGZcb{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

The params to include in the PUT body as well as the returned data format,
are the same as below. You can specify the ID or alias of the bug to update
either in the URL path and/or in the \sphinxcode{ids} param. You can use both and they
will be combined so you can edit more than one bug at a time.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id\_or\_alias}
&
mixed
&
An integer bug ID or alias.
\\
\hline
\sphinxstylestrong{ids}
&
array
&
The IDs or aliases of the bugs that you want to modify.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

All following fields specify the values you want to set on the bugs you are
updating.


\begin{savenotes}\sphinxatlongtablestart\begin{longtable}{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\endfirsthead

\multicolumn{3}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} -- continued from previous page}}}\\
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\endhead

\hline
\multicolumn{3}{r}{\makebox[0pt][r]{\sphinxtablecontinued{Continued on next page}}}\\
\endfoot

\endlastfoot

alias
&
object
&These specify the aliases of a bug that can be
used instead of a bug number when acessing this
bug. To set these, you should pass a hash as the
value. The object may contain the following
items:
\begin{itemize}
\item {} 
\sphinxcode{add} (array) Aliases to add to this field.

\item {} 
\sphinxcode{remove} (array) Aliases to remove from this
field. If the aliases are not already in the
field, they will be ignored.

\item {} 
\sphinxcode{set} (array) An exact set of aliases to set
this field to, overriding the current value.
If you specify \sphinxcode{set}, then \sphinxcode{add} and
\sphinxcode{remove} will be ignored.

\end{itemize}

You can only set this if you are modifying a
single bug. If there is more than one bug
specified in \sphinxcode{ids}, passing in a value for
\sphinxcode{alias} will cause an error to be thrown.

For backwards compatibility, you can also
specify a single string. This will be treated as
if you specified the set key above.
\\
\hline
assigned\_to
&
string
&
The full login name of the user this bug is
assigned to.
\\
\hline
blocks
&
object
&
(Same as \sphinxcode{depends\_on} below)
\\
\hline
depends\_on
&
object
&
These specify the bugs that this bug blocks or
depends on, respectively. To set these, you
should pass an object as the value. The object
may contain the following items:
\begin{itemize}
\item {} 
\sphinxcode{add} (array) Bug IDs to add to this field.

\item {} 
\sphinxcode{remove} (array) Bug IDs to remove from this
field. If the bug IDs are not already in the
field, they will be ignored.

\item {} 
\sphinxcode{set} (array of) An exact set of bug IDs to
set this field to, overriding the current
value. If you specify \sphinxcode{set}, then \sphinxcode{add}
and \sphinxcode{remove} will be ignored.

\end{itemize}
\\
\hline
cc
&
object
&
The users on the cc list. To modify this field,
pass an object, which may have the following
items:
\begin{itemize}
\item {} 
\sphinxcode{add} (array) User names to add to the CC
list. They must be full user names, and an
error will be thrown if you pass in an invalid
user name.

\item {} 
\sphinxcode{remove} (array) User names to remove from
the CC list. They must be full user names, and
an error will be thrown if you pass in an
invalid user name.

\end{itemize}
\\
\hline
is\_cc\_accessible
&
boolean
&
Whether or not users in the CC list are allowed
to access the bug, even if they aren't in a group
that can normally access the bug.
\\
\hline
comment
&
object
&
A comment on the change. The object may contain
the following items:
\begin{itemize}
\item {} 
\sphinxcode{body} (string) The actual text of the
comment. For compatibility with the parameters
to {\hyperref[\detokenize{api/core/v1/comment:rest-add-comment}]{\sphinxcrossref{\DUrole{std,std-ref}{Create Comments}}}}, you can also call
this field \sphinxcode{comment}, if you want.

\item {} 
\sphinxcode{is\_private} (boolean) Whether the comment is
private or not. If you try to make a comment
private and you don't have the permission to,
an error will be thrown.

\end{itemize}
\\
\hline
comment\_is\_private
&
object
&
This is how you update the privacy of comments
that are already on a bug. This is a object,
where the keys are the \sphinxcode{int} ID of comments
(not their count on a bug, like \#1, \#2, \#3, but
their globally-unique ID, as returned by
{\hyperref[\detokenize{api/core/v1/comment:rest-comments}]{\sphinxcrossref{\DUrole{std,std-ref}{Get Comments}}}} and the value is a
\sphinxcode{boolean} which specifies whether that comment
should become private (\sphinxcode{true}) or public
(\sphinxcode{false}).

The comment IDs must be valid for the bug being
updated. Thus, it is not practical to use this
while updating multiple bugs at once, as a single
comment ID will never be valid on multiple bugs.
\\
\hline
component
&
string
&
The Component the bug is in.
\\
\hline
deadline
&
date
&
The Deadline field is a date specifying when the
bug must be completed by, in the format
\sphinxcode{YYYY-MM-DD}.
\\
\hline
dupe\_of
&
int
&
The bug that this bug is a duplicate of. If you
want to mark a bug as a duplicate, the safest
thing to do is to set this value and \sphinxstyleemphasis{not} set
the \sphinxcode{status} or \sphinxcode{resolutio} fields. They will
automatically be set by Bugzilla to the
appropriate values for duplicate bugs.
\\
\hline
estimated\_time
&
double
&
The total estimate of time required to fix the
bug, in hours. This is the \sphinxstyleemphasis{total} estimate, not
the amount of time remaining to fix it.
\\
\hline
flags
&
array
&
An array of Flag change objects. The items needed
are described below.
\\
\hline
groups
&
object
&
The groups a bug is in. To modify this field,
pass an object, which may have the following
items:
\begin{itemize}
\item {} 
\sphinxcode{add} (array) The names of groups to add.
Passing in an invalid group name or a group
that you cannot add to this bug will cause an
error to be thrown.

\item {} 
\sphinxcode{remove} (array) The names of groups to
remove. Passing in an invalid group name or a
group that you cannot remove from this bug
will cause an error to be thrown.

\end{itemize}
\\
\hline
keywords
&
object
&
Keywords on the bug. To modify this field, pass
an object, which may have the following items:
\begin{itemize}
\item {} 
\sphinxcode{add} (array) The names of keywords to add
to the field on the bug. Passing something that
isn't a valid keyword name will cause an error
to be thrown.

\item {} 
\sphinxcode{remove} (array) The names of keywords to
remove from the field on the bug. Passing
something that isn't a valid keyword name will
cause an error to be thrown.

\item {} 
\sphinxcode{set} (array) An exact set of keywords to set
the field to, on the bug. Passing something
that isn't a valid keyword name will cause an
error to be thrown. Specifying \sphinxcode{set}
overrides \sphinxcode{add} and \sphinxcode{remove}.

\end{itemize}
\\
\hline
op\_sys
&
string
&
The Operating System ("OS") field on the bug.
\\
\hline
platform
&
string
&
The Platform or "Hardware" field on the bug.
\\
\hline
priority
&
string
&
The Priority field on the bug.
\\
\hline
product
&
string
&The name of the product that the bug is in. If
you change this, you will probably also want to
change \sphinxcode{target\_milestone}, \sphinxcode{version}, and
\sphinxcode{component}, since those have different legal
values in every product.

If you cannot change the \sphinxcode{target\_milestone}
field, it will be reset to the default for the
product, when you move a bug to a new product.

You may also wish to add or remove groups, as
which groups are
valid on a bug depends on the product. Groups
that are not valid in the new product will be
automatically removed, and groups which are
mandatory in the new product will be automaticaly
added, but no other automatic group changes will
be done.

\begin{sphinxadmonition}{note}{Note:}
Users can only move a bug into a product if
they would normally have permission to file
new bugs in that product.
\end{sphinxadmonition}
\\
\hline
qa\_contact
&
string
&
The full login name of the bug's QA Contact.
\\
\hline
is\_creator\_accessible
&
boolean
&
Whether or not the bug's reporter is allowed
to access the bug, even if they aren't in a group
that can normally access the bug.
\\
\hline
remaining\_time
&
double
&
How much work time is remaining to fix the bug,
in hours. If you set \sphinxcode{work\_time} but don't
explicitly set \sphinxcode{remaining\_time}, then the
\sphinxcode{work\_time} will be deducted from the bug's
\sphinxcode{remaining\_time}.
\\
\hline
reset\_assigned\_to
&
boolean
&
If true, the \sphinxcode{assigned\_to} field will be
reset to the default for the component that the
bug is in. (If you have set the component at the
same time as using this, then the component used
will be the new component, not the old one.)
\\
\hline
reset\_qa\_contact
&
boolean
&
If true, the \sphinxcode{qa\_contact} field will be reset
to the default for the component that the bug is
in. (If you have set the component at the same
time as using this, then the component used will
be the new component, not the old one.)
\\
\hline
resolution
&
string
&
The current resolution. May only be set if you
are closing a bug or if you are modifying an
already-closed bug. Attempting to set the
resolution to \sphinxstyleemphasis{any} value (even an empty or null
string) on an open bug will cause an error to be
thrown.

\begin{sphinxadmonition}{note}{Note:}
If you change the \sphinxcode{status} field to an open
status, the resolution field will automatically
be cleared, so you don't have to clear it
manually.
\end{sphinxadmonition}
\\
\hline
see\_also
&
object
&
The See Also field on a bug, specifying URLs to
bugs in other bug trackers. To modify this field,
pass an object, which may have the following
items:
\begin{itemize}
\item {} 
\sphinxcode{add} (array) URLs to add to the field. Each
URL must be a valid URL to a bug-tracker, or
an error will be thrown.

\item {} 
\sphinxcode{remove} (array) URLs to remove from the
field. Invalid URLs will be ignored.

\end{itemize}
\\
\hline
severity
&
string
&
The Severity field of a bug.
\\
\hline
status
&
string
&
The status you want to change the bug to. Note
that if a bug is changing from open to closed,
you should also specify a \sphinxcode{resolution}.
\\
\hline
summary
&
string
&
The Summary field of the bug.
\\
\hline
target\_milestone
&
string
&
The bug's Target Milestone.
\\
\hline
url
&
string
&
The "URL" field of a bug.
\\
\hline
version
&
string
&
The bug's Version field.
\\
\hline
whiteboard
&
string
&
The Status Whiteboard field of a bug.
\\
\hline
work\_time
&
double
&
The number of hours worked on this bug as part
of this change.
If you set \sphinxcode{work\_time} but don't explicitly
set \sphinxcode{remaining\_time}, then the \sphinxcode{work\_time}
will be deducted from the bug's \sphinxcode{remaining\_time}.
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}

You can also set the value of any custom field by passing its name as
a parameter, and the value to set the field to. For multiple-selection
fields, the value should be an array of strings.

Flag change object:

The following values can be specified. At least the \sphinxcode{status} and one of
\sphinxcode{type\_id}, \sphinxcode{id}, or \sphinxcode{name} must be specified. If a \sphinxcode{type\_id} or
\sphinxcode{name} matches a single currently set flag, the flag will be updated unless
\sphinxcode{new} is specified.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
The name of the flag that will be created or updated.
\\
\hline
type\_id
&
int
&
The internal flag type ID that will be created or updated.
You will need to specify the \sphinxcode{type\_id} if more than one
flag type of the same name exists.
\\
\hline
\sphinxstylestrong{status}
&
string
&
The flags new status (i.e. "?", "+", "-" or "X" to clear a
flag).
\\
\hline
requestee
&
string
&
The login of the requestee if the flag type is requestable
to a specific user.
\\
\hline
id
&
int
&
Use ID to specify the flag to be updated. You will need to
specify the \sphinxcode{id} if more than one flag is set of the same
name.
\\
\hline
new
&
boolean
&
Set to true if you specifically want a new flag to be
created.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}bugs\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}alias\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}changes\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
        \PYG{l+s+s2}{\PYGZdq{}keywords\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}funny, stupid\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}status\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
            \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}IN\PYGZus{}PROGRESS\PYGZdq{}}\PYG{p}{,}
            \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}CONFIRMED\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{35}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}last\PYGZus{}change\PYGZus{}time\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}29T14:25:35Z\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{bugs} (array) This points to an array of objects with the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the bug that was updated.
\\
\hline
alias
&
array
&
The aliases of the bug that was updated, if this bug
has any alias.
\\
\hline
last\_change\_time
&
datetime
&
The exact time that this update was done at, for
this bug. If no update was done (that is, no fields
had their values changed and no comment was added)
then this will instead be the last time the bug was
updated.
\\
\hline
changes
&
object
&
The changes that were actually done on this bug. The
keys are the names of the fields that were changed,
and the values are an object with two keys:
\begin{itemize}
\item {} 
\sphinxcode{added} (string) The values that were added to
this field, possibly a comma-and-space-separated
list if multiple values were added.

\item {} 
\sphinxcode{removed} (string) The values that were removed
from this field, possibly a
comma-and-space-separated list if multiple values
were removed.

\end{itemize}
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}

Currently, some fields are not tracked in changes: \sphinxcode{comment},
\sphinxcode{comment\_is\_private}, and \sphinxcode{work\_time}. This means that they will not
show up in the return value even if they were successfully updated.
This may change in a future version of Bugzilla.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Bug User Last Visited}
\label{\detokenize{api/core/v1/bug-user-last-visit::doc}}\label{\detokenize{api/core/v1/bug-user-last-visit:bug-user-last-visited}}

\subsubsection{Update Last Visited}
\label{\detokenize{api/core/v1/bug-user-last-visit:rest-bug-user-last-visit-update}}\label{\detokenize{api/core/v1/bug-user-last-visit:update-last-visited}}
Update the last-visited time for the specified bug and current user.

\sphinxstylestrong{Request}

To update the time for a single bug id:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/bug\PYGZus{}user\PYGZus{}last\PYGZus{}visit/(id)
\end{sphinxVerbatim}

To update one or more bug ids at once:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/bug\PYGZus{}user\PYGZus{}last\PYGZus{}visit
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{l+m+mi}{35}\PYG{p}{,}\PYG{l+m+mi}{36}\PYG{p}{,}\PYG{l+m+mi}{37}\PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id}
&
int
&
An integer bug id.
\\
\hline
\sphinxstylestrong{ids}
&
array
&
One or more bug ids to update.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}
  \PYG{p}{\PYGZob{}}
    \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{100}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}last\PYGZus{}visit\PYGZus{}ts\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}10\PYGZhy{}16T17:38:24Z\PYGZdq{}}
  \PYG{p}{\PYGZcb{}}
\PYG{p}{]}
\end{sphinxVerbatim}

An array of objects containing the items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The bug id.
\\
\hline
last\_visit\_ts
&
datetime
&
The timestamp the user last visited the bug.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Get Last Visited}
\label{\detokenize{api/core/v1/bug-user-last-visit:get-last-visited}}\label{\detokenize{api/core/v1/bug-user-last-visit:rest-bug-user-last-visit-get}}
\sphinxstylestrong{Request}

Get the last-visited timestamp for one or more specified bug ids or get a
list of the last 20 visited bugs and their timestamps.

To return the last-visited timestamp for a single bug id:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug\PYGZus{}user\PYGZus{}last\PYGZus{}visit/(id)
\end{sphinxVerbatim}

To return more than one specific bug timestamps:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug\PYGZus{}user\PYGZus{}last\PYGZus{}visit/123?ids=234\PYGZam{}ids=456
\end{sphinxVerbatim}

To return just the most recent 20 timestamps:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug\PYGZus{}user\PYGZus{}last\PYGZus{}visit
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id}
&
int
&
An integer bug id.
\\
\hline
\sphinxstylestrong{ids}
&
array
&
One or more optional bug ids to get.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}
  \PYG{p}{\PYGZob{}}
    \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{100}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}last\PYGZus{}visit\PYGZus{}ts\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}10\PYGZhy{}16T17:38:24Z\PYGZdq{}}
  \PYG{p}{\PYGZcb{}}
\PYG{p}{]}
\end{sphinxVerbatim}

An array of objects containing the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The bug id.
\\
\hline
last\_visit\_ts
&
datetime
&
The timestamp the user last visited the bug.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Bugzilla Information}
\label{\detokenize{api/core/v1/bugzilla::doc}}\label{\detokenize{api/core/v1/bugzilla:bugzilla-information}}
These methods are used to get general configuration information about this
Bugzilla instance.


\subsubsection{Version}
\label{\detokenize{api/core/v1/bugzilla:version}}
Returns the current version of Bugzilla. Normally in the format of \sphinxcode{X.X} or
\sphinxcode{X.X.X}. For example, \sphinxcode{4.4} for the initial release of a new branch. Or
\sphinxcode{4.4.6} for a minor release on the same branch.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/version
\end{sphinxVerbatim}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}version\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}4.5.5+\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
version
&
string
&
The current version of this Bugzilla
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Extensions}
\label{\detokenize{api/core/v1/bugzilla:extensions}}
Gets information about the extensions that are currently installed and enabled
in this Bugzilla.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/extensions
\end{sphinxVerbatim}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}extensions\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
    \PYG{l+s+s2}{\PYGZdq{}Voting\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}version\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}4.5.5+\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}BmpConvert\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}version\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1.0\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{\PYGZcb{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
extensions
&
object
&
An object containing the extensions enabled as keys.
Each extension object contains the following keys:
\begin{itemize}
\item {} 
\sphinxcode{version} (string) The version of the extension.

\end{itemize}
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Timezone}
\label{\detokenize{api/core/v1/bugzilla:timezone}}
Returns the timezone in which Bugzilla expects to receive dates and times on the API.
Currently hard-coded to UTC ("+0000"). This is unlikely to change.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/timezone
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}timezone\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}+0000\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxstylestrong{Response}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
timezone
&
string
&
The timezone offset as a string in (+/-)XXXX (RFC 2822) format.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Time}
\label{\detokenize{api/core/v1/bugzilla:time}}
Gets information about what time the Bugzilla server thinks it is, and
what timezone it's running in.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/time
\end{sphinxVerbatim}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}web\PYGZus{}time\PYGZus{}utc\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}26T18:01:30Z\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}db\PYGZus{}time\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}26T18:01:30Z\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}web\PYGZus{}time\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}26T18:01:30Z\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}tz\PYGZus{}offset\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}+0000\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}tz\PYGZus{}short\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}UTC\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}tz\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}UTC\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
db\_time
&
string
&
The current time in UTC, according to the Bugzilla
database server.

Note that Bugzilla assumes that the database and the
webserver are running in the same time zone. However,
if the web server and the database server aren't
synchronized or some reason, \sphinxstyleemphasis{this} is the time that
you should rely on or doing searches and other input
to the WebService.
\\
\hline
web\_time
&
string
&
This is the current time in UTC, according to
Bugzilla's web server.

This might be different by a second from \sphinxcode{db\_time}
since this comes from a different source. If it's any
more different than a second, then there is likely
some problem with this Bugzilla instance. In this
case you should rely  on the \sphinxcode{db\_time}, not the
\sphinxcode{web\_time}.
\\
\hline
web\_time\_utc
&
string
&
Identical to \sphinxcode{web\_time}. (Exists only for
backwards-compatibility with versions of Bugzilla
before 3.6.)
\\
\hline
tz\_name
&
string
&
The literal string \sphinxcode{UTC}. (Exists only for
backwards-compatibility with versions of Bugzilla
before 3.6.)
\\
\hline
tz\_short\_name
&
string
&
The literal string \sphinxcode{UTC}. (Exists only for
backwards-compatibility with versions of Bugzilla
before 3.6.)
\\
\hline
tz\_offset
&
string
&
The literal string \sphinxcode{+0000}. (Exists only for
backwards-compatibility with versions of Bugzilla
before 3.6.)
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Parameters}
\label{\detokenize{api/core/v1/bugzilla:parameters}}
Returns parameter values currently used in this Bugzilla.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/parameters
\end{sphinxVerbatim}

\sphinxstylestrong{Response}

Example response for anonymous user:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
   \PYG{l+s+s2}{\PYGZdq{}parameters\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}maintainer\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}admin@example.com\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}requirelogin\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}
   \PYG{p}{\PYGZcb{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Example response for authenticated user:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
   \PYG{l+s+s2}{\PYGZdq{}parameters\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
       \PYG{l+s+s2}{\PYGZdq{}allowemailchange\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}attachment\PYGZus{}base\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}http://bugzilla.example.com/\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}commentonchange\PYGZus{}resolution\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}commentonduplicate\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}cookiepath\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}/\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}createemailregexp\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}.*\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}defaultopsys\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}defaultplatform\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}defaultpriority\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}defaultseverity\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}normal\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}duplicate\PYGZus{}or\PYGZus{}move\PYGZus{}bug\PYGZus{}status\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}RESOLVED\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}emailregexp\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZca{}[\PYGZbs{}\PYGZbs{}w\PYGZbs{}\PYGZbs{}.\PYGZbs{}\PYGZbs{}+\PYGZbs{}\PYGZbs{}\PYGZhy{}=\PYGZsq{}]+@[\PYGZbs{}\PYGZbs{}w\PYGZbs{}\PYGZbs{}.\PYGZbs{}\PYGZbs{}\PYGZhy{}]+\PYGZbs{}\PYGZbs{}.[\PYGZbs{}\PYGZbs{}w\PYGZbs{}\PYGZbs{}\PYGZhy{}]+\PYGZdl{}\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}emailsuffix\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}letsubmitterchoosemilestone\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}letsubmitterchoosepriority\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}mailfrom\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}bugzilla\PYGZhy{}daemon@example.com\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}maintainer\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}admin@example.com\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}maxattachmentsize\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1000\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}maxlocalattachment\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}musthavemilestoneonaccept\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}noresolveonopenblockers\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}password\PYGZus{}complexity\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}no\PYGZus{}constraints\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}rememberlogin\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}on\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}requirelogin\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}urlbase\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}http://bugzilla.example.com/\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}use\PYGZus{}see\PYGZus{}also\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}useclassification\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}usemenuforusers\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}useqacontact\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}usestatuswhiteboard\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
       \PYG{l+s+s2}{\PYGZdq{}usetargetmilestone\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
   \PYG{p}{\PYGZcb{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

A logged-out user can only access the \sphinxcode{maintainer} and \sphinxcode{requirelogin}
parameters.

A logged-in user can access the following parameters (listed alphabetically):
\begin{itemize}
\item {} 
allowemailchange

\item {} 
attachment\_base

\item {} 
commentonchange\_resolution

\item {} 
commentonduplicate

\item {} 
cookiepath

\item {} 
defaultopsys

\item {} 
defaultplatform

\item {} 
defaultpriority

\item {} 
defaultseverity

\item {} 
duplicate\_or\_move\_bug\_status

\item {} 
emailregexpdesc

\item {} 
emailsuffix

\item {} 
letsubmitterchoosemilestone

\item {} 
letsubmitterchoosepriority

\item {} 
mailfrom

\item {} 
maintainer

\item {} 
maxattachmentsize

\item {} 
maxlocalattachment

\item {} 
musthavemilestoneonaccept

\item {} 
noresolveonopenblockers

\item {} 
password\_complexity

\item {} 
rememberlogin

\item {} 
requirelogin

\item {} 
search\_allow\_no\_criteria

\item {} 
urlbase

\item {} 
use\_see\_also

\item {} 
useclassification

\item {} 
usemenuforusers

\item {} 
useqacontact

\item {} 
usestatuswhiteboard

\item {} 
usetargetmilestone

\end{itemize}

A user in the tweakparams group can access all existing parameters.
New parameters can appear or obsolete parameters can disappear depending
on the version of Bugzilla and on extensions being installed.
The list of parameters returned by this method is not stable and will
never be stable.


\subsubsection{Last Audit Time}
\label{\detokenize{api/core/v1/bugzilla:last-audit-time}}
Gets the most recent timestamp among all of the events recorded in the audit\_log
table.

\sphinxstylestrong{Request}

To get most recent audit timestamp for all classes:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/last\PYGZus{}audit\PYGZus{}time
\end{sphinxVerbatim}

To get the the most recent audit timestamp for the \sphinxcode{Bugzilla::Product} class:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/last\PYGZus{}audit\PYGZus{}time?class=Bugzilla::Product
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
class
&
array
&
The class names are defined as \sphinxcode{Bugzilla::\textless{}class\_name\textgreater{}"} such as
Bugzilla:Product{}`{}` for products.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}last\PYGZus{}audit\PYGZus{}time\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2014\PYGZhy{}09\PYGZhy{}23T18:03:38Z\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
last\_audit\_time
&
string
&
The maximum of the at\_time from the audit\_log.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Classifications}
\label{\detokenize{api/core/v1/classification:classifications}}\label{\detokenize{api/core/v1/classification::doc}}
This part of the Bugzilla API allows you to deal with the available
classifications. You will be able to get information about them as well as
manipulate them.


\subsubsection{Get Classification}
\label{\detokenize{api/core/v1/classification:get-classification}}\label{\detokenize{api/core/v1/classification:rest-get-classification}}
Returns an object containing information about a set of classifications.

\sphinxstylestrong{Request}

To return information on a single classification using the ID or name:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/classification/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id\_or\_name}
&
mixed
&
An Integer classification ID or name.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}classifications\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{0}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Unassigned to any classifications\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}products\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{2}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}FoodReplicator\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Software that controls a piece of hardware that will create any food item through a voice interface.\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Silk, etc.\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Spider Secretions\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{4}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{1}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Unclassified\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{classifications} (array) Each object is a classification that the user is
authorized to see and has the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the classification.
\\
\hline
name
&
string
&
The name of the classification.
\\
\hline
description
&
string
&
The description of the classificaion.
\\
\hline
sort\_key
&
int
&
The value which determines the order the classification is
sorted.
\\
\hline
products
&
array
&
Products the user is authorized to
access within the classification. Each hash has the
following keys:
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Product object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
The name of the product.
\\
\hline
id
&
int
&
The ID of the product.
\\
\hline
description
&
string
&
The description of the product.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Comments}
\label{\detokenize{api/core/v1/comment::doc}}\label{\detokenize{api/core/v1/comment:comments}}

\subsubsection{Get Comments}
\label{\detokenize{api/core/v1/comment:get-comments}}\label{\detokenize{api/core/v1/comment:rest-comments}}
This allows you to get data about comments, given a bug ID or comment ID.

\sphinxstylestrong{Request}

To get all comments for a particular bug using the bug ID or alias:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/(id\PYGZus{}or\PYGZus{}alias)/comment
\end{sphinxVerbatim}

To get a specific comment based on the comment ID:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/comment/(comment\PYGZus{}id)
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id\_or\_alias}
&
mixed
&
A single integer bug ID or alias.
\\
\hline
\sphinxstylestrong{comment\_id}
&
int
&
A single integer comment ID.
\\
\hline
new\_since
&
datetime
&
If specified, the method will only return comments
\sphinxstyleemphasis{newer} than this time. This only affects comments
returned from the \sphinxcode{ids} argument. You will always be
returned all comments you request in the
\sphinxcode{comment\_ids} argument, even if they are older than
this date.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}bugs\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
    \PYG{l+s+s2}{\PYGZdq{}35\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}comments\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}time\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2000\PYGZhy{}07\PYGZhy{}25T13:50:04Z\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}text\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}test bug to fix problem in removing from cc list.\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}bug\PYGZus{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{35}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}count\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{0}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}attachment\PYGZus{}id\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}private\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}tags\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}creator\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}creation\PYGZus{}time\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}2000\PYGZhy{}07\PYGZhy{}25T13:50:04Z\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{75}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{\PYGZcb{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}comments\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}\PYG{p}{\PYGZcb{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Two items are returned:

\sphinxcode{bugs} This is used for bugs specified in \sphinxcode{ids}. This is an object,
where the keys are the numeric IDs of the bugs, and the value is
a object with a single key, \sphinxcode{comments}, which is an array of comments.
(The format of comments is described below.)

Any individual bug will only be returned once, so if you specify an ID
multiple times in \sphinxcode{ids}, it will still only be returned once.

\sphinxcode{comments} Each individual comment requested in \sphinxcode{comment\_ids} is
returned here, in a object where the numeric comment ID is the key,
and the value is the comment. (The format of comments is described below.)

A "comment" as described above is a object that contains the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The globally unique ID for the comment.
\\
\hline
bug\_id
&
int
&
The ID of the bug that this comment is on.
\\
\hline
attachment\_id
&
int
&
If the comment was made on an attachment, this will be
the ID of that attachment. Otherwise it will be null.
\\
\hline
count
&
int
&
The number of the comment local to the bug. The
Description is 0, comments start with 1.
\\
\hline
text
&
string
&
The actual text of the comment.
\\
\hline
creator
&
string
&
The login name of the comment's author.
\\
\hline
time
&
datetime
&
The time (in Bugzilla's timezone) that the comment was
added.
\\
\hline
creation\_time
&
datetime
&
This is exactly same as the \sphinxcode{time} key. Use this
field instead of \sphinxcode{time} for consistency with other
methods including {\hyperref[\detokenize{api/core/v1/bug:rest-single-bug}]{\sphinxcrossref{\DUrole{std,std-ref}{Get Bug}}}} and
{\hyperref[\detokenize{api/core/v1/attachment:rest-attachments}]{\sphinxcrossref{\DUrole{std,std-ref}{Get Attachment}}}}.

For compatibility, \sphinxcode{time} is still usable. However,
please note that \sphinxcode{time} may be deprecated and removed
in a future release.
\\
\hline
is\_private
&
boolean
&
\sphinxcode{true} if this comment is private (only visible to a
certain group called the "insidergroup"), \sphinxcode{false}
otherwise.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Create Comments}
\label{\detokenize{api/core/v1/comment:rest-add-comment}}\label{\detokenize{api/core/v1/comment:create-comments}}
This allows you to add a comment to a bug in Bugzilla.

\sphinxstylestrong{Request}

To create a comment on a current bug.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/bug/(id)/comment
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{l+m+mi}{123}\PYG{p}{,}\PYG{p}{.}\PYG{p}{.}\PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}comment\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}This is an additional comment\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}private\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{false}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{ids} is optional in the data example above and can be used to specify adding
a comment to more than one bug at the same time.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id}
&
int
&
The ID or alias of the bug to append a comment to.
\\
\hline
ids
&
array
&
List of integer bug IDs to add the comment to.
\\
\hline
\sphinxstylestrong{comment}
&
string
&
The comment to append to the bug. If this is empty
or all whitespace, an error will be thrown saying that you
did not set the \sphinxcode{comment} parameter.
\\
\hline
is\_private
&
boolean
&
If set to true, the comment is private, otherwise it is
assumed to be public.
\\
\hline
work\_time
&
double
&
Adds this many hours to the "Hours Worked" on the bug.
If you are not in the time tracking group, this value will
be ignored.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{789}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
ID of the newly-created comment.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Search Comment Tags}
\label{\detokenize{api/core/v1/comment:search-comment-tags}}\label{\detokenize{api/core/v1/comment:rest-search-comment-tags}}
Searches for tags which contain the provided substring.

\sphinxstylestrong{Request}

To search for comment tags:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/comment/tags/(query)
\end{sphinxVerbatim}

Example:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/bug/comment/tags/spa
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{query}
&
string
&
Only tags containg this substring will be returned.
\\
\hline
limit
&
int
&
If provided will return no more than \sphinxcode{limit} tags.
Defaults to \sphinxcode{10}.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}
  \PYG{l+s+s2}{\PYGZdq{}spam\PYGZdq{}}
\PYG{p}{]}
\end{sphinxVerbatim}

An array of matching tags.


\subsubsection{Update Comment Tags}
\label{\detokenize{api/core/v1/comment:update-comment-tags}}\label{\detokenize{api/core/v1/comment:rest-update-comment-tags}}
Adds or removes tags from a comment.

\sphinxstylestrong{Request}

To update the tags comments attached to a comment:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
PUT /rest/bug/comment/(comment\PYGZus{}id)/tags
\end{sphinxVerbatim}

Example:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}comment\PYGZus{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{75}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}add\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{l+s+s2}{\PYGZdq{}spam\PYGZdq{}}\PYG{p}{,} \PYG{l+s+s2}{\PYGZdq{}bad\PYGZdq{}}\PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{comment\_id}
&
int
&
The ID of the comment to update.
\\
\hline
add
&
array
&
The tags to attach to the comment.
\\
\hline
remove
&
array
&
The tags to detach from the comment.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}
  \PYG{l+s+s2}{\PYGZdq{}bad\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}spam\PYGZdq{}}
\PYG{p}{]}
\end{sphinxVerbatim}

An array of strings containing the comment's updated tags.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Components}
\label{\detokenize{api/core/v1/component::doc}}\label{\detokenize{api/core/v1/component:components}}
This part of the Bugzilla API allows you to deal with the available product
components. You will be able to get information about them as well as manipulate
them.


\subsubsection{Create Component}
\label{\detokenize{api/core/v1/component:create-component}}
This allows you to create a new component in Bugzilla. You must be authenticated
and be in the \sphinxstyleemphasis{editcomponents} group to perform this action.

\sphinxstylestrong{Request}

To create a new component:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/component
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}product\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}TestProduct\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}New Component\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}This is a new component\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}default\PYGZus{}assignee\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}dkl@mozilla.com\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Some params must be set, or an error will be thrown. These params are
shown in \sphinxstylestrong{bold}.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{name}
&
string
&
The name of the new component.
\\
\hline
\sphinxstylestrong{product}
&
string
&
The name of the product that the component must
be added to. This product must already exist, and
the user have the necessary permissions to edit
components for it.
\\
\hline
\sphinxstylestrong{description}
&
string
&
The description of the new component.
\\
\hline
\sphinxstylestrong{default\_assignee}
&
string
&
The login name of the default assignee of the
component.
\\
\hline
default\_cc
&
array
&
Each string representing one login name of the
default CC list.
\\
\hline
default\_qa\_contact
&
string
&
The login name of the default QA contact for the
component.
\\
\hline
is\_open
&
boolean
&
1 if you want to enable the component for bug
creations. 0 otherwise. Default is 1.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{27}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the newly-added component.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Bug Fields}
\label{\detokenize{api/core/v1/field::doc}}\label{\detokenize{api/core/v1/field:bug-fields}}
The Bugzilla API for getting details about bug fields.


\subsubsection{Fields}
\label{\detokenize{api/core/v1/field:fields}}\label{\detokenize{api/core/v1/field:rest-fields}}
Get information about valid bug fields, including the lists of legal values
for each field.

\sphinxstylestrong{Request}

To get information about all fields:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/field/bug
\end{sphinxVerbatim}

To get information related to a single field:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/field/bug/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id\_or\_name
&
mixed
&
An integer field ID or string representing the field name.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}fields\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}display\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Priority\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}priority\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}type\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{2}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}mandatory\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}value\PYGZus{}field\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}sortkey\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{100}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{100}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}visibility\PYGZus{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P1\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{200}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P2\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}visibility\PYGZus{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sortkey\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{200}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{300}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}visibility\PYGZus{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P3\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sortkey\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{300}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{400}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P4\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}visibility\PYGZus{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sortkey\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{400}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}P5\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}visibility\PYGZus{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{500}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sortkey\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{500}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}visibility\PYGZus{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}\PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}visibility\PYGZus{}field\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}on\PYGZus{}bug\PYGZus{}entry\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}custom\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{13}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{field} (array) Field objects each containing the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
An integer ID uniquely identifying this field in this
installation only.
\\
\hline
type
&
int
&
The number of the fieldtype. The following values are
defined:
\begin{itemize}
\item {} 
\sphinxcode{0} Field type unknown

\item {} 
\sphinxcode{1} Single-line string field

\item {} 
\sphinxcode{2} Single value field

\item {} 
\sphinxcode{3} Multiple value field

\item {} 
\sphinxcode{4} Multi-line text value

\item {} 
\sphinxcode{5} Date field with time

\item {} 
\sphinxcode{6} Bug ID field

\item {} 
\sphinxcode{7} See Also field

\item {} 
\sphinxcode{8} Keywords field

\item {} 
\sphinxcode{9} Date field

\item {} 
\sphinxcode{10} Integer field

\end{itemize}
\\
\hline
is\_custom
&
boolean
&
\sphinxcode{true} when this is a custom field, \sphinxcode{false}
otherwise.
\\
\hline
name
&
string
&
The internal name of this field. This is a unique
identifier for this field. If this is not a custom
field, then this name will be the same across all
Bugzilla installations.
\\
\hline
display\_name
&
string
&
The name of the field, as it is shown in the user
interface.
\\
\hline
is\_mandatory
&
boolean
&
\sphinxcode{true} if the field must have a value when filing
new bugs. Also, mandatory fields cannot have their
value cleared when updating bugs.
\\
\hline
is\_on\_bug\_entry
&
boolean
&
For custom fields, this is \sphinxcode{true} if the field is
shown when you enter a new bug. For standard fields,
this is currently always \sphinxcode{false}, even if the field
shows up when entering a bug. (To know whether or not
a standard field is valid on bug entry, see
{\hyperref[\detokenize{api/core/v1/bug:rest-create-bug}]{\sphinxcrossref{\DUrole{std,std-ref}{Create Bug}}}}.
\\
\hline
visibility\_field
&
string
&
The name of a field that controls the visibility of
this field in the user interface. This field only
appears in the user interface when the named field is
equal to one of the values is \sphinxcode{visibility\_values}.
Can be null.
\\
\hline
visibility\_values
&
array
&
This field is only shown when \sphinxcode{visibility\_field}
matches one of these string values. When
\sphinxcode{visibility\_field} is null, then this is an empty
array.
\\
\hline
value\_field
&
string
&
The name of the field that controls whether or not
particular values of the field are shown in the user
interface. Can be null.
\\
\hline
values
&
array
&
Objects representing the legal values for
select-type (drop-down and multiple-selection)
fields. This is  also populated for the
\sphinxcode{component}, \sphinxcode{version}, \sphinxcode{target\_milestone},
and \sphinxcode{keywords} fields, but not for the \sphinxcode{product}
field (you must use \sphinxcode{get\_accessible\_products} for
that). For fields that aren't select-type fields,
this will simply be an empty array. Each object
contains the items described in the Value object
below.
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}

Value object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
The actual value--this is what you would specify for
this field in \sphinxcode{create}, etc.
\\
\hline
sort\_key
&
int
&
Values, when displayed in a list, are sorted first by
this integer and then secondly by their name.
\\
\hline
visibility\_values
&
array
&
If \sphinxcode{value\_field} is defined for this field, then
this value is only shown if the \sphinxcode{value\_field} is
set to one of the values listed in this array. Note
that for per-product fields, \sphinxcode{value\_field} is set
to \sphinxcode{product} and \sphinxcode{visibility\_values} will reflect
which product(s) this value appears in.
\\
\hline
is\_active
&
boolean
&
This value is defined only for certain
product-specific fields such as version,
target\_milestone or component. When true, the value
is active; otherwise the value is not active.
\\
\hline
description
&
string
&
The description of the value. This item is only
included for the \sphinxcode{keywords} field.
\\
\hline
is\_open
&
boolean
&
For \sphinxcode{bug\_status} values, determines whether this
status specifies that the bug is "open" (\sphinxcode{true})
or "closed" (\sphinxcode{false}). This item is only included
for the \sphinxcode{bug\_status} field.
\\
\hline
can\_change\_to
&
array
&For \sphinxcode{bug\_status} values, this is an array of
objects that determine which statuses you can
transition to from this status. (This item is only
included for the \sphinxcode{bug\_status} field.)

Each object contains the following items:
\begin{itemize}
\item {} 
name: (string) The name of the new status

\item {} 
comment\_required: (boolean) \sphinxcode{true} if a comment
is required when you change a bug into this status
using this transition.

\end{itemize}
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Legal Values}
\label{\detokenize{api/core/v1/field:legal-values}}\label{\detokenize{api/core/v1/field:rest-legal-values}}
\sphinxstylestrong{DEPRECATED} Use ''Fields'' instead.

Tells you what values are allowed for a particular field.

\sphinxstylestrong{Request}

To get information on the values for a field based on field name:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/field/bug/(field)/values
\end{sphinxVerbatim}

To get information based on field name and a specific product:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/field/bug/(field)/(product\PYGZus{}id)/values
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
field
&
string
&
The name of the field you want information about.
This should be the same as the name you would use in
{\hyperref[\detokenize{api/core/v1/bug:rest-create-bug}]{\sphinxcrossref{\DUrole{std,std-ref}{Create Bug}}}}, below.
\\
\hline
product\_id
&
int
&
If you're picking a product-specific field, you have to
specify the ID of the product you want the values for.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Resppnse}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{l+s+s2}{\PYGZdq{}P1\PYGZdq{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}P2\PYGZdq{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}P3\PYGZdq{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}P4\PYGZdq{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}P5\PYGZdq{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
values
&
array
&
The legal values for this field. The values will be sorted
as they normally would be in Bugzilla.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Flag Types}
\label{\detokenize{api/core/v1/flagtype:flag-types}}\label{\detokenize{api/core/v1/flagtype::doc}}
This part of the Bugzilla API allows you to get and create bug and attachment
flags.


\subsubsection{Get Flag Type}
\label{\detokenize{api/core/v1/flagtype:rest-flagtype-get}}\label{\detokenize{api/core/v1/flagtype:get-flag-type}}
Get information about valid flag types that can be set for bugs and attachments.

\sphinxstylestrong{Request}

To get information about all flag types for a product:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/flag\PYGZus{}type/(product)
\end{sphinxVerbatim}

To get information about flag\_types for a product and component:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/flag\PYGZus{}type/(product)/(component)
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}bug\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}multiplicable\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requesteeble\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{l+s+s2}{\PYGZdq{}X\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}?\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}+\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZdq{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{11}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}type\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}bug\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Blocks the next release\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}blocker\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}\PYG{p}{,}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requesteeble\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}multiplicable\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Regression found?\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}regression\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{10}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}type\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}bug\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{l+s+s2}{\PYGZdq{}X\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}?\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}+\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZdq{}}
      \PYG{p}{]}
    \PYG{p}{\PYGZcb{}}\PYG{p}{,}
  \PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}attachment\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requesteeble\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}multiplicable\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}review\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Review the patch for correctness and applicability to the problem.\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}type\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}attachment\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{1}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{l+s+s2}{\PYGZdq{}X\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}?\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}+\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZdq{}}
      \PYG{p}{]}
    \PYG{p}{\PYGZcb{}}\PYG{p}{,}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}approval\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Approve the patch for check\PYGZhy{}in to the tree.\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}values\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{l+s+s2}{\PYGZdq{}X\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}?\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}+\PYGZdq{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZdq{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}type\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}attachment\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{3}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}multiplicable\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requesteeble\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

You must pass a product name and an optional component name. If the product or
component names contains a \sphinxcode{/} character, up will need to url encode it.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{product}
&
string
&
The name of a valid product.
\\
\hline
component
&
string
&
An optional valid component name associated with the
product.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

An object containing two items, \sphinxcode{bug} and \sphinxcode{attachment}. Each value is an
array of objects, containing the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
An integer ID uniquely identifying this flag type.
\\
\hline
name
&
string
&
The name for the flag type.
\\
\hline
type
&
string
&
The target of the flag type which is either \sphinxcode{bug}
or \sphinxcode{attachment}.
\\
\hline
description
&
string
&
The description of the flag type.
\\
\hline
values
&
array
&
String values that the user can set on the flag type.
\\
\hline
is\_requesteeble
&
boolean
&
Users can ask specific other users to set flags of
this type.
\\
\hline
is\_multiplicable
&
boolean
&
Multiple flags of this type can be set for the same
bug or attachment.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Create Flag Type}
\label{\detokenize{api/core/v1/flagtype:create-flag-type}}
Create a new flag type. You must be authenticated and be in the \sphinxstyleemphasis{editcomponents}
group to perform this action.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/flag\PYGZus{}type
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}feedback\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}This attachment needs feedback\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}inclusions\PYGZdq{}} \PYG{o}{:} \PYG{p}{[} \PYG{l+s+s2}{\PYGZdq{}WorldControl \PYGZdq{}}\PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}target\PYGZus{}type\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}attachment\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Some params must be set, or an error will be thrown. The required params are
marked in \sphinxstylestrong{bold}.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{name}
&
string
&
The name of the new flag type.
\\
\hline
\sphinxstylestrong{description}
&
string
&
A description for the flag type.
\\
\hline
target\_type
&
string
&
The new flag is either for a \sphinxcode{bug} or an
\sphinxcode{attachment}.
\\
\hline
inclusions
&
array
&
An array of strings or an object containing
product names, and optionally component
names. If you provide a string, the flag
type will be shown on all bugs in that
product. If you provide an object, the key
represents the product name, and the value
is the components of the product to be
included.
\\
\hline
exclusions
&
array
&
An array of strings or an object containing
product names. This uses the same format as
\sphinxcode{inclusions}. This will exclude the flag
from all products and components specified.
\\
\hline
sortkey
&
int
&
A number between 1 and 32767 by which this
type will be sorted when displayed to users
in a list; ignore if you don't care what
order the types appear in or if you want
them to appear in alphabetical order.
\\
\hline
is\_active
&
boolean
&
Flag of this type appear in the UI and can
be set. Default is \sphinxcode{true}.
\\
\hline
is\_requestable
&
boolean
&
Users can ask for flags of this type to be
set. Default is \sphinxcode{true}.
\\
\hline
cc\_list
&
array
&
If the flag type is requestable, who should
receive e-mail notification of requests.
This is an array of e-mail addresses whichdo not need to be Bugzilla logins.
\\
\hline
is\_specifically\_requestable
&
boolean
&
Users can ask specific other users to
set flags of this type as opposed to just
asking the wind. Default is \sphinxcode{true}.
\\
\hline
is\_multiplicable
&
boolean
&
Multiple flags of this type can be set on
the same bug. Default is \sphinxcode{true}.
\\
\hline
grant\_group
&
string
&
The group allowed to grant/deny flags of
this type (to allow all users to grant/deny
these flags, select no group). Default is
no group.
\\
\hline
request\_group
&
string
&
If flags of this type are requestable, the
group allowed to request them (to allow all
users to request these flags, select no
group). Note that the request group alone
has no effect if the grant group is not
defined! Default is no group.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

An example for \sphinxcode{inclusions} and/or \sphinxcode{exclusions}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}
  \PYG{l+s+s2}{\PYGZdq{}FooProduct\PYGZdq{}}
\PYG{p}{]}

\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}BarProduct\PYGZdq{}} \PYG{o}{:} \PYG{p}{[} \PYG{l+s+s2}{\PYGZdq{}C1\PYGZdq{}}\PYG{p}{,} \PYG{l+s+s2}{\PYGZdq{}C3\PYGZdq{}} \PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}BazProduct\PYGZdq{}} \PYG{o}{:} \PYG{p}{[} \PYG{l+s+s2}{\PYGZdq{}C7\PYGZdq{}} \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

This flag will be added to \sphinxstylestrong{all} components of \sphinxcode{FooProduct}, components C1
and C3 of \sphinxcode{BarProduct}, and C7 of \sphinxcode{BazProduct}.

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{13}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
flag\_id
&
int
&
ID of the new FlagType object is returned.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Update Flag Type}
\label{\detokenize{api/core/v1/flagtype:update-flag-type}}\label{\detokenize{api/core/v1/flagtype:rest-flagtype-update}}
This allows you to update a flag type in Bugzilla. You must be authenticated
and be in the \sphinxstyleemphasis{editcomponents} group to perform this action.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
PUT /rest/flag\PYGZus{}type/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{l+m+mi}{13}\PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}feedback\PYGZhy{}new\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requestable\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{false}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

You can edit a single flag type by passing the ID or name of the flag type
in the URL. To edit more than one flag type, you can specify addition IDs or
flag type names using the \sphinxcode{ids} or \sphinxcode{names} parameters respectively.

One of the below must be specified.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id\_or\_name}
&
mixed
&
Integer flag type ID or name.
\\
\hline
\sphinxstylestrong{ids}
&
array
&
Numeric IDs of the flag types that you wish to update.
\\
\hline
\sphinxstylestrong{names}
&
array
&
Names of the flag types that you wish to update. If many
flag types have the same name, this will change \sphinxstylestrong{all}
of them.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

The following parameters specify the new values you want to set for the flag
types you are updating.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
A short name identifying this type.
\\
\hline
description
&
string
&
A comprehensive description of this type.
\\
\hline
inclusions
&
array
&
An array of strings or an object containing
product names, and optionally component
names. If you provide a string, the flag
type will be shown on all bugs in that
product. If you provide an object, the key
represents the product name, and the value
is the components of the product to be
included.
\\
\hline
exclusions
&
array
&
An array of strings or an object containing
product names. This uses the same format as
\sphinxcode{inclusions}. This will exclude the flag
from all products and components specified.
\\
\hline
sortkey
&
int
&
A number between 1 and 32767 by which this
type will be sorted when displayed to users
in a list; ignore if you don't care what
order the types appear in or if you want
them to appear in alphabetical order.
\\
\hline
is\_active
&
boolean
&
Flag of this type appear in the UI and can
be set.
\\
\hline
is\_requestable
&
boolean
&
Users can ask for flags of this type to be
set.
\\
\hline
cc\_list
&
array
&
If the flag type is requestable, who should
receive e-mail notification of requests.
This is an array of e-mail addresses
which do not need to be Bugzilla logins.
\\
\hline
is\_specifically\_requestable
&
boolean
&
Users can ask specific other users to set
flags of this type as opposed to just
asking the wind.
\\
\hline
is\_multiplicable
&
boolean
&
Multiple flags of this type can be set on
the same bug.
\\
\hline
grant\_group
&
string
&
The group allowed to grant/deny flags of
this type (to allow all users to grant/deny
these flags, select no group).
\\
\hline
request\_group
&
string
&
If flags of this type are requestable, the
group allowed to request them (to allow all
users to request these flags, select no
group). Note that the request group alone
has no effect if the grant group is not
defined!
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

An example for \sphinxcode{inclusions} and/or \sphinxcode{exclusions}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}
  \PYG{l+s+s2}{\PYGZdq{}FooProduct\PYGZdq{}}\PYG{p}{,}
\PYG{p}{]}

\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}BarProduct\PYGZdq{}} \PYG{o}{:} \PYG{p}{[} \PYG{l+s+s2}{\PYGZdq{}C1\PYGZdq{}}\PYG{p}{,} \PYG{l+s+s2}{\PYGZdq{}C3\PYGZdq{}} \PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}BazProduct\PYGZdq{}} \PYG{o}{:} \PYG{p}{[} \PYG{l+s+s2}{\PYGZdq{}C7\PYGZdq{}} \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

This flag will be added to \sphinxstylestrong{all} components of \sphinxcode{FooProduct},
components C1 and C3 of \sphinxcode{BarProduct}, and C7 of \sphinxcode{BazProduct}.

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}flagtypes\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}feedback\PYGZhy{}new\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}changes\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
        \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requestable\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}feedback\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}feedback\PYGZhy{}new\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{13}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{flagtypes} (array) Flag change objects containing the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the flag type that was updated.
\\
\hline
name
&
string
&
The name of the flag type that was updated.
\\
\hline
changes
&
object
&
The changes that were actually done on this flag type.
The keys are the names of the fields that were changed, and the
values are an object with two items:
\begin{itemize}
\item {} 
added: (string) The value that this field was changed to.

\item {} 
removed: (string) The value that was previously set in this
field.

\end{itemize}
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}

Booleans changes will be represented with the strings '1' and '0'.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Groups}
\label{\detokenize{api/core/v1/group::doc}}\label{\detokenize{api/core/v1/group:groups}}
The API for creating, changing, and getting information about groups.


\subsubsection{Create Group}
\label{\detokenize{api/core/v1/group:create-group}}\label{\detokenize{api/core/v1/group:rest-group-create}}
This allows you to create a new group in Bugzilla. You must be authenticated and
be in the \sphinxstyleemphasis{creategroups} group to perform this action.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/group
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}secret\PYGZhy{}group\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Too secret for you!\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{true}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Some params must be set, or an error will be thrown. The required params are
marked in \sphinxstylestrong{bold}.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{name}
&
string
&
A short name for this group. Must be unique. This
is not usually displayed in the user interface, except
in a few places.
\\
\hline
\sphinxstylestrong{description}
&
string
&
A human-readable name for this group. Should be
relatively short. This is what will normally appear in
the UI as the name of the group.
\\
\hline
user\_regexp
&
string
&
A regular expression. Any user whose Bugzilla username
matches this regular expression will automatically be
granted membership in this group.
\\
\hline
is\_active
&
boolean
&
\sphinxcode{true} if new group can be used for bugs, \sphinxcode{false}
if this is a group that will only contain users and no
bugs will be restricted to it.
\\
\hline
icon\_url
&
string
&
A URL pointing to a small icon used to identify the
group. This icon will show up next to users' names in
various parts of Bugzilla if they are in this group.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{22}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
ID of the newly-created group.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Update Group}
\label{\detokenize{api/core/v1/group:update-group}}\label{\detokenize{api/core/v1/group:rest-group-update}}
This allows you to update a group in Bugzilla. You must be authenticated and be
in the \sphinxstyleemphasis{creategroups} group to perform this action.

\sphinxstylestrong{Request}

To update a group using the group ID or name:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
PUT /rest/group/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}secret\PYGZhy{}group\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Too secret for you! (updated description)\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{false}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

You can edit a single group by passing the ID or name of the group
in the URL. To edit more than one group, you can specify addition IDs or
group names using the \sphinxcode{ids} or \sphinxcode{names} parameters respectively.

One of the below must be specified.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id\_or\_name}
&
mixed
&
Integer group or name.
\\
\hline
\sphinxstylestrong{ids}
&
array
&
IDs of groups to update.
\\
\hline
\sphinxstylestrong{names}
&
array
&
Names of groups to update.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

The following parameters specify the new values you want to set for the group(s)
you are updating.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
A new name for the groups. If you try to set this while
updating more than one group, an error will occur, as
group names must be unique.
\\
\hline
description
&
string
&
A new description for the groups. This is what will appear
in the UI as the name of the groups.
\\
\hline
user\_regexp
&
string
&
A new regular expression for email. Will automatically
grant membership to these groups to anyone with an email
address that matches this perl regular expression.
\\
\hline
is\_active
&
boolean
&
Set if groups are active and eligible to be used for bugs.
\sphinxcode{true} if bugs can be restricted to this group, \sphinxcode{false}
otherwise.
\\
\hline
icon\_url
&
string
&
A URL pointing to an icon that will appear next to the name
of users who are in this group.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}groups\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}changes\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
        \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Too secret for you! (updated description)\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Too secret for you!\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
        \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}22\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{groups} (array) Group change objects, each containing the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the group that was updated.
\\
\hline
changes
&
object
&
The changes that were actually done on this group. The
keys are the names of the fields that were changed, and the
values are an object with two items:
\begin{itemize}
\item {} 
added: (string) The values that were added to this field,
possibly a comma-and-space-separated list if multiple values
were added.

\item {} 
removed: (string) The values that were removed from this
field, possibly a comma-and-space-separated list if multiple
values were removed.

\end{itemize}
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Get Group}
\label{\detokenize{api/core/v1/group:rest-group-get}}\label{\detokenize{api/core/v1/group:get-group}}
Returns information about Bugzilla groups.

\sphinxstylestrong{Request}

To return information about a specific group ID or name:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/group/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}

You can also return information about more than one specific group by using the
following in your query string:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/group?ids=1\PYGZam{}ids=2\PYGZam{}ids=3
GET /group?names=ProductOne\PYGZam{}names=Product2
\end{sphinxVerbatim}

If neither IDs nor names are passed, and you are in the creategroups or
editusers group, then all groups will be retrieved. Otherwise, only groups
that you have bless privileges for will be returned.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id\_or\_name
&
mixed
&
Integer group ID or name.
\\
\hline
ids
&
array
&
Integer IDs of groups.
\\
\hline
names
&
array
&
Names of groups.
\\
\hline
membership
&
boolean
&
Set to 1 then a list of members of the passed groups names
and IDs will be returned.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}groups\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}membership\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}real\PYGZus{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Bugzilla User\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}can\PYGZus{}login\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}login\PYGZus{}denied\PYGZus{}text\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{85}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}email\PYGZus{}enabled\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}email\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}\PYG{p}{,}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Test Group\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}user\PYGZus{}regexp\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}bug\PYGZus{}group\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}TestGroup\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{9}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

If the user is a member of the \sphinxstyleemphasis{creategroups} group they will receive
information about all groups or groups matching the criteria that they passed.
You have to be in the creategroups group unless you're requesting membership
information.

If the user is not a member of the \sphinxstyleemphasis{creategroups} group, but they are in the
"editusers" group or have bless privileges to the groups they require
membership information for, the is\_active, is\_bug\_group and user\_regexp values
are not supplied.

The return value will be an object containing group names as the keys; each
value will be an object that describes the group and has the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The unique integer ID that Bugzilla uses to identify this
group. Even if the name of the group changes, this ID will
stay the same.
\\
\hline
name
&
string
&
The name of the group.
\\
\hline
description
&
string
&
The description of the group.
\\
\hline
is\_bug\_group
&
int
&
Whether this group is to be used for bug reports or is
only administrative specific.
\\
\hline
user\_regexp
&
string
&
A regular expression that allows users to be added to
this group if their login matches.
\\
\hline
is\_active
&
int
&
Whether this group is currently active or not.
\\
\hline
users
&
array
&
User objects that are members of this group; only
returned if the user sets the \sphinxcode{membership} parameter to
1. Each user object has the items describe in the User
object below.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

User object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the user.
\\
\hline
real\_name
&
string
&
The actual name of the user.
\\
\hline
email
&
string
&
The email address of the user.
\\
\hline
name
&
string
&
The login name of the user. Note that in some situations
this is different than their email.
\\
\hline
can\_login
&
boolean
&
A boolean value to indicate if the user can login into
bugzilla.
\\
\hline
email\_enabled
&
boolean
&
A boolean value to indicate if bug-related mail will
be sent to the user or not.
\\
\hline
disabled\_text
&
string
&
A text field that holds the reason for disabling a user
from logging into Bugzilla. If empty, then the user
account is enabled; otherwise it is disabled/closed.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Products}
\label{\detokenize{api/core/v1/product:products}}\label{\detokenize{api/core/v1/product::doc}}
This part of the Bugzilla API allows you to list the available products and
get information about them.


\subsubsection{List Products}
\label{\detokenize{api/core/v1/product:list-products}}\label{\detokenize{api/core/v1/product:rest-product-list}}
Returns a list of the IDs of the products the user can search on.

\sphinxstylestrong{Request}

To get a list of product IDs a user can select such as for querying bugs:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/product\PYGZus{}selectable
\end{sphinxVerbatim}

To get a list of product IDs a user can enter a bug against:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/product\PYGZus{}enterable
\end{sphinxVerbatim}

To get a list of product IDs a user can search or enter bugs against.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/product\PYGZus{}accessible
\end{sphinxVerbatim}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{l+s+s2}{\PYGZdq{}2\PYGZdq{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}3\PYGZdq{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}19\PYGZdq{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
    \PYG{l+s+s2}{\PYGZdq{}4\PYGZdq{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
ids
&
array
&
List of integer product IDs.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Get Product}
\label{\detokenize{api/core/v1/product:rest-product-get}}\label{\detokenize{api/core/v1/product:get-product}}
Returns a list of information about the products passed to it.

\sphinxstylestrong{Request}

To return information about a specific type of products such as
\sphinxcode{accessible}, \sphinxcode{selectable}, or \sphinxcode{enterable}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/product?type=accessible
\end{sphinxVerbatim}

To return information about a specific product by \sphinxcode{id} or \sphinxcode{name}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/product/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}

You can also return information about more than one product by using the
following parameters in your query string:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/product?ids=1\PYGZam{}ids=2\PYGZam{}ids=3
GET /rest/product?names=ProductOne\PYGZam{}names=Product2
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id\_or\_name
&
mixed
&
Integer product ID or product name.
\\
\hline
ids
&
array
&
Product IDs
\\
\hline
names
&
array
&
Product names
\\
\hline
type
&
string
&
The group of products to return. Valid values are
\sphinxcode{accessible} (default), \sphinxcode{selectable}, and \sphinxcode{enterable}.
\sphinxcode{type} can be a single value or an array of values if more
than one group is needed with duplicates removed.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}products\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
    \PYG{p}{\PYGZob{}}
      \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{1}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}default\PYGZus{}milestone\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZhy{}\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}components\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}default\PYGZus{}assigned\PYGZus{}to\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}admin@bugzilla.org\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{1}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{0}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}TestComponent\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}flag\PYGZus{}types\PYGZdq{}}\PYG{o}{:} \PYG{p}{\PYGZob{}}
            \PYG{l+s+s2}{\PYGZdq{}bug\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
              \PYG{p}{\PYGZob{}}
                \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}grant\PYGZus{}group\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}cc\PYGZus{}list\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requestable\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{3}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}multiplicable\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}needinfo\PYGZdq{}}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}request\PYGZus{}group\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requesteeble\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{0}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}needinfo\PYGZdq{}}
              \PYG{p}{\PYGZcb{}}
            \PYG{p}{]}\PYG{p}{,}
            \PYG{l+s+s2}{\PYGZdq{}attachment\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
              \PYG{p}{\PYGZob{}}
                \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Review\PYGZdq{}}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}multiplicable\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}review\PYGZdq{}}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requesteeble\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}request\PYGZus{}group\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{0}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}cc\PYGZus{}list\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}grant\PYGZus{}group\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{null}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}requestable\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{2}\PYG{p}{,}
                \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}
              \PYG{p}{\PYGZcb{}}
            \PYG{p}{]}
          \PYG{p}{\PYGZcb{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}default\PYGZus{}qa\PYGZus{}contact\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}This is a test component.\PYGZdq{}}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}classification\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Unclassified\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}versions\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{1}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}unspecified\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{0}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}This is a test product.\PYGZdq{}}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}has\PYGZus{}unconfirmed\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}milestones\PYGZdq{}}\PYG{o}{:} \PYG{p}{[}
        \PYG{p}{\PYGZob{}}
          \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}\PYGZhy{}\PYGZhy{}\PYGZhy{}\PYGZdq{}}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}active\PYGZdq{}}\PYG{o}{:} \PYG{k+kc}{true}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}sort\PYGZus{}key\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{0}\PYG{p}{,}
          \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{1}
        \PYG{p}{\PYGZcb{}}
      \PYG{p}{]}\PYG{p}{,}
      \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}TestProduct\PYGZdq{}}
    \PYG{p}{\PYGZcb{}}
  \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{products} (array) Each product object has the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
An integer ID uniquely identifying the product in
this installation only.
\\
\hline
name
&
string
&
The name of the product. This is a unique identifier
for the product.
\\
\hline
description
&
string
&
A description of the product, which may contain HTML.
\\
\hline
is\_active
&
boolean
&
A boolean indicating if the product is active.
\\
\hline
default\_milestone
&
string
&
The name of the default milestone for the product.
\\
\hline
has\_unconfirmed
&
boolean
&
Indicates whether the UNCONFIRMED bug status is
available for this product.
\\
\hline
classification
&
string
&
The classification name for the product.
\\
\hline
components
&
array
&
Each component object has the items described in the
Component object below.
\\
\hline
versions
&
array
&
Each object describes a version, and has the
following items: \sphinxcode{name}, \sphinxcode{sort\_key} and
\sphinxcode{is\_active}.
\\
\hline
milestones
&
array
&
Each object describes a milestone, and has the
following items: \sphinxcode{name}, \sphinxcode{sort\_key} and
\sphinxcode{is\_active}.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

If the user tries to access a product that is not in the list of accessible
products for the user, or a product that does not exist, that is silently
ignored, and no information about that product is returned.

Component object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
An integer ID uniquely identifying the component in
this installation only.
\\
\hline
name
&
string
&
The name of the component.  This is a unique
identifier for this component.
\\
\hline
description
&
string
&
A description of the component, which may contain
HTML.
\\
\hline
default\_assigned\_to
&
string
&
The login name of the user to whom new bugs
will be assigned by default.
\\
\hline
default\_qa\_contact
&
string
&
The login name of the user who will be set as
the QA Contact for new bugs by default. Empty
string if the QA contact is not defined.
\\
\hline
sort\_key
&
int
&
Components, when displayed in a list, are sorted
first by this integer and then secondly by their
name.
\\
\hline
is\_active
&
boolean
&
A boolean indicating if the component is active.
Inactive components are not enabled for new bugs.
\\
\hline
flag\_types
&
object
&
An object containing two items \sphinxcode{bug} and
\sphinxcode{attachment} that each contains an array of
objects, where each describes a flagtype. The
flagtype items are described in the Flagtype
object below.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Flagtype object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
Returns the ID of the flagtype.
\\
\hline
name
&
string
&
Returns the name of the flagtype.
\\
\hline
description
&
string
&
Returns the description of the flagtype.
\\
\hline
cc\_list
&
string
&
Returns the concatenated CC list for the flagtype, as
a single string.
\\
\hline
sort\_key
&
int
&
Returns the sortkey of the flagtype.
\\
\hline
is\_active
&
boolean
&
Returns whether the flagtype is active or disabled.
Flags being in a disabled flagtype are not deleted.
It only prevents you from adding new flags to it.
\\
\hline
is\_requestable
&
boolean
&
Returns whether you can request for the given
flagtype (i.e. whether the '?' flag is available or
not).
\\
\hline
is\_requesteeble
&
boolean
&
Returns whether you can ask someone specifically
or not.
\\
\hline
is\_multiplicable
&
boolean
&
Returns whether you can have more than one
flag for the given flagtype in a given bug/attachment.
\\
\hline
grant\_group
&
int
&
the group ID that is allowed to grant/deny flags of
this type. If the item is not included all users are
allowed to grant/deny this flagtype.
\\
\hline
request\_group
&
int
&
The group ID that is allowed to request the flag if
the flag is of the type requestable. If the item is
not included all users are allowed request this
flagtype.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Create Product}
\label{\detokenize{api/core/v1/product:create-product}}\label{\detokenize{api/core/v1/product:rest-product-create}}
This allows you to create a new product in Bugzilla.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/product
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}AnotherProduct\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}description\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Another Product\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}classification\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Unclassified\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}is\PYGZus{}open\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}has\PYGZus{}unconfirmed\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{false}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}version\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}unspecified\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Some params must be set, or an error will be thrown. The required params are
marked in bold.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{name}
&
string
&
The name of this product. Must be globally unique
within Bugzilla.
\\
\hline
\sphinxstylestrong{description}
&
string
&
A description for this product. Allows some simple
HTML.
\\
\hline
\sphinxstylestrong{version}
&
string
&
The default version for this product.
\\
\hline
has\_unconfirmed
&
boolean
&
Allow the UNCONFIRMED status to be set on bugs in
this product. Default: true.
\\
\hline
classification
&
string
&
The name of the Classification which contains this
product.
\\
\hline
default\_milestone
&
string
&
The default milestone for this product. Default
'---'.
\\
\hline
is\_open
&
boolean
&
\sphinxcode{true} if the product is currently allowing bugs
to be entered into it. Default: \sphinxcode{true}.
\\
\hline
create\_series
&
boolean
&
\sphinxcode{true} if you want series for New Charts to be
created for this new product. Default: \sphinxcode{true}.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{20}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

Returns an object with the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
ID of the newly-filed product.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Update Product}
\label{\detokenize{api/core/v1/product:rest-product-update}}\label{\detokenize{api/core/v1/product:update-product}}
This allows you to update a product in Bugzilla.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
PUT /rest/product/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}

You can edit a single product by passing the ID or name of the product
in the URL. To edit more than one product, you can specify addition IDs or
product names using the \sphinxcode{ids} or \sphinxcode{names} parameters respectively.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}ids\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}\PYG{l+m+mi}{123}\PYG{p}{]}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}BarName\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}has\PYGZus{}unconfirmed\PYGZdq{}} \PYG{o}{:} \PYG{k+kc}{false}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

One of the below must be specified.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id\_or\_name}
&
mixed
&
Integer product ID or name.
\\
\hline
\sphinxstylestrong{ids}
&
array
&
Numeric IDs of the products that you wish to update.
\\
\hline
\sphinxstylestrong{names}
&
array
&
Names of the products that you wish to update.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

The following parameters specify the new values you want to set for the product(s)
you are updating.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
name
&
string
&
A new name for this product. If you try to set this
while updating more than one product, an error will
occur, as product names must be unique.
\\
\hline
default\_milestone
&
string
&
When a new bug is filed, what milestone does it
get by default if the user does not choose one? Must
represent a milestone that is valid for this product.
\\
\hline
description
&
string
&
Update the long description for these products to
this value.
\\
\hline
has\_unconfirmed
&
boolean
&
Allow the UNCONFIRMED status to be set on bugs in
products.
\\
\hline
is\_open
&
boolean
&
\sphinxcode{true} if the product is currently allowing bugs
to be entered into it, \sphinxcode{false} otherwise.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
   \PYG{l+s+s2}{\PYGZdq{}products\PYGZdq{}} \PYG{o}{:} \PYG{p}{[}
      \PYG{p}{\PYGZob{}}
         \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}} \PYG{o}{:} \PYG{l+m+mi}{123}\PYG{p}{,}
         \PYG{l+s+s2}{\PYGZdq{}changes\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
            \PYG{l+s+s2}{\PYGZdq{}name\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
               \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}FooName\PYGZdq{}}\PYG{p}{,}
               \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}BarName\PYGZdq{}}
            \PYG{p}{\PYGZcb{}}\PYG{p}{,}
            \PYG{l+s+s2}{\PYGZdq{}has\PYGZus{}unconfirmed\PYGZdq{}} \PYG{o}{:} \PYG{p}{\PYGZob{}}
               \PYG{l+s+s2}{\PYGZdq{}removed\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}1\PYGZdq{}}\PYG{p}{,}
               \PYG{l+s+s2}{\PYGZdq{}added\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}0\PYGZdq{}}
            \PYG{p}{\PYGZcb{}}
         \PYG{p}{\PYGZcb{}}
      \PYG{p}{\PYGZcb{}}
   \PYG{p}{]}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}

\sphinxcode{products} (array) Product change objects containing the following items:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the product that was updated.
\\
\hline
changes
&
object
&
The changes that were actually done on this product. The
keys are the names of the fields that were changed, and the
values are an object with two items:
\begin{itemize}
\item {} 
added: (string) The value that this field was changed to.

\item {} 
removed: (string) The value that was previously set in this
field.

\end{itemize}
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}

Booleans will be represented with the strings '1' and '0' for changed values
as they are stored as strings in the database currently.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\subsection{Users}
\label{\detokenize{api/core/v1/user::doc}}\label{\detokenize{api/core/v1/user:users}}
This part of the Bugzilla API allows you to create user accounts, get information
about user accounts and to log in or out using an existing account.


\subsubsection{Login}
\label{\detokenize{api/core/v1/user:login}}\label{\detokenize{api/core/v1/user:rest-user-login}}
Logging in with a username and password is required for many Bugzilla
installations, in order to search for private bugs, post new bugs, etc. This
method allows you to retrieve a token that can be used as authentication for
subsequent API calls. Otherwise yuou will need to pass your \sphinxcode{login} and
\sphinxcode{password} with each call.

This method will be going away in the future in favor of using \sphinxstyleemphasis{API keys}.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/login?login=foo@example.com\PYGZam{}password=toosecrettoshow
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{login}
&
string
&
The user's login name.
\\
\hline
\sphinxstylestrong{password}
&
string
&
The user's password.
\\
\hline
restrict\_login
&
boolean
&
If set to a true value, the token returned by this
method will only be valid from the IP address which
called this method.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}token\PYGZdq{}}\PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}786\PYGZhy{}OLaWfBisMY\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{786}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
Numeric ID of the user that was logged in.
\\
\hline
token
&
string
&
Token which can be passed in the parameters as
authentication in other calls. The token can be sent along
with any future requests to the webservice, for the duration
of the session, i.e. til {\hyperref[\detokenize{api/core/v1/user:rest-user-logout}]{\sphinxcrossref{\DUrole{std,std-ref}{Logout}}}} is called.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Logout}
\label{\detokenize{api/core/v1/user:logout}}\label{\detokenize{api/core/v1/user:rest-user-logout}}
Log out the user. Basically it invalidates the token provided so it cannot be
re-used. Does nothing if the token is not in use. Will also clear any existing
authentication cookies the client may still have stored.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/logout?token=1234\PYGZhy{}VWvO51X69r
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
token
&
string
&
The user's token used for authentication.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Valid Login}
\label{\detokenize{api/core/v1/user:rest-user-valid-login}}\label{\detokenize{api/core/v1/user:valid-login}}
This method will verify whether a client's cookies or current login token is
still valid or have expired. A valid username that matches must be provided as
well.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/valid\PYGZus{}login?login=foo@example.com\PYGZam{}token=1234\PYGZhy{}VWvO51X69r
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{login}
&
string
&
The login name that matches the provided cookies or token.
\\
\hline
token
&
string
&
Persistent login token currently being used for
authentication.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

Returns true/false depending on if the current token is valid for the provided
username.


\subsubsection{Create User}
\label{\detokenize{api/core/v1/user:create-user}}\label{\detokenize{api/core/v1/user:rest-user-create}}
Creates a user account directly in Bugzilla, password and all. Instead of this,
you should use \sphinxstylestrong{Offer Account by Email} when possible because that makes sure
that the email address specified can actually receive an email. This function
does not check that. You must be authenticated and be in the \sphinxstyleemphasis{editusers} group
to perform this action.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
POST /rest/user
\end{sphinxVerbatim}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}email\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}user@bugzilla.org\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}full\PYGZus{}name\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}Test User\PYGZdq{}}\PYG{p}{,}
  \PYG{l+s+s2}{\PYGZdq{}password\PYGZdq{}} \PYG{o}{:} \PYG{l+s+s2}{\PYGZdq{}K16ldRr922I1\PYGZdq{}}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{email}
&
string
&
The email address for the new user.
\\
\hline
full\_name
&
string
&
The user's full name. Will be set to empty if not specified.
\\
\hline
password
&
string
&
The password for the new user account, in plain text. It
will be stripped of leading and trailing whitespace. If
blank or not specified, the new created account will
exist in Bugzilla but will not be allowed to log in
using DB authentication until a password is set either
by the user (through resetting their password) or by the
administrator.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{\PYGZob{}}
  \PYG{l+s+s2}{\PYGZdq{}id\PYGZdq{}}\PYG{o}{:} \PYG{l+m+mi}{58707}
\PYG{p}{\PYGZcb{}}
\end{sphinxVerbatim}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
desciption
\unskip}\relax \\
\hline
id
&
int
&
The numeric ID of the user that was created.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Update User}
\label{\detokenize{api/core/v1/user:rest-user-update}}\label{\detokenize{api/core/v1/user:update-user}}
Updates an existing user account in Bugzilla. You must be authenticated and be
in the \sphinxstyleemphasis{editusers} group to perform this action.

\sphinxstylestrong{Request}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
PUT /rest/user/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}

You can edit a single user by passing the ID or login name of the user
in the URL. To edit more than one user, you can specify addition IDs or
login names using the \sphinxcode{ids} or \sphinxcode{names} parameters respectively.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
\sphinxstylestrong{id\_or\_name}
&
mixed
&
Either the ID or the login name of the user to
update.
\\
\hline
\sphinxstylestrong{ids}
&
array
&
Additional IDs of users to update.
\\
\hline
\sphinxstylestrong{names}
&
array
&
Additional login names of users to update.
\\
\hline
full\_name
&
string
&
The new name of the user.
\\
\hline
email
&
string
&
The email of the user. Note that email used to
login to bugzilla. Also note that you can only
update one user at a time when changing the login
name / email. (An error will be thrown if you try to
update this field for multiple users at once.)
\\
\hline
password
&
string
&
The password of the user.
\\
\hline
email\_enabled
&
boolean
&
A boolean value to enable/disable sending
bug-related mail to the user.
\\
\hline
login\_denied\_text
&
string
&
A text field that holds the reason for disabling a
user from logging into Bugzilla. If empty, then the
user account is enabled; otherwise it is
disabled/closed.
\\
\hline
groups
&
object
&
These specify the groups that this user is directly
a member of. To set these, you should pass an object
as the value. The object's items are described in
the Groups update objects below.
\\
\hline
bless\_groups
&
object
&
This is the same as groups but affects what groups
a user has direct membership to bless that group.
It takes the same inputs as groups.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Groups and bless groups update object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
add
&
array
&
The group IDs or group names that the user should be added to.
\\
\hline
remove
&
array
&
The group IDs or group names that the user should be removed from.
\\
\hline
set
&
array
&
Integers or strings which are an exact set of group IDs and group
names that the user should be a member of. This does not remove
groups from the user when the person making the change does not
have the bless privilege for the group.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

If you specify \sphinxcode{set}, then \sphinxcode{add} and \sphinxcode{remove} will be ignored. A group in
both the \sphinxcode{add} and \sphinxcode{remove} list will be added. Specifying a group that the
user making the change does not have bless rights will generate an error.

\sphinxstylestrong{Response}
\begin{itemize}
\item {} 
users: (array) List of user change objects with the following items:

\end{itemize}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The ID of the user that was updated.
\\
\hline
changes
&
object
&
The changes that were actually done on this user. The keys
are the names of the fields that were changed, and the values
are an object with two items:
\begin{itemize}
\item {} 
added: (string) The values that were added to this field,
possibly a comma-and-space-separated list if multiple values
were added.

\item {} 
removed: (string) The values that were removed from this
field, possibly a comma-and-space-separated list if multiple
values were removed.

\end{itemize}
\\
\hline
\end{tabular}
\par
\sphinxattableend\end{savenotes}


\subsubsection{Get User}
\label{\detokenize{api/core/v1/user:get-user}}\label{\detokenize{api/core/v1/user:rest-user-get}}
Gets information about user accounts in Bugzilla.

\sphinxstylestrong{Request}

To get information about a single user in Bugzilla:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/user/(id\PYGZus{}or\PYGZus{}name)
\end{sphinxVerbatim}

To get multiple users by name or ID:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/user?names=foo@bar.com\PYGZam{}name=test@bugzilla.org
GET /rest/user?ids=123\PYGZam{}ids=321
\end{sphinxVerbatim}

To get user matching a search string:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
GET /rest/user?match=foo
\end{sphinxVerbatim}

To get user by using an integer ID value or by using \sphinxcode{match}, you must be
authenticated.


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id\_or\_name
&
mixed
&
An integer user ID or login name of the user.
\\
\hline
ids
&
array
&
Integer user IDs. Logged=out users cannot pass
this parameter to this function. If they try,
they will get an error. Logged=in users will get
an error if they specify the ID of a user they
cannot see.
\\
\hline
names
&
array
&
Login names.
\\
\hline
match
&
array
&This works just like "user matching" in Bugzilla
itself. Users will be returned whose real name
or login name contains any one of the specified
strings. Users that you cannot see will not be
included in the returned list.

Most installations have a limit on how many
matches are returned for each string; the default
is 1000 but can be changed by the Bugzilla
administrator.

Logged-out users cannot use this argument, and
an error will be thrown if they try. (This is to
make it harder for spammers to harvest email
addresses from Bugzilla, and also to enforce the
user visibility restrictions that are
implemented on some Bugzillas.)
\\
\hline
limit
&
int
&
Limit the number of users matched by the
\sphinxcode{match} parameter. If the value is greater than the
system limit, the system limit will be used.
This parameter is only valid when using the \sphinxcode{match}
parameter.
\\
\hline
group\_ids
&
array
&
Numeric IDs for groups that a user can be in.
\\
\hline
groups
&
array
&
Names of groups that a user can be in. If
\sphinxcode{group\_ids} or \sphinxcode{groups} are specified, they
limit the return value to users who are in \sphinxstyleemphasis{any}
of the groups specified.
\\
\hline
include\_disabled
&
boolean
&
By default, when using the \sphinxcode{match} parameter,
disabled users are excluded from the returned
results unless their full username is identical
to the match string. Setting \sphinxcode{include\_disabled} to
\sphinxcode{true} will include disabled users in the returned
results even if their username doesn't fully match
the input string.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

\sphinxstylestrong{Response}
\begin{itemize}
\item {} 
users: (array) Each object describes a user and has the following items:

\end{itemize}


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The unique integer ID that Bugzilla uses to represent
this user. Even if the user's login name changes,
this will not change.
\\
\hline
real\_name
&
string
&
The actual name of the user. May be blank.
\\
\hline
email
&
string
&
The email address of the user.
\\
\hline
name
&
string
&
The login name of the user. Note that in some
situations this is different than their email.
\\
\hline
can\_login
&
boolean
&
A boolean value to indicate if the user can login
into bugzilla.
\\
\hline
email\_enabled
&
boolean
&
A boolean value to indicate if bug-related mail will
be sent to the user or not.
\\
\hline
login\_denied\_text
&
string
&
A text field that holds the reason for disabling a
user from logging into Bugzilla. If empty then the
user account is enabled; otherwise it is
disabled/closed.
\\
\hline
groups
&
array
&
Groups the user is a member of. If the currently
logged in user is querying their own account or is a
member of the 'editusers' group, the array will
contain all the groups that the user is a member of.
Otherwise, the array will only contain groups that
the logged in user can bless. Each object describes
the group and contains the items described in the
Group object below.
\\
\hline
saved\_searches
&
array
&
User's saved searches, each having the following
Search object items described below.
\\
\hline
saved\_reports
&
array
&
User's saved reports, each having the following
Search object items described below.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Group object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
The group ID
\\
\hline
name
&
string
&
The name of the group
\\
\hline
description
&
string
&
The description for the group
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

Search object:


\begin{savenotes}\sphinxattablestart
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxstylethead{\sphinxstyletheadfamily 
name
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
type
\unskip}\relax &\sphinxstylethead{\sphinxstyletheadfamily 
description
\unskip}\relax \\
\hline
id
&
int
&
An integer ID uniquely identifying the saved report.
\\
\hline
name
&
string
&
The name of the saved report.
\\
\hline
query
&
string
&
The CGI parameters for the saved report.
\\
\hline
\end{tabulary}
\par
\sphinxattableend\end{savenotes}

If you are not authenticated when you call this function, you will only be
returned the \sphinxcode{id}, \sphinxcode{name}, and \sphinxcode{real\_name} items. If you are authenticated
and not in 'editusers' group, you will only be returned the \sphinxcode{id}, \sphinxcode{name},
\sphinxcode{real\_name}, \sphinxcode{email}, \sphinxcode{can\_login}, and \sphinxcode{groups} items. The groups
returned are filtered based on your permission to bless each group. The
\sphinxcode{saved\_searches} and \sphinxcode{saved\_reports} items are only returned if you are
querying your own account, even if you are in the editusers group.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{MySQL}
\label{\detokenize{installing/mysql:id1}}\label{\detokenize{installing/mysql::doc}}\label{\detokenize{installing/mysql:mysql}}
You need MySQL version 5.0.15 or higher.

It's possible to test which version of MySQL you have installed with:

\sphinxstyleliteralstrong{mysql -V}


\section{Installing}
\label{\detokenize{installing/mysql:installing}}

\subsection{Windows}
\label{\detokenize{installing/mysql:windows}}
Download the MySQL 32-bit or 64-bit MSI installer from the
\sphinxhref{http://www.mysql.com/downloads/mysql/}{MySQL website} (\textasciitilde{}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 \sphinxcode{C:\textbackslash{}mysql}. Adjust paths appropriately if not.


\subsection{Linux/Mac OS X}
\label{\detokenize{installing/mysql: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:

\sphinxstyleliteralstrong{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.


\section{Add a User}
\label{\detokenize{installing/mysql:mysql-add-user}}\label{\detokenize{installing/mysql:add-a-user}}
You need to add a new MySQL user for Bugzilla to use. Run the \sphinxcode{mysql}
command-line client and enter:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{GRANT} \PYG{n}{SELECT}\PYG{p}{,} \PYG{n}{INSERT}\PYG{p}{,}
\PYG{n}{UPDATE}\PYG{p}{,} \PYG{n}{DELETE}\PYG{p}{,} \PYG{n}{INDEX}\PYG{p}{,} \PYG{n}{ALTER}\PYG{p}{,} \PYG{n}{CREATE}\PYG{p}{,} \PYG{n}{LOCK} \PYG{n}{TABLES}\PYG{p}{,}
\PYG{n}{CREATE} \PYG{n}{TEMPORARY} \PYG{n}{TABLES}\PYG{p}{,} \PYG{n}{DROP}\PYG{p}{,} \PYG{n}{REFERENCES} \PYG{n}{ON} \PYG{n}{bugs}\PYG{o}{.}\PYG{o}{*}
\PYG{n}{TO} \PYG{n}{bugs}\PYG{n+nd}{@localhost} \PYG{n}{IDENTIFIED} \PYG{n}{BY} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{\PYGZdl{}DB\PYGZus{}PASS}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{;}

\PYG{n}{FLUSH} \PYG{n}{PRIVILEGES}\PYG{p}{;}
\end{sphinxVerbatim}

You need to replace \sphinxcode{\$DB\_PASS} with a strong password you have chosen.
Write that password down somewhere.

The above command permits an account called \sphinxcode{bugs}
to connect from the local machine, \sphinxcode{localhost}. Modify the command to
reflect your setup if you will be connecting from another
machine or as a different user.


\section{Change Configuration}
\label{\detokenize{installing/mysql:change-configuration}}
To change MySQL's configuration, you need to edit your MySQL
configuration file, which is:
\begin{itemize}
\item {} 
Red Hat/Fedora: \sphinxcode{/etc/my.cnf}

\item {} 
Debian/Ubuntu: \sphinxcode{/etc/mysql/my.cnf}

\item {} 
Windows: \sphinxcode{C:\textbackslash{}mysql\textbackslash{}bin\textbackslash{}my.ini}

\item {} 
Mac OS X: \sphinxcode{/etc/my/cnf}

\end{itemize}


\subsection{Allow Large Attachments and Many Comments}
\label{\detokenize{installing/mysql:mysql-max-allowed-packet}}\label{\detokenize{installing/mysql: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 \sphinxcode{max\_allowed\_packet} parameter in your MySQL
configuration in the \sphinxcode{{[}mysqld{]}} section, so that the number is at least
16M, like this (note that it's \sphinxcode{M}, not \sphinxcode{MB}):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}\PYG{n}{mysqld}\PYG{p}{]}
\PYG{c+c1}{\PYGZsh{} Allow packets up to 16M}
\PYG{n}{max\PYGZus{}allowed\PYGZus{}packet}\PYG{o}{=}\PYG{l+m+mi}{16}\PYG{n}{M}
\end{sphinxVerbatim}


\subsection{Allow Small Words in Full-Text Indexes}
\label{\detokenize{installing/mysql:mysql-small-words}}\label{\detokenize{installing/mysql: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
\sphinxcode{ft\_min\_word\_len} param to the minimum size of the words to index.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{p}{[}\PYG{n}{mysqld}\PYG{p}{]}
\PYG{c+c1}{\PYGZsh{} Allow small words in full\PYGZhy{}text indexes}
\PYG{n}{ft\PYGZus{}min\PYGZus{}word\PYGZus{}len}\PYG{o}{=}\PYG{l+m+mi}{2}
\end{sphinxVerbatim}


\section{Permit Attachments Table to Grow Beyond 4GB}
\label{\detokenize{installing/mysql:mysql-attach-table-size}}\label{\detokenize{installing/mysql: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 \sphinxcode{mysql}
command-line client and enter the following, replacing \sphinxcode{\$bugs\_db}
with your Bugzilla database name (which is \sphinxcode{bugs} by default):

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
USE \PYGZdl{}bugs\PYGZus{}db;

ALTER TABLE attachments AVG\PYGZus{}ROW\PYGZus{}LENGTH=1000000, MAX\PYGZus{}ROWS=20000;
\end{sphinxVerbatim}

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.

\begin{sphinxadmonition}{note}{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.
\end{sphinxadmonition}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{PostgreSQL}
\label{\detokenize{installing/postgresql:postgresql}}\label{\detokenize{installing/postgresql::doc}}\label{\detokenize{installing/postgresql:id1}}
Test which version of PostgreSQL you have installed with:

\sphinxstyleliteralstrong{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.


\section{Add a User}
\label{\detokenize{installing/postgresql:posgresql-add-user}}\label{\detokenize{installing/postgresql: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 \sphinxcode{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:

\sphinxstyleliteralstrong{su - postgres}

As the postgres user, you then need to create a new user:

\sphinxstyleliteralstrong{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).


\section{Permit Access}
\label{\detokenize{installing/postgresql:postgresql-access}}\label{\detokenize{installing/postgresql:permit-access}}
Edit the file \sphinxcode{pg\_hba.conf} which is
usually located in \sphinxcode{/var/lib/pgsql/data/}. In this file,
you will need to add a new line to it as follows:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{host}   \PYG{n+nb}{all}    \PYG{n}{bugs}   \PYG{l+m+mf}{127.0}\PYG{o}{.}\PYG{l+m+mf}{0.1}    \PYG{l+m+mf}{255.255}\PYG{o}{.}\PYG{l+m+mf}{255.255}  \PYG{n}{md5}
\end{sphinxVerbatim}

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
\sphinxcode{postgresql.conf}.)


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{Oracle}
\label{\detokenize{installing/oracle:oracle}}\label{\detokenize{installing/oracle::doc}}\label{\detokenize{installing/oracle:id1}}
\begin{sphinxadmonition}{warning}{Warning:}
Bugzilla supports Oracle, but none of the current developers run
it. Your mileage may vary.
\end{sphinxadmonition}

You need Oracle version 10.02.0 or later.


\section{Create a New Tablespace}
\label{\detokenize{installing/oracle:oracle-tablespace}}\label{\detokenize{installing/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:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{CREATE} \PYG{n}{TABLESPACE} \PYG{n}{bugs}
\PYG{n}{DATAFILE} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{*\PYGZdl{}path\PYGZus{}to\PYGZus{}datafile*}\PYG{l+s+s1}{\PYGZsq{}} \PYG{n}{SIZE} \PYG{l+m+mi}{500}\PYG{n}{M}
\PYG{n}{AUTOEXTEND} \PYG{n}{ON} \PYG{n}{NEXT} \PYG{l+m+mi}{30}\PYG{n}{M} \PYG{n}{MAXSIZE} \PYG{n}{UNLIMITED}
\end{sphinxVerbatim}

Here, the name of the tablespace is 'bugs', but you can
choose another name. \sphinxstyleemphasis{\$path\_to\_datafile} is
the path to the file containing your database, for instance
\sphinxcode{/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.


\section{Add a User to Oracle}
\label{\detokenize{installing/oracle:add-a-user-to-oracle}}\label{\detokenize{installing/oracle:oracle-add-user}}
The user name and password must match what you set in \sphinxcode{localconfig}
(\sphinxcode{\$db\_user} and \sphinxcode{\$db\_pass}, respectively). Here, we assume that
the user name is 'bugs' and the tablespace name is the same
as above.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{CREATE} \PYG{n}{USER} \PYG{n}{bugs}
\PYG{n}{IDENTIFIED} \PYG{n}{BY} \PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{\PYGZdl{}db\PYGZus{}pass}\PYG{l+s+s2}{\PYGZdq{}}
\PYG{n}{DEFAULT} \PYG{n}{TABLESPACE} \PYG{n}{bugs}
\PYG{n}{TEMPORARY} \PYG{n}{TABLESPACE} \PYG{n}{TEMP}
\PYG{n}{PROFILE} \PYG{n}{DEFAULT}\PYG{p}{;}
\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}} \PYG{n}{GRANT}\PYG{o}{/}\PYG{n}{REVOKE} \PYG{n}{ROLE} \PYG{n}{PRIVILEGES}
\PYG{n}{GRANT} \PYG{n}{CONNECT} \PYG{n}{TO} \PYG{n}{bugs}\PYG{p}{;}
\PYG{n}{GRANT} \PYG{n}{RESOURCE} \PYG{n}{TO} \PYG{n}{bugs}\PYG{p}{;}
\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}} \PYG{n}{GRANT}\PYG{o}{/}\PYG{n}{REVOKE} \PYG{n}{SYSTEM} \PYG{n}{PRIVILEGES}
\PYG{n}{GRANT} \PYG{n}{UNLIMITED} \PYG{n}{TABLESPACE} \PYG{n}{TO} \PYG{n}{bugs}\PYG{p}{;}
\PYG{n}{GRANT} \PYG{n}{EXECUTE} \PYG{n}{ON} \PYG{n}{CTXSYS}\PYG{o}{.}\PYG{n}{CTX\PYGZus{}DDL} \PYG{n}{TO} \PYG{n}{bugs}\PYG{p}{;}
\end{sphinxVerbatim}


\section{Configure the Web Server}
\label{\detokenize{installing/oracle:configure-the-web-server}}\label{\detokenize{installing/oracle:oracle-webserver}}
If you use Apache, append these lines to \sphinxcode{httpd.conf}
to set ORACLE\_HOME and LD\_LIBRARY\_PATH. For instance:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nb}{SetEnv} ORACLE\PYGZus{}HOME \PYG{l+s+sx}{/u01/app/oracle/product/10.2.0/}
\PYG{n+nb}{SetEnv} LD\PYGZus{}LIBRARY\PYGZus{}PATH \PYG{l+s+sx}{/u01/app/oracle/product/10.2.0/lib/}
\end{sphinxVerbatim}

When this is done, restart your web server.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{SQLite}
\label{\detokenize{installing/sqlite:sqlite}}\label{\detokenize{installing/sqlite::doc}}\label{\detokenize{installing/sqlite:id1}}
\begin{sphinxadmonition}{warning}{Warning:}
Due to SQLite's \sphinxhref{http://sqlite.org/faq.html\#q5}{concurrency
limitations} we recommend SQLite only for
small and development Bugzilla installations.
\end{sphinxadmonition}

Once you have SQLite installed, no additional configuration is required to
run Bugzilla.

The database will be stored in \sphinxcode{\$BUGZILLA\_HOME/data/db/\$db\_name}, where
\sphinxcode{\$db\_name} is the database name defined in \sphinxcode{localconfig}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{Apache}
\label{\detokenize{installing/apache:apache}}\label{\detokenize{installing/apache::doc}}\label{\detokenize{installing/apache:id1}}
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:
\begin{itemize}
\item {} 
Fedora/Red Hat: \sphinxcode{/etc/httpd/conf/httpd.conf}

\item {} 
Debian/Ubuntu: \sphinxcode{/etc/apache2/apache2.conf}

\item {} 
Mac OS X: \sphinxcode{/etc/apache2/httpd.conf}

\end{itemize}

Alternatively, on Debian or Ubuntu, you can instead put the below code into a
separate file in the directory \sphinxcode{/etc/apache2/sites-enabled/}.

In these instructions, when asked to restart Apache, the command is:

\sphinxstyleliteralstrong{sudo apachectl start}

(or run it as root if your OS installation does not use sudo).


\section{Securing Apache}
\label{\detokenize{installing/apache: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.
\begin{enumerate}
\item {} 
Edit the Apache configuration file (see above).

\item {} 
Find the following line in the above mentioned file, which defines the
logging format for \sphinxcode{vhost\_combined}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nb}{LogFormat} \PYG{l+s+s2}{\PYGZdq{}\PYGZpc{}v:\PYGZpc{}p \PYGZpc{}h \PYGZpc{}l \PYGZpc{}u \PYGZpc{}t \PYGZbs{}\PYGZdq{}\PYGZpc{}r\PYGZbs{}\PYGZdq{} \PYGZpc{}\PYGZgt{}s \PYGZpc{}O \PYGZbs{}\PYGZdq{}\PYGZpc{}\PYGZob{}Referer\PYGZcb{}i\PYGZbs{}\PYGZdq{} \PYGZbs{}\PYGZdq{}\PYGZpc{}\PYGZob{}User\PYGZhy{}Agent\PYGZcb{}i\PYGZbs{}\PYGZdq{}\PYGZdq{}} vhost\PYGZus{}combined
\end{sphinxVerbatim}

\item {} 
Replace \sphinxcode{\%r} with \sphinxcode{\%m \%U}.

\item {} 
Restart Apache.

\end{enumerate}


\section{Apache with mod\_cgi}
\label{\detokenize{installing/apache:apache-with-mod-cgi}}\label{\detokenize{installing/apache:apache-mod-cgi}}
To configure your Apache web server to work with Bugzilla while using
mod\_cgi, do the following:
\begin{enumerate}
\item {} 
Edit the Apache configuration file (see above).

\item {} 
Create a \sphinxcode{\textless{}Directory\textgreater{}} directive that applies to the location
of your Bugzilla installation. In this example, Bugzilla has
been installed at \sphinxcode{/var/www/html/bugzilla}. On Mac OS X, use
\sphinxcode{/Library/WebServer/Documents/bugzilla}.

\end{enumerate}

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nt}{\PYGZlt{}Directory} \PYG{l+s}{/var/www/html/bugzilla}\PYG{n+nt}{\PYGZgt{}}
  \PYG{n+nb}{AddHandler} cgi\PYGZhy{}script .cgi
  \PYG{n+nb}{Options} +ExecCGI +FollowSymLinks
  \PYG{n+nb}{DirectoryIndex} index.cgi index.html
  \PYG{n+nb}{AllowOverride} Limit FileInfo Indexes Options
\PYG{n+nt}{\PYGZlt{}/Directory}\PYG{n+nt}{\PYGZgt{}}
\end{sphinxVerbatim}

These instructions allow Apache to run .cgi files found within the Bugzilla
directory; instructs the server to look for a file called \sphinxcode{index.cgi}
or, if not found, \sphinxcode{index.html} if someone only types the directory name
into the browser; and allows Bugzilla's \sphinxcode{.htaccess} files to override
some global permissions.


\section{Apache with mod\_perl}
\label{\detokenize{installing/apache:apache-mod-perl}}\label{\detokenize{installing/apache:apache-with-mod-perl}}
Some configuration is required to make Bugzilla work with Apache
and mod\_perl.

\begin{sphinxadmonition}{note}{Note:}
It is not known whether anyone has even tried mod\_perl on Mac OS X.
\end{sphinxadmonition}
\begin{enumerate}
\item {} 
Edit the Apache configuration file (see above).

\item {} 
Add the following information, substituting where appropriate with your
own local paths.

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nb}{PerlSwitches} \PYGZhy{}w \PYGZhy{}T
\PYG{n+nb}{PerlConfigRequire} \PYG{l+s+sx}{/var/www/html/bugzilla/mod\PYGZus{}perl.pl}
\end{sphinxVerbatim}

\begin{sphinxadmonition}{note}{Note:}
This should be used instead of the \textless{}Directory\textgreater{} block
shown above. This should also be above any other \sphinxcode{mod\_perl}
directives within the \sphinxcode{httpd.conf} and the directives must be
specified in the order above.
\end{sphinxadmonition}

\begin{sphinxadmonition}{warning}{Warning:}
You should also ensure that you have disabled \sphinxcode{KeepAlive}
support in your Apache install when utilizing Bugzilla under mod\_perl
or you may suffer a
\sphinxhref{http://modperlbook.org/html/11-4-KeepAlive.html}{performance penalty}.
\end{sphinxadmonition}

\end{enumerate}

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:
\begin{itemize}
\item {} 
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.

\item {} 
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
\sphinxstyleemphasis{restart} the server (as in make sure it stops and starts
again). You \sphinxstyleemphasis{can} change \sphinxcode{localconfig} and the \sphinxcode{params} file
manually, if you want, because those are re-read every time you load a page.

\item {} 
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 \sphinxstyleemphasis{won't} work.)

\item {} 
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.

\item {} 
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.

\end{itemize}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{Apache}
\label{\detokenize{installing/apache-windows:apache-windows}}\label{\detokenize{installing/apache-windows:apache}}\label{\detokenize{installing/apache-windows::doc}}
These instructions require editing the Apache configuration file, which is
at \sphinxcode{C:\textbackslash{}Program Files\textbackslash{}Apache Group\textbackslash{}Apache2\textbackslash{}conf\textbackslash{}httpd.conf}.


\section{Installing}
\label{\detokenize{installing/apache-windows:installing}}
Download the Apache HTTP Server, version 2.2.x or higher, from
\sphinxhref{http://httpd.apache.org/download.cgi}{the Apache website}.

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 \sphinxcode{Apache2} directory under what ever path you specify. The
default install path will be displayed as
\sphinxcode{C:\textbackslash{}Program Files\textbackslash{}Apache Group}, which will result in Apache being
installed to \sphinxcode{C:\textbackslash{}Program Files\textbackslash{}Apache Group\textbackslash{}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, \sphinxcode{C:\textbackslash{}Program Files\textbackslash{}Apache Group\textbackslash{}Apache2}.


\section{Apache Account Permissions}
\label{\detokenize{installing/apache-windows: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 \sphinxstylestrong{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.
\begin{itemize}
\item {} 
\sphinxcode{C:\textbackslash{}Bugzilla\textbackslash{}data}

\item {} 
\sphinxcode{C:\textbackslash{}Program Files\textbackslash{}Apache Group\textbackslash{}Apache2\textbackslash{}logs}

\item {} 
\sphinxcode{C:\textbackslash{}Temp}

\item {} 
\sphinxcode{C:\textbackslash{}Windows\textbackslash{}Temp}

\end{itemize}

Note that \sphinxcode{C:\textbackslash{}Bugzilla\textbackslash{}data} is created the first time you run
\sphinxcode{checksetup.pl}.


\section{Port and DocumentRoot}
\label{\detokenize{installing/apache-windows: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 \sphinxcode{Listen} option and change the value after the colon.

Change the \sphinxcode{DocumentRoot} setting to point to \sphinxcode{C:/Bugzilla}. There
are two locations in \sphinxcode{httpd.conf} that need to be updated (search for
\sphinxcode{DocumentRoot}). You need to use \sphinxcode{/} instead of \sphinxcode{\textbackslash{}} as a path separator.


\section{Enable CGI Support}
\label{\detokenize{installing/apache-windows: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 \sphinxcode{AddHandler cgi-script .cgi} line.


\section{Teach Apache About Bugzilla}
\label{\detokenize{installing/apache-windows:teach-apache-about-bugzilla}}
Edit the Apache configuration file (see above).

Add the following stanza:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nt}{\PYGZlt{}Directory} \PYG{l+s}{\PYGZdq{}C:/Bugzilla\PYGZdq{}}\PYG{n+nt}{\PYGZgt{}}
    \PYG{n+nb}{ScriptInterpreterSource} \PYG{k}{Registry}\PYGZhy{}Strict
    \PYG{n+nb}{Options} +ExecCGI +FollowSymLinks
    \PYG{n+nb}{DirectoryIndex} index.cgi index.html
    \PYG{n+nb}{AllowOverride} Limit FileInfo Indexes Options
\PYG{n+nt}{\PYGZlt{}/Directory}\PYG{n+nt}{\PYGZgt{}}
\end{sphinxVerbatim}

In order for \sphinxcode{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 \sphinxcode{HKEY\_CLASSES\_ROOT\textbackslash{}.cgi\textbackslash{}Shell\textbackslash{}ExecCGI\textbackslash{}Command} with the
default value of the full path of \sphinxcode{perl.exe} with a \sphinxcode{-T} parameter.
For example \sphinxcode{C:\textbackslash{}Perl\textbackslash{}bin\textbackslash{}perl.exe -T}.


\section{Logging}
\label{\detokenize{installing/apache-windows: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
\sphinxcode{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.
\begin{enumerate}
\item {} 
Find the following line in the Apache config file, which defines the
logging format for \sphinxcode{vhost\_combined}:

\fvset{hllines={, ,}}%
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nb}{LogFormat} \PYG{l+s+s2}{\PYGZdq{}\PYGZpc{}v:\PYGZpc{}p \PYGZpc{}h \PYGZpc{}l \PYGZpc{}u \PYGZpc{}t \PYGZbs{}\PYGZdq{}\PYGZpc{}r\PYGZbs{}\PYGZdq{} \PYGZpc{}\PYGZgt{}s \PYGZpc{}O \PYGZbs{}\PYGZdq{}\PYGZpc{}\PYGZob{}Referer\PYGZcb{}i\PYGZbs{}\PYGZdq{} \PYGZbs{}\PYGZdq{}\PYGZpc{}\PYGZob{}User\PYGZhy{}Agent\PYGZcb{}i\PYGZbs{}\PYGZdq{}\PYGZdq{}} vhost\PYGZus{}combined
\end{sphinxVerbatim}

\item {} 
Replace \sphinxcode{\%r} with \sphinxcode{\%m \%U}.

\end{enumerate}

(If you have configured Apache differently, a different log line might apply.
Adjust these instructions accordingly.)


\section{Restart Apache}
\label{\detokenize{installing/apache-windows:restart-apache}}
Finally, restart Apache to get it pick up the changes:

\sphinxstyleliteralstrong{net stop apache2}

\sphinxstyleliteralstrong{net start apache2}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\chapter{Microsoft IIS}
\label{\detokenize{installing/iis:microsoft-iis}}\label{\detokenize{installing/iis::doc}}\label{\detokenize{installing/iis:iis}}
Bugzilla works with IIS as a normal CGI application. These instructions assume
that you are using Windows 7. Procedures for other versions are probably similar.

Begin by starting Internet Information Services (IIS) Manager.
\sphinxmenuselection{Start} --\textgreater{} \sphinxmenuselection{Administrators Tools} --\textgreater{}
\sphinxmenuselection{Internet Information Services (IIS) Manager}. Or run the command:

\sphinxstyleliteralstrong{inetmgr}


\section{Create a New Application}
\label{\detokenize{installing/iis:create-a-new-application}}
Expand your \sphinxmenuselection{Server} until the \sphinxmenuselection{Default Web Site} shows
its children.

Right-click \sphinxmenuselection{Default Web Site} and select
\sphinxmenuselection{Add Application} from the menu.

Unde \sphinxmenuselection{Alias}, enter the alias for the website. This is the path
below the domain where you want Bugzilla to appear.

Under \sphinxmenuselection{Physical Path}, enter the path to Bugzilla,
\sphinxcode{C:\textbackslash{}Bugzilla}.

When finished, click \sphinxmenuselection{OK}.


\section{Configure the Default Document}
\label{\detokenize{installing/iis:configure-the-default-document}}
Click on the Application that you just created. Double-click on
\sphinxmenuselection{Default Document}, and click \sphinxmenuselection{Add} underneath the
Actions menu.

Under \sphinxmenuselection{Name}, enter \sphinxcode{index.cgi}.

All other default documents can be removed for this application.

\begin{sphinxadmonition}{warning}{Warning:}
Do not delete the default document from the \sphinxmenuselection{Default Website}.
\end{sphinxadmonition}


\section{Add Handler Mappings}
\label{\detokenize{installing/iis:add-handler-mappings}}
Ensure that you are at the Default Website. Under \sphinxmenuselection{IIS},
double-click \sphinxmenuselection{Handler Mappings}. Under \sphinxmenuselection{Actions}, click
\sphinxmenuselection{Add Script Map}. You need to do this twice.

For the first one, set the following values (replacing paths if necessary):
\begin{itemize}
\item {} 
\sphinxmenuselection{Request Path}: \sphinxcode{*.pl}

\item {} 
\sphinxmenuselection{Executable}: \sphinxcode{C:\textbackslash{}Perl\textbackslash{}bin\textbackslash{}perl.exe "\%s" \%s}

\item {} 
\sphinxmenuselection{Name}: \sphinxcode{Perl Script Map}

\end{itemize}

At the prompt select \sphinxmenuselection{Yes}.

\begin{sphinxadmonition}{note}{Note:}
The ActiveState Perl installer may have already created an entry for
.pl files that is limited to \sphinxcode{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.
\end{sphinxadmonition}

For the second one, set the following values (replacing paths if necessary):
\begin{itemize}
\item {} 
\sphinxmenuselection{Request Path}: \sphinxcode{*.cgi}

\item {} 
\sphinxmenuselection{Executable}: \sphinxcode{C:\textbackslash{}Perl\textbackslash{}bin\textbackslash{}perl.exe "\%s" \%s}

\item {} 
\sphinxmenuselection{Name}: \sphinxcode{CGI Script Map}

\end{itemize}

At the prompt select \sphinxmenuselection{Yes}.


\section{Bugzilla Application}
\label{\detokenize{installing/iis:bugzilla-application}}
Ensure that you are at the Bugzilla Application. Under \sphinxmenuselection{IIS},
double-click \sphinxmenuselection{Handler Mappings}. Under \sphinxmenuselection{Actions}, click
\sphinxmenuselection{Add Script Map}.

Set the following values (replacing paths if necessary):
\begin{itemize}
\item {} 
\sphinxmenuselection{Request Path}: \sphinxcode{*.cgi}

\item {} 
\sphinxmenuselection{Executable}: \sphinxcode{C:\textbackslash{}Perl\textbackslash{}bin\textbackslash{}perl.exe -x"C:\textbackslash{}Bugzilla" -wT "\%s" \%s}

\item {} 
\sphinxmenuselection{Name}: \sphinxcode{Bugzilla}

\end{itemize}

At the prompt select \sphinxmenuselection{Yes}.

Now it's time to restart the IIS server to take these changes into account.
From the top-level menu, which contains the name of your machine, click
\sphinxmenuselection{Restart} under \sphinxmenuselection{Manage Server}. Or run the command:

\sphinxstyleliteralstrong{iisreset}


\section{Common Problems}
\label{\detokenize{installing/iis:common-problems}}\begin{description}
\item[{Bugzilla runs but it's not possible to log in}] \leavevmode
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
\sphinxcode{PerlS.dll} or \sphinxcode{Perl30.dll}.

Reconfigure IIS to use \sphinxcode{perl.exe}.

\item[{IIS returns HTTP 502 errors}] \leavevmode
You probably forgot the \sphinxcode{-T} argument to \sphinxcode{perl} when configuring the
executable in IIS.

\item[{XMLRPC interface not working with IIS}] \leavevmode
This is a known issue. See \sphinxhref{https://bugzilla.mozilla.org/show\_bug.cgi?id=708252}{bug  708252}.

\end{description}


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.


\bigskip\hrule\bigskip


This documentation undoubtedly has bugs; if you find some, please file
them \sphinxhref{https://bugzilla.mozilla.org/enter\_bug.cgi?product=Bugzilla\&component=Documentation}{here}.



\renewcommand{\indexname}{Index}
\printindex
\end{document}