gitlab-org--gitlab-foss/doc/administration/environment_variables.md
Dmitriy Zaporozhets 7f2127ee4c
Merge remote-tracking branch 'origin/crosslink-env-docs'
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2016-01-05 10:36:35 +01:00

2 KiB

Environment Variables

Introduction

Commonly people configure GitLab via the gitlab.rb configuration file in the Omnibus package.

But if you prefer to use environment variables we allow that too.

Supported environment variables

Variable Type Explanation
GITLAB_ROOT_PASSWORD string sets the password for the root user on installation
GITLAB_HOST url hostname of the GitLab server includes http or https
RAILS_ENV production / development / staging / test Rails environment
DATABASE_URL url For example: postgresql://localhost/blog_development?pool=5
GITLAB_EMAIL_FROM email Email address used in the "From" field in mails sent by GitLab
GITLAB_EMAIL_DISPLAY_NAME string Name used in the "From" field in mails sent by GitLab
GITLAB_EMAIL_REPLY_TO email Email address used in the "Reply-To" field in mails sent by GitLab

Complete database variables

As explained in the Heroku documentation the DATABASE_URL doesn't let you set:

  • adapter
  • database
  • username
  • password
  • host
  • port

To do so please cp config/database.yml.env config/database.yml and use the following variables:

Variable Default
GITLAB_DATABASE_ADAPTER postgresql
GITLAB_DATABASE_ENCODING unicode
GITLAB_DATABASE_DATABASE gitlab_#{ENV['RAILS_ENV']
GITLAB_DATABASE_POOL 10
GITLAB_DATABASE_USERNAME root
GITLAB_DATABASE_PASSWORD
GITLAB_DATABASE_HOST localhost
GITLAB_DATABASE_PORT 5432

Adding more variables

We welcome merge requests to make more settings configurable via variables. Please stick to the naming scheme "GITLAB_#{name 1_settings.rb in upper case}".

Omnibus configuration

It's possible to preconfigure the GitLab image by adding the environment variable: GITLAB_OMNIBUS_CONFIG to docker run command. For more information see the 'preconfigure-docker-container' section in the Omnibus documentation.