diff options
author | Jacob Vosmaer (GitLab) <jacob@gitlab.com> | 2018-07-31 16:17:02 +0300 |
---|---|---|
committer | Zeger-Jan van de Weg <zegerjan@gitlab.com> | 2018-07-31 16:17:02 +0300 |
commit | 4660ca0ecf0b152b53810ea5e9eb3bdb876e02e7 (patch) | |
tree | 63c1f24637a9b3bb15521904bf42a29071617f6b | |
parent | a74d859ed038348b4a28a0fd2bd141a80ab2ea05 (diff) |
Document gitlab-shell dependency in config docs
-rw-r--r-- | doc/configuration/README.md | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/configuration/README.md b/doc/configuration/README.md index 91755e4f5..652745eb4 100644 --- a/doc/configuration/README.md +++ b/doc/configuration/README.md @@ -101,7 +101,7 @@ execute RPC's implemented in Ruby instead of Go. The `[gitaly-ruby]` section of the config file contains settings for these helper processes. These processes are known to occasionally suffer from memory leaks. -Gitaly restarts its gitaly-ruby helpers when there memory exceeds the +Gitaly restarts its gitaly-ruby helpers when their memory exceeds the max\_rss limit. |name|type|required|notes| @@ -113,11 +113,29 @@ max\_rss limit. |num_workers|integer|no|Number of gitaly-ruby worker processes. Try increasing this number in case of ResourceExhausted errors. Default 2, minimum 2.| |linguist_languages_path|string|no|Override for dynamic languages.json discovery. Default: "" (use dynamic discovery).| +### gitlab-shell + +For historical reasons +[gitlab-shell](https://gitlab.com/gitlab-org/gitlab-shell) contains +the Git hooks that allow GitLab to validate and react to Git pushes. +Because Gitaly "owns" Git pushes, gitlab-shell must therefore be +installed alongside Gitaly. We hope this will be [simplified in the +future](https://gitlab.com/gitlab-org/gitaly/issues/1226). + +```toml +[gitlab-shell] +dir = "/home/git/gitlab-shell" +``` + +|name|type|required|notes| +|----|----|--------|-----| +|dir|string|yes|The directory where gitlab-shell is installed.| + ### Logging Example: -``` +```toml [logging] level = "warn" ``` |