environment_variables.md 3.93 KB
Newer Older
1 2
# Environment Variables

3 4
GitLab exposes certain environment variables which can be used to override
their defaults values.
5

6 7
People usually configure GitLab via `/etc/gitlab/gitlab.rb` for Omnibus
installations, or `gitlab.yml` for installations from source.
8

9 10
Below you will find the supported environment variables which you can use to
override certain values.
11 12 13

## Supported environment variables

14
Variable | Type | Description
15
-------- | ---- | -----------
16
`GITLAB_CDN_HOST`                          | string  | Sets the base URL for a CDN to serve static assets (e.g. `//mycdnsubdomain.fictional-cdn.com`)
17 18 19 20 21 22 23 24 25 26 27
`GITLAB_ROOT_PASSWORD`                     | string  | Sets the password for the `root` user on installation
`GITLAB_HOST`                              | string  | The full URL of the GitLab server (including `http://` or `https://`)
`RAILS_ENV`                                | string  | The Rails environment; can be one of `production`, `development`, `staging` or `test`
`DATABASE_URL`                             | string  | The database URL; is of the form: `postgresql://localhost/blog_development`
`GITLAB_EMAIL_FROM`                        | string  | The e-mail address used in the "From" field in e-mails sent by GitLab
`GITLAB_EMAIL_DISPLAY_NAME`                | string  | The name used in the "From" field in e-mails sent by GitLab
`GITLAB_EMAIL_REPLY_TO`                    | string  | The e-mail address used in the "Reply-To" field in e-mails sent by GitLab
`GITLAB_EMAIL_SUBJECT_SUFFIX`              | string  | The e-mail subject suffix used in e-mails sent by GitLab
`GITLAB_UNICORN_MEMORY_MIN`                | integer | The minimum memory threshold (in bytes) for the Unicorn worker killer
`GITLAB_UNICORN_MEMORY_MAX`                | integer | The maximum memory threshold (in bytes) for the Unicorn worker killer
`GITLAB_SHARED_RUNNERS_REGISTRATION_TOKEN` | string  | Sets the initial registration token used for GitLab Runners
28 29 30

## Complete database variables

31 32
The recommended way of specifying your database connection information is to set
the `DATABASE_URL` environment variable. This variable only holds connection
33 34 35 36
information (`adapter`, `database`, `username`, `password`, `host` and `port`),
but not behavior information (`encoding`, `pool`). If you don't want to use
`DATABASE_URL` and/or want to set database behavior information, you will have
to either:
37

38
- copy our template file: `cp config/database.yml.env config/database.yml`, or
39
- set a value for some `GITLAB_DATABASE_XXX` variables
40

41
The list of `GITLAB_DATABASE_XXX` variables that you can set is:
42

43
Variable | Default value | Overridden by `DATABASE_URL`?
44 45 46 47 48 49 50 51 52
-------- | ------------- | -----------------------------
`GITLAB_DATABASE_ADAPTER`   | `postgresql` (for MySQL use `mysql2`) | Yes
`GITLAB_DATABASE_DATABASE`  | `gitlab_#{ENV['RAILS_ENV']`           | Yes
`GITLAB_DATABASE_USERNAME`  | `root`                                | Yes
`GITLAB_DATABASE_PASSWORD`  | None                                  | Yes
`GITLAB_DATABASE_HOST`      | `localhost`                           | Yes
`GITLAB_DATABASE_PORT`      | `5432`                                | Yes
`GITLAB_DATABASE_ENCODING`  | `unicode`                             | No
`GITLAB_DATABASE_POOL`      | `10`                                  | No
53

54
## Adding more variables
55 56

We welcome merge requests to make more settings configurable via variables.
57 58
Please make changes in the `config/initializers/1_settings.rb` file and stick
to the naming scheme `GITLAB_#{name in 1_settings.rb in upper case}`.
59 60 61

## Omnibus configuration

62 63 64
To set environment variables, follow [these
instructions](https://docs.gitlab.com/omnibus/settings/environment-variables.html).

65 66
It's possible to preconfigure the GitLab docker image by adding the environment
variable `GITLAB_OMNIBUS_CONFIG` to the `docker run` command.
67
For more information see the ['preconfigure-docker-container' section in the Omnibus documentation](http://docs.gitlab.com/omnibus/docker/#preconfigure-docker-container).