gitlab-org--gitlab-foss/doc/administration/repository_checks.md
Ævar Arnfjörð Bjarmason a9c0d688f2 repository check doc: fix a broken link
The link to the repocheck.log section of the logs documentation was
added in 7d9191eeff ("Small documentation reformatting and updates",
2018-04-23), but seemingly never worked. The markdown formatter turns
"." into "-" in headings.

See
https://docs.gitlab.com/ee/administration/repository_checks.html#what-to-do-if-a-check-failed
which has a broken link to
https://docs.gitlab.com/ee/administration/logs.html#repocheck.log
linking to
https://docs.gitlab.com/ee/administration/logs.html#repocheck-log
instead (just change "." to "-") fixes it.
2018-10-18 10:03:38 +02:00

1.9 KiB

Repository checks

Introduced in GitLab 8.7. It is OFF by default because it still causes too many false alarms.

Git has a built-in mechanism, git fsck, to verify the integrity of all data committed to a repository. GitLab administrators can trigger such a check for a project via the project page under the admin panel. The checks run asynchronously so it may take a few minutes before the check result is visible on the project admin page. If the checks failed you can see their output on the admin log page under 'repocheck.log'.

Periodic checks

When enabled, GitLab periodically runs a repository check on all project repositories and wiki repositories in order to detect data corruption. A project will be checked no more than once per month. If any projects fail their repository checks all GitLab administrators will receive an email notification of the situation. This notification is sent out once a week, by default, midnight at the start of Sunday. Repositories with known check failures can be found at /admin/projects?last_repository_check_failed=1.

Disabling periodic checks

You can disable the periodic checks on the 'Settings' page of the admin panel.

What to do if a check failed

If the repository check fails for some repository you should look up the error in repocheck.log:

  • in the admin panel
  • or on disk, see:
    • /var/log/gitlab/gitlab-rails for Omnibus installations
    • /home/git/gitlab/log for installations from source

If for some reason the periodic repository check caused a lot of false alarms you can choose to clear all repository check states by clicking "Clear all repository checks" on the Settings page of the admin panel (/admin/application_settings).