summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/xml/administration.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml
index f8c62913f..83f88630e 100644
--- a/docs/xml/administration.xml
+++ b/docs/xml/administration.xml
@@ -1845,6 +1845,44 @@ Support: ENTRY, DEFAULT/MANDATORY, CANEDIT
</section>
</section>
+ <section id="sanitycheck">
+ <title>Checking and Maintaining Database Integrity</title>
+
+ <para>
+ Over time it is possible for the Bugzilla database to become corrupt
+ or to have anomalies.
+ This could happen through normal usage of Bugzilla, manual database
+ administration outside of the Bugzilla user interface, or from some
+ other unexpected event. Bugzilla includes a "Sanity Check" script that
+ can perform several basic database checks, and repair certain problems or
+ inconsistencies.
+ </para>
+ <para>
+ To run the "Sanity Check" script, log in as an Administrator and click the
+ "Sanity Check" link in the admin page. Any problems that are found will be
+ displayed in red letters. If the script is capable of fixing a problem,
+ it will present a link to initiate the fix. If the script can not
+ fix the problem it will require manual database administration or recovery.
+ </para>
+ <para>
+ The "Sanity Check" script can also be run from the command line via the perl
+ script <filename>sanitycheck.pl</filename>. The script can also be run as
+ a <command>cron</command> job. Results will be delivered by email.
+ </para>
+ <para>
+ The "Sanity Check" script should be run on a regular basis as a matter of
+ best practice.
+ </para>
+ <warning>
+ <para>
+ The "Sanity Check" script is no substitute for a competent database
+ administrator. It is only designed to check and repair basic database
+ problems.
+ </para>
+ </warning>
+
+ </section>
+
<section id="upgrading">
<title>Upgrading to New Releases</title>