diff options
author | Robert Speicher <robert@gitlab.com> | 2016-04-14 20:15:58 +0300 |
---|---|---|
committer | Robert Speicher <robert@gitlab.com> | 2016-04-14 20:15:58 +0300 |
commit | 95a867e0af51370371cbe623b8851c2a3848f12f (patch) | |
tree | 9d933cf855b04f9a8f6a4f39292114165d0e1761 /doc | |
parent | 58ca84908c89435ab0389523c769e39f1076113f (diff) | |
parent | cce21e7490d8684fb8fbaa6c9d5a8ce76c36d975 (diff) |
Merge branch 'auto-fsck' into 'master'
Auto git fsck
Closes https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3232
See merge request !3232
Diffstat (limited to 'doc')
-rw-r--r-- | doc/README.md | 1 | ||||
-rw-r--r-- | doc/administration/repository_checks.md | 43 |
2 files changed, 44 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md index d2660930653..e6ac4794827 100644 --- a/doc/README.md +++ b/doc/README.md @@ -31,6 +31,7 @@ - [Environment Variables](administration/environment_variables.md) to configure GitLab. - [Operations](operations/README.md) Keeping GitLab up and running - [Raketasks](raketasks/README.md) Backups, maintenance, automatic webhook setup and the importing of projects. +- [Repository checks](administration/repository_checks.md) Periodic Git repository checks - [Security](security/README.md) Learn what you can do to further secure your GitLab instance. - [System hooks](system_hooks/system_hooks.md) Notifications when users, projects and keys are changed. - [Update](update/README.md) Update guides to upgrade your installation. diff --git a/doc/administration/repository_checks.md b/doc/administration/repository_checks.md new file mode 100644 index 00000000000..61bf8ce6161 --- /dev/null +++ b/doc/administration/repository_checks.md @@ -0,0 +1,43 @@ +# Repository checks + +>**Note:** +This feature was [introduced][ce-3232] in GitLab 8.7. + +Git has a built-in mechanism, [git fsck][git-fsck], to verify the +integrity of all data commited 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 + +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 week. If any projects +fail their repository checks all GitLab administrators will receive an email +notification of the situation. This notification is sent out no more +than once a day. + +## 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 or +`/home/git/gitlab/log` for installations from source). Once you have +resolved the issue use the admin panel to trigger a new repository check on +the project. This will clear the 'check failed' state. + +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. + +--- +[ce-3232]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3232 "Auto git fsck" +[git-fsck]: https://www.kernel.org/pub/software/scm/git/docs/git-fsck.html "git fsck documentation"
\ No newline at end of file |