diff options
author | Gervase Markham <gerv@gerv.net> | 2014-12-05 22:52:48 +0100 |
---|---|---|
committer | Dylan William Hardison <dylan@hardison.net> | 2014-12-05 23:01:30 +0100 |
commit | d41a0a76217ebbfd18807128e8bd552d5276e87a (patch) | |
tree | d99e4d9f43a2e0ffb693da447d2061e8985680a6 /docs/en/rst/installing/sanity-check.rst | |
parent | f9e9cf2597bb5e2780a16c0191400998a595fa2b (diff) | |
download | bugzilla-d41a0a76217ebbfd18807128e8bd552d5276e87a.tar.gz bugzilla-d41a0a76217ebbfd18807128e8bd552d5276e87a.tar.xz |
Bug 1067416 - reorganize and update Bugzilla docs
Diffstat (limited to 'docs/en/rst/installing/sanity-check.rst')
-rw-r--r-- | docs/en/rst/installing/sanity-check.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/en/rst/installing/sanity-check.rst b/docs/en/rst/installing/sanity-check.rst new file mode 100644 index 000000000..4f8fb11c6 --- /dev/null +++ b/docs/en/rst/installing/sanity-check.rst @@ -0,0 +1,26 @@ +.. _sanity-check: + +Sanity Check +############ + +Over time it is possible for the Bugzilla database to become corrupt +or to have anomalies. This could happen through manual database +administration outside of the Bugzilla user interface, or from some +other unexpected event. Bugzilla includes a "Sanity Check" that +can perform several basic database checks, and repair certain problems or +inconsistencies. + +To run a Sanity Check, log in as an Administrator and click the +:guilabel:`Sanity Check` link in the admin page. Any problems that are found +will be displayed in red letters. If the script is capable of fixing a +problem, it will present a link to initiate the fix. If the script cannot +fix the problem it will require manual database administration or recovery. + +Sanity Check can also be run from the command line via the perl +script :file:`sanitycheck.pl`. The script can also be run as +a :command:`cron` job. Results will be delivered by email to an address +specified on the command line. + +Sanity Check should be run on a regular basis as a matter of +best practice. + |