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

# Repository checks

> [Introduced][ce-3232] 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][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](logs.md#repochecklog)
- 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`).

---
[ce-3232]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3232 "Auto git fsck"
[git-fsck]: https://git-scm.com/docs/git-fsck "git fsck documentation"
Rename almost all the things 2016-04-06 07:47:05 -04:00			`# Repository checks`
Rebase repo check MR 2016-04-04 11:23:43 -04:00
Simplify feature introduction note [ci skip] 2016-08-08 04:09:54 -04:00			`> [Introduced][ce-3232] in GitLab 8.7. It is OFF by default because it still`
			`causes too many false alarms.`
Rebase repo check MR 2016-04-04 11:23:43 -04:00
Documentation / help improvements 2016-04-14 11:04:18 -04:00			`Git has a built-in mechanism, [git fsck][git-fsck], to verify the`
commited -> committed 2016-05-30 01:30:16 -04:00			`integrity of all data committed to a repository. GitLab administrators`
Move 'clear checks' button to applicatoin settings 2016-04-12 11:32:58 -04:00			`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'.`
Rebase repo check MR 2016-04-04 11:23:43 -04:00
Improve English, thanks Robert 2016-04-13 05:15:36 -04:00			`## Periodic checks`
Rebase repo check MR 2016-04-04 11:23:43 -04:00
Small documentation reformatting and updates 2018-04-23 10:33:18 -04:00			`When enabled, GitLab periodically runs a repository check on all project`
Add small improvements to the docs 2018-05-03 15:14:48 -04:00			`repositories and wiki repositories in order to detect data corruption.`
Update repository check documentation The documentation seemed to be out of date with actual defaults in configuration and code. 2017-01-26 10:33:02 -05:00			`A project will be checked no more than once per month. If any projects`
Rename almost all the things 2016-04-06 07:47:05 -04:00			`fail their repository checks all GitLab administrators will receive an email`
Add small improvements to the docs 2018-05-03 15:14:48 -04:00			`notification of the situation. This notification is sent out once a week,`
docs: link to repo check failures 2018-09-20 05:10:57 -04: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`.
Rebase repo check MR 2016-04-04 11:23:43 -04:00
Document how to disable repo checks 2016-04-06 06:26:29 -04:00			`## Disabling periodic checks`

Move 'clear checks' button to applicatoin settings 2016-04-12 11:32:58 -04:00			`You can disable the periodic checks on the 'Settings' page of the admin`
			`panel.`
Rebase repo check MR 2016-04-04 11:23:43 -04:00
			`## What to do if a check failed`

Remove \f. WT\F ?? 2016-04-13 06:20:43 -04:00			`If the repository check fails for some repository you should look up the error`
Small documentation reformatting and updates 2018-04-23 10:33:18 -04:00			in `repocheck.log`:

Docs: Fix all anchors in Admin docs 2019-03-03 19:17:57 -05:00			`- in the [admin panel](logs.md#repochecklog)`
Small documentation reformatting and updates 2018-04-23 10:33:18 -04:00			`- or on disk, see:`
Fix unordered list spacing Correct the spacing of unordered markdown lists in docs, to maintain standards of documentation. 2019-07-17 21:15:58 -04:00			- `/var/log/gitlab/gitlab-rails` for Omnibus installations
			- `/home/git/gitlab/log` for installations from source
Small documentation reformatting and updates 2018-04-23 10:33:18 -04:00
Improve English, thanks Robert 2016-04-13 05:15:36 -04:00			`If for some reason the periodic repository check caused a lot of false`
Small documentation reformatting and updates 2018-04-23 10:33:18 -04:00			`alarms you can choose to clear all repository check states by`
Add small improvements to the docs 2018-05-03 15:14:48 -04:00			`clicking "Clear all repository checks" on the Settings page of the`
			admin panel (`/admin/application_settings`).
Rebase repo check MR 2016-04-04 11:23:43 -04:00
			`---`
			`[ce-3232]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3232 "Auto git fsck"`
Small documentation reformatting and updates 2018-04-23 10:33:18 -04:00			`[git-fsck]: https://git-scm.com/docs/git-fsck "git fsck documentation"`