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

---
stage: Create
group: Editor
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
type: reference
---

# Repository checks

> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3232) in GitLab 8.7.

Git has a built-in mechanism, [`git fsck`](https://git-scm.com/docs/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 in the [`repocheck.log`
file.](logs.md#repochecklog)

NOTE:
It is OFF by default because it still causes too many false alarms.

## 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 the [`repocheck.log` file](logs.md#repochecklog) on disk:

- `/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**.
Add latest changes from gitlab-org/gitlab@master 2020-07-30 08:09:33 -04:00			`---`
			`stage: Create`
			`group: Editor`
Add latest changes from gitlab-org/gitlab@master 2020-11-26 01:09:20 -05:00			`info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"`
Add latest changes from gitlab-org/gitlab@master 2020-07-30 08:09:33 -04:00			`type: reference`
			`---`

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
Add latest changes from gitlab-org/gitlab@master 2020-04-21 11:21:10 -04:00			`> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3232) in GitLab 8.7.`
Rebase repo check MR 2016-04-04 11:23:43 -04:00
Add latest changes from gitlab-org/gitlab@master 2020-04-21 11:21:10 -04:00			Git has a built-in mechanism, [`git fsck`](https://git-scm.com/docs/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`
Add latest changes from gitlab-org/gitlab@master 2020-05-14 20:08:06 -04:00			checks failed you can see their output on in the [`repocheck.log`
			`file.](logs.md#repochecklog)`
Rebase repo check MR 2016-04-04 11:23:43 -04:00
Add latest changes from gitlab-org/gitlab@master 2020-12-04 16:09:29 -05:00			`NOTE:`
Add latest changes from gitlab-org/gitlab@master 2020-03-23 23:09:28 -04:00			`It is OFF by default because it still causes too many false alarms.`

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`
Add latest changes from gitlab-org/gitlab@master 2020-05-14 20:08:06 -04:00			in the [`repocheck.log` file](logs.md#repochecklog) on disk:
Small documentation reformatting and updates 2018-04-23 10:33:18 -04:00
Add latest changes from gitlab-org/gitlab@master 2020-05-14 20:08:06 -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
Add latest changes from gitlab-org/gitlab@master 2019-12-19 01:08:05 -05:00			`If the periodic repository check causes false alarms, you can clear all repository check states by`
Add latest changes from gitlab-org/gitlab@master 2019-12-23 01:07:36 -05:00			`navigating to Admin Area > Settings > Repository`
Add latest changes from gitlab-org/gitlab@master 2019-12-19 01:08:05 -05:00			(`/admin/application_settings/repository`) and clicking Clear all repository checks.