GitLab Documentation

Changing gitlab.yml and application.yml settings

Changing gitlab.yml and application.yml settings

Some of GitLab's features can be customized through gitlab.yml. If you want to change a gitlab.yml setting with omnibus-gitlab, you need to do so via /etc/gitlab/gitlab.rb. The translation works as follows. For a complete list of available options, visit the gitlab.rb.template. New installations starting from GitLab 7.6, will have all the options of the template listed in /etc/gitlab/gitlab.rb by default.

In gitlab.yml, you will find structure like this:

production: &base
    default_theme: 2

In gitlab.rb, this translates to:

gitlab_rails['gitlab_default_theme'] = 2

What happens here is that we forget about production: &base, and join gitlab: with default_theme: into gitlab_default_theme. Note that not all gitlab.yml settings can be changed via gitlab.rb yet; see the gitlab.yml ERB template. If you think an attribute is missing please create a merge request on the omnibus-gitlab repository.

Run sudo gitlab-ctl reconfigure for changes in gitlab.rb to take effect.

Do not edit the generated file in /var/opt/gitlab/gitlab-rails/etc/gitlab.yml since it will be overwritten on the next gitlab-ctl reconfigure run.

Adding a new setting to gitlab.yml

Don't forget to update the following 3 files when adding a new setting:

  • the gitlab.rb.template file to expose the setting to the end user via /etc/gitlab/gitlab.rb
  • the default.rb file to provide a sane default for the new setting
  • the gitlab.yml.example file to actually use the setting's value from gitlab.rb

Was this helpful? Do you think that something is unclear? Use the comments area below and leave your feedback. For support and other enquiries, see getting help.