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

44 lines
1.8 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
2016-04-14 15:04:18 +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
repositories and wiki repositories in order to detect data corruption problems.
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
notification of the situation. This notification is sent out once a week on
Sunday, by default.
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
2016-04-04 15:23:43 +00:00
in repocheck.log (in the admin panel or on disk; see
`/var/log/gitlab/gitlab-rails` for Omnibus installations or
`/home/git/gitlab/log` for installations from source). Once you have
2016-04-06 11:47:05 +00:00
resolved the issue use the admin panel to trigger a new repository check on
2016-04-04 15:23:43 +00:00
the project. This will clear the 'check failed' state.
2016-04-13 09:15:36 +00:00
If for some reason the periodic repository check caused a lot of false
alarms you can choose to clear ALL repository check states from the
'Settings' page of the admin panel.
2016-04-04 15:23:43 +00:00
---
[ce-3232]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3232 "Auto git fsck"
2016-05-30 05:30:16 +00:00
[git-fsck]: https://www.kernel.org/pub/software/scm/git/docs/git-fsck.html "git fsck documentation"