<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>3.8. Optional Post-Install Configuration — Bugzilla 5.0.4 documentation</title>
<link rel="stylesheet" href="../_static/bugzilla.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '5.0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="3.9. Migrating From Other Bug-Tracking Systems" href="migrating.html" />
<link rel="prev" title="3.7. Essential Post-Installation Configuration" href="essential-post-install-config.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="migrating.html" title="3.9. Migrating From Other Bug-Tracking Systems"
accesskey="N">next</a></li>
<li class="right" >
<a href="essential-post-install-config.html" title="3.7. Essential Post-Installation Configuration"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">3. Installation and Maintenance Guide</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="optional-post-install-configuration">
<span id="optional-post-install-config"></span><h1>3.8. Optional Post-Install Configuration<a class="headerlink" href="#optional-post-install-configuration" title="Permalink to this headline">¶</a></h1>
<p>Bugzilla has a number of optional features. This section describes how
to configure or enable them.</p>
<div class="section" id="recurring-tasks">
<span id="id1"></span><h2>3.8.1. Recurring Tasks<a class="headerlink" href="#recurring-tasks" title="Permalink to this headline">¶</a></h2>
<p>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.</p>
<div class="section" id="linux">
<h3>3.8.1.1. Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3>
<p>Run:</p>
<p><strong class="command">crontab -e</strong></p>
<p>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.</p>
</div>
<div class="section" id="windows">
<h3>3.8.1.2. Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
<p>Windows comes with a Task Scheduler. To run a particular script, do the
following:</p>
<ol class="arabic simple">
<li><span class="guilabel">Control Panel</span> --> <span class="guilabel">Scheduled Tasks</span> -->
<span class="guilabel">Add Scheduled Task</span></li>
<li>Next</li>
<li>Browse</li>
<li>Find <code class="file docutils literal"><span class="pre">perl.exe</span></code> (normally <code class="file docutils literal"><span class="pre">C:\Perl\bin\perl.exe</span></code>)</li>
<li>Give the task a name, such as "Bugzilla <scriptname>"</li>
<li>Request the task be performed at your desired time and interval</li>
<li>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</li>
<li>Tick "Open Advanced Properties.." and click Finish</li>
<li>Append the script name to the end of the "Run" field. eg
<strong class="command">C:\Perl\bin\perl.exe C:\Bugzilla\<scriptname></strong></li>
<li>Change "start in" to the Bugzilla directory</li>
</ol>
</div>
</div>
<div class="section" id="bug-graphs">
<span id="installation-bug-graphs"></span><h2>3.8.2. Bug Graphs<a class="headerlink" href="#bug-graphs" title="Permalink to this headline">¶</a></h2>
<p>If you have installed the necessary Perl modules, as indicated by
<code class="file docutils literal"><span class="pre">checksetup.pl</span></code>, you can ask Bugzilla to regularly collect statistics
so that you can see graphs and charts.</p>
<p>On Linux, use a cron line as follows:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>5 0 * * * cd <your-bugzilla-directory> && ./collectstats.pl
</pre></div>
</div>
<p>On Windows, schedule the <code class="file docutils literal"><span class="pre">collectstats.pl</span></code> script to run daily.</p>
<p>After two days have passed you'll be able to view bug graphs from
the Reports page.</p>
</div>
<div class="section" id="whining">
<span id="installation-whining"></span><h2>3.8.3. Whining<a class="headerlink" href="#whining" title="Permalink to this headline">¶</a></h2>
<p>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 <a class="reference internal" href="../administering/whining.html#whining"><span class="std std-ref">Whining</span></a>, but for it to work a Perl script must
be executed at regular intervals.</p>
<p>On Linux, use a cron line as follows:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>*/15 * * * * cd <your-bugzilla-directory> && ./whine.pl
</pre></div>
</div>
<p>On Windows, schedule the <code class="file docutils literal"><span class="pre">whine.pl</span></code> script to run every 15 minutes.</p>
</div>
<div class="section" id="whining-at-untriaged-bugs">
<span id="installation-whining-cron"></span><h2>3.8.4. Whining at Untriaged Bugs<a class="headerlink" href="#whining-at-untriaged-bugs" title="Permalink to this headline">¶</a></h2>
<p>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.</p>
<p>On Linux, use a cron line as follows:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>55 0 * * * cd <your-bugzilla-directory> && ./whineatnews.pl
</pre></div>
</div>
<p>On Windows, schedule the <code class="file docutils literal"><span class="pre">whineatnews.pl</span></code> script to run daily.</p>
</div>
<div class="section" id="dependency-graphs">
<h2>3.8.5. Dependency Graphs<a class="headerlink" href="#dependency-graphs" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla can draw graphs of the dependencies (depends on/blocks relationships)
between bugs, if you install a package called <code class="file docutils literal"><span class="pre">graphviz</span></code>.</p>
<div class="section" id="id2">
<h3>3.8.5.1. Linux<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<p>Put the complete path to the <code class="file docutils literal"><span class="pre">dot</span></code> command (from the <code class="docutils literal"><span class="pre">graphviz</span></code>
package) in the <span class="param">webdotbase</span> parameter. E.g. <span class="paramval">/usr/bin/dot</span>.</p>
</div>
<div class="section" id="id3">
<h3>3.8.5.2. Windows<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>Download and install Graphviz from
<a class="reference external" href="http://www.graphviz.org/Download_windows.php">the Graphviz website</a>. Put
the complete path to <code class="file docutils literal"><span class="pre">dot.exe</span></code> in the <span class="param">webdotbase</span> parameter,
e.g. <span class="paramval">C:\Program Files (x86)\Graphviz2.38\bin\dot.exe</span>.</p>
</div>
</div>
<div class="section" id="documentation">
<h2>3.8.6. Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<p>Bugzilla has extensive documentation and help, written in
<a class="reference external" href="http://sphinx-doc.org/rest.html">reStructured Text</a>
format. A generic compiled copy exists on
<a class="reference external" href="https://bugzilla.readthedocs.org/">bugzilla.readthedocs.org</a>, and
<span class="guilabel">Help</span> links point to it by default. You can also build and use
a local copy of the documentation, for instance because you have added Bugzilla
extensions which come with documentation, or because your users don't have
Internet access from their machines.</p>
<p>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.</p>
<div class="section" id="id4">
<h3>3.8.6.1. Linux<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<ul>
<li><p class="first">Install <a class="reference external" href="http://sphinx-doc.org/">Sphinx</a>. Most Linux distros have it in
a package named <code class="file docutils literal"><span class="pre">python-sphinx</span></code>.</p>
</li>
<li><p class="first">Then go to your Bugzilla directory and run:</p>
<p><strong class="command">docs/makedocs.pl</strong></p>
</li>
</ul>
</div>
<div class="section" id="id5">
<h3>3.8.6.2. Windows<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<ul>
<li><p class="first">Download and install <a class="reference external" href="https://www.python.org/downloads/">Python</a>.
Both Python 2.7 and 3.x will work. Adding <code class="file docutils literal"><span class="pre">python</span></code> to the <span class="param">PATH</span>
environment variable, as suggested by the Python installer, will make your
life easier.</p>
</li>
<li><p class="first">Install <a class="reference external" href="http://sphinx-doc.org/">Sphinx</a>. Run <strong class="command">cmd.exe</strong> and type:</p>
<p><strong class="command">pip install sphinx</strong></p>
</li>
<li><p class="first">Then go to your <code class="file docutils literal"><span class="pre">C:\bugzilla\docs</span></code> directory and run:</p>
<p><strong class="command">makedocs.pl</strong></p>
</li>
</ul>
<hr class="docutils" />
<p>This documentation undoubtedly has bugs; if you find some, please file
them <a class="reference external" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation">here</a>.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/bugzilla.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">3.8. Optional Post-Install Configuration</a><ul>
<li><a class="reference internal" href="#recurring-tasks">3.8.1. Recurring Tasks</a><ul>
<li><a class="reference internal" href="#linux">3.8.1.1. Linux</a></li>
<li><a class="reference internal" href="#windows">3.8.1.2. Windows</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-graphs">3.8.2. Bug Graphs</a></li>
<li><a class="reference internal" href="#whining">3.8.3. Whining</a></li>
<li><a class="reference internal" href="#whining-at-untriaged-bugs">3.8.4. Whining at Untriaged Bugs</a></li>
<li><a class="reference internal" href="#dependency-graphs">3.8.5. Dependency Graphs</a><ul>
<li><a class="reference internal" href="#id2">3.8.5.1. Linux</a></li>
<li><a class="reference internal" href="#id3">3.8.5.2. Windows</a></li>
</ul>
</li>
<li><a class="reference internal" href="#documentation">3.8.6. Documentation</a><ul>
<li><a class="reference internal" href="#id4">3.8.6.1. Linux</a></li>
<li><a class="reference internal" href="#id5">3.8.6.2. Windows</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="essential-post-install-config.html"
title="previous chapter">3.7. Essential Post-Installation Configuration</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="migrating.html"
title="next chapter">3.9. Migrating From Other Bug-Tracking Systems</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="migrating.html" title="3.9. Migrating From Other Bug-Tracking Systems"
>next</a></li>
<li class="right" >
<a href="essential-post-install-config.html" title="3.7. Essential Post-Installation Configuration"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Bugzilla 5.0.4 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >3. Installation and Maintenance Guide</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
