gitlab-org--gitlab-foss/doc/administration/repository_checks.md

46 lines
1.9 KiB
Markdown
Raw Normal View History

2016-04-06 11:47:05 +00:00
# Repository checks
2016-04-04 15:23:43 +00:00
> [Introduced][ce-3232] in GitLab 8.7. It is OFF by default because it still
causes too many false alarms.
2016-04-04 15:23:43 +00:00
Git has a built-in mechanism, [`git fsck`][git-fsck], to verify the
2016-05-30 05:30:16 +00:00
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'.
2016-04-04 15:23:43 +00:00
2016-04-13 09:15:36 +00:00
## Periodic checks
2016-04-04 15:23:43 +00:00
When enabled, GitLab periodically runs a repository check on all project
2018-05-03 19:14:48 +00:00
repositories and wiki repositories in order to detect data corruption.
A project will be checked no more than once per month. If any projects
2016-04-06 11:47:05 +00:00
fail their repository checks all GitLab administrators will receive an email
2018-05-03 19:14:48 +00:00
notification of the situation. This notification is sent out once a week,
2018-09-20 09:10:57 +00:00
by default, midnight at the start of Sunday. Repositories with known check
failures can be found at `/admin/projects?last_repository_check_failed=1`.
2016-04-04 15:23:43 +00:00
2016-04-06 10:26:29 +00:00
## Disabling periodic checks
You can disable the periodic checks on the 'Settings' page of the admin
panel.
2016-04-04 15:23:43 +00:00
## What to do if a check failed
2016-04-13 10:20:43 +00:00
If the repository check fails for some repository you should look up the error
in `repocheck.log`:
2019-03-04 00:17:57 +00:00
- in the [admin panel](logs.md#repochecklog)
- or on disk, see:
- `/var/log/gitlab/gitlab-rails` for Omnibus installations
- `/home/git/gitlab/log` for installations from source
If the periodic repository check causes false alarms, you can clear all repository check states by
navigating to **Admin Area > Settings > Repository**
(`/admin/application_settings/repository`) and clicking **Clear all repository checks**.
2016-04-04 15:23:43 +00:00
---
[ce-3232]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3232 "Auto git fsck"
[git-fsck]: https://git-scm.com/docs/git-fsck "git fsck documentation"