gitlab-org--gitlab-foss/doc/administration/gitaly/index.md

Gitaly

Gitaly (introduced in GitLab 9.0) is a service that provides high-level RPC access to Git repositories. As of GitLab 9.3 it is still an optional component with limited scope.

GitLab components that access Git repositories (gitlab-rails, gitlab-shell, gitlab-workhorse) act as clients to Gitaly. End users do not have direct access to Gitaly.

Configuring Gitaly

The Gitaly service itself is configured via a TOML configuration file. This file is documented in the gitaly repository.

To change a Gitaly setting in Omnibus you can use gitaly['my_setting'] in /etc/gitlab/gitlab.rb. Changes will be applied when you run gitlab-ctl reconfigure.

gitaly['prometheus_listen_addr'] = 'localhost:9236'

To change a Gitaly setting in installations from source you can edit /home/git/gitaly/config.toml.

prometheus_listen_addr = "localhost:9236"

Changes to /home/git/gitaly/config.toml are applied when you run service gitlab restart.

Configuring GitLab to not use Gitaly

Gitaly is still an optional component in GitLab 9.3. This means you can choose to not use it.

In Omnibus you can make the following change in /etc/gitlab/gitlab.rb and reconfigure. This will both disable the Gitaly service and configure the rest of GitLab not to use it.

gitaly['enable'] = false

In source installations, edit /home/git/gitlab/config/gitlab.yml and make sure enabled in the gitaly section is set to 'false'. This does not disable the Gitaly service in your init script; it only prevents it from being used.

Apply the change with service gitlab restart.

  gitaly:
    enabled: false

Disabling or enabling the Gitaly service

Be careful: if you disable Gitaly without instructing the rest of your GitLab installation not to use Gitaly, you may end up with errors because GitLab tries to access a service that is not running.

To disable the Gitaly service in your Omnibus installation, add the following line to /etc/gitlab/gitlab.rb:

gitaly['enable'] = false

When you run gitlab-ctl reconfigure the Gitaly service will be disabled.

To disable the Gitaly service in an installation from source, add the following to /etc/default/gitlab:

gitaly_enabled=false

When you run service gitlab restart Gitaly will be disabled.