diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | config.toml.example | 2 | ||||
| -rw-r--r-- | doc/README.md | 6 | ||||
| -rw-r--r-- | doc/configuration/logging.md | 42 |
4 files changed, 8 insertions, 44 deletions
@@ -62,7 +62,7 @@ Gitaly uses `git`. Versions `2.21.0` and `2.22.0` are supported. ## Configuration -See [configuration documentation](doc/configuration). +The administration and reference guide is [documented in the GitLab project](https://docs.gitlab.com/ee/administration/gitaly/). ## Contributing diff --git a/config.toml.example b/config.toml.example index a05ce079c..3ef031451 100644 --- a/config.toml.example +++ b/config.toml.example @@ -1,4 +1,6 @@ # Example Gitaly configuration file +# Documentation lives at https://docs.gitlab.com/ee/administration/gitaly/ and +# https://docs.gitlab.com/ee//administration/gitaly/reference socket_path = "/home/git/gitlab/tmp/sockets/private/gitaly.socket" diff --git a/doc/README.md b/doc/README.md index f0316287b..c0f957e00 100644 --- a/doc/README.md +++ b/doc/README.md @@ -6,13 +6,15 @@ written in [the design doc](doc/DESIGN.md). #### Configuring Gitaly Running Gitaly requires it to be configured correctly, options are described in -the [configuration documentation](doc/configuration/README.md). +GitLab's [configuration documentation](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/administration/gitaly/index.md). + +The reference guide is documented in https://gitlab.com/gitlab-org/gitlab/blob/master/doc/administration/gitaly/reference.md. #### Developing Gitaly - When new to Gitaly development, start by reading the [beginners guide](doc/beginners_guide.md). - When developing on Gitaly-Ruby, read the [Gitaly-Ruby doc](doc/ruby_endpoint.md) -- The Gitaly release process is descripted in [our process doc](doc/PROCESS.md) +- The Gitaly release process is described in [our process doc](doc/PROCESS.md) - Tests use Git repositories too, [read more about them](doc/test_repos.md) #### Gitaly HA diff --git a/doc/configuration/logging.md b/doc/configuration/logging.md index 139a7ed0b..e5eb7a74a 100644 --- a/doc/configuration/logging.md +++ b/doc/configuration/logging.md @@ -1,41 +1 @@ -# Logging - -The following values configure logging in Gitaly under the `[logging]` section - -### dir - -While main gitaly application logs go to stdout, there are extra log files that go to a configured directory. These include: - -1. Gitlab shell logs - -### format - -The format of log messages. The current supported format is `json`. Any other value will be ignored and the default `text` format will be used. - -### level - -The log level. Valid values are the following: - -1. `trace` -1. `debug` -1. `info` -1. `warn` -1. `error` -1. `fatal` -1. `panic` - -The default log level is `info`. - -#### Gitlab Shell Exceptions - -Gitlab Shell does not spport `panic` or `trace`. `panic` will fall back to `error`, while `trace` will fall back to `debug`. Any other invalid log levels -will default to `info`. - -## Format - -```toml -[logging] -dir = "/home/gitaly/logs" -format = "json" -level = "info" -```
\ No newline at end of file +This documentation was moved to https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/administration/gitaly/reference.md#logging. |