Optional Post-Install Configuration
***********************************

Bugzilla has a number of optional features. This section describes how
to configure or enable them.


Recurring Tasks
===============

Several of the below features require you to set up a script to run at
recurring intervals. The method of doing this varies by operating
system.


Linux
-----

Run:

**crontab -e**

This should bring up the crontab file in your editor. Add the relevant
cron line from the sections below in order to enable the corresponding
feature.


Windows
-------

Windows comes with a Task Scheduler. To run a particular script, do
the following:

1. Control Panel --> Scheduled Tasks --> Add Scheduled Task

2. Next

3. Browse

4. Find "perl.exe" (normally "C:\Perl\bin\perl.exe")

5. Give the task a name, such as "Bugzilla <scriptname>"

6. Request the task be performed at your desired time and interval

7. 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

8. Tick "Open Advanced Properties.." and click Finish

9. Append the script name to the end of the "Run" field. eg
   **C:\Perl\bin\perl.exe C:\Bugzilla\<scriptname>**

10. Change "start in" to the Bugzilla directory


Bug Graphs
==========

If you have installed the necessary Perl modules, as indicated by
"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:

   5 0 * * * cd <your-bugzilla-directory> && ./collectstats.pl

On Windows, schedule the "collectstats.pl" script to run daily.

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


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 Whining, but for it to
work a Perl script must be executed at regular intervals.

On Linux, use a cron line as follows:

   */15 * * * * cd <your-bugzilla-directory> && ./whine.pl

On Windows, schedule the "whine.pl" script to run every 15 minutes.


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:

   55 0 * * * cd <your-bugzilla-directory> && ./whineatnews.pl

On Windows, schedule the "whineatnews.pl" script to run daily.


Dependency Graphs
=================

Bugzilla can draw graphs of the dependencies (depends on/blocks
relationships) between bugs, if you install a package called "dot".


Linux
-----

Put the complete path to the "dot" command (from the "graphviz"
package) in the webdotbase parameter. E.g. /usr/bin/dot.


Windows
-------

Download and install Graphviz from the Graphviz website. Put the
complete path to "dot.exe" in the webdotbase parameter, using forward
slashes as path separators. E.g. C:/Program
Files/ATT/Graphviz/bin/dot.exe.


Documentation
=============

Bugzilla has extensive documentation and help, written in reStructured
Text format. A generic compiled copy exists on
bugzilla.readthedocs.org, and 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:

* Install Sphinx ("python-sphinx" package on Debian/Ubuntu)

Then run **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.

======================================================================

This documentation undoubtedly has bugs; if you find some, please file
them here.
