Configuration options for Linux package installations
Offering: Self-managed
To configure GitLab, set the relevant options in the /etc/gitlab/gitlab.rb
file.
gitlab.rb.template
contains a complete list of available options. New installations have all the
options of the template listed in /etc/gitlab/gitlab.rb
by default.
/etc/gitlab/gitlab.rb
might not always reflect the default settings for an instance.For a list of default settings, see the package defaults.
Configure the external URL for GitLab
To display the correct repository clone links to your users, you must provide GitLab with the URL your users use to reach the repository. You can use the IP of your server, but a Fully Qualified Domain Name (FQDN) is preferred. See the DNS documentation for more details about the use of DNS in a self-managed GitLab instance.
To change the external URL:
-
Optional. Before you change the external URL, determine if you have previously defined a custom Home page URL or After sign-out path. Both of these settings might cause unintentional redirecting after configuring a new external URL. If you have defined any URLs, remove them completely.
-
Edit
/etc/gitlab/gitlab.rb
and changeexternal_url
to your preferred URL:external_url "http://gitlab.example.com"
Alternatively, you can use the IP address of your server:
external_url "http://10.0.0.1"
In the previous examples we use plain HTTP. If you want to use HTTPS, see how to configure SSL.
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
-
Optional. If you had been using GitLab for a while, after you change the external URL, you should also invalidate the Markdown cache.
Specify the external URL at the time of installation
If you use the Linux package, you can set up your GitLab instance
with the minimum number of commands by using the EXTERNAL_URL
environment variable.
If this variable is set, it is automatically detected and its value is written
as external_url
in the gitlab.rb
file.
The EXTERNAL_URL
environment variable affects only the installation and upgrade
of packages. For regular reconfigure runs, the value
in /etc/gitlab/gitlab.rb
is used.
As part of package updates, if you have EXTERNAL_URL
variable set
inadvertently, it replaces the existing value in /etc/gitlab/gitlab.rb
without any warning. So, we recommended not to set the variable globally, but
rather pass it specifically to the installation command:
sudo EXTERNAL_URL="https://gitlab.example.com" apt-get install gitlab-ee
Configure a relative URL for GitLab
While we recommended installing GitLab in its own (sub)domain, sometimes
it is not possible. In that case, GitLab can also
be installed under a relative URL, for example, https://example.com/gitlab
.
By changing the URL, all remote URLs change as well, so you must manually edit them in any local repository that points to your GitLab instance.
To enable relative URL in GitLab:
-
Set the
external_url
in/etc/gitlab/gitlab.rb
:external_url "https://example.com/gitlab"
In this example, the relative URL under which GitLab is served is
/gitlab
. Change it to your liking. -
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
If you have any issues, see the troubleshooting section.
Load external configuration file from non-root user
Linux package installations load all configuration from /etc/gitlab/gitlab.rb
file.
This file has strict file permissions and is owned by the root
user. The reason for strict permissions
and ownership is that /etc/gitlab/gitlab.rb
is being executed as Ruby code by the root
user during gitlab-ctl reconfigure
. This means
that users who have write access to /etc/gitlab/gitlab.rb
can add a configuration that is executed as code by root
.
In certain organizations, it is allowed to have access to the configuration files but not as the root user.
You can include an external configuration file inside /etc/gitlab/gitlab.rb
by specifying the path to the file:
-
Edit
/etc/gitlab/gitlab.rb
:from_file "/home/admin/external_gitlab.rb"
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
When you use from_file
:
- Code you include into
/etc/gitlab/gitlab.rb
usingfrom_file
runs withroot
privileges when you reconfigure GitLab. - Any configuration that is set in
/etc/gitlab/gitlab.rb
afterfrom_file
is included, takes precedence over the configuration from the included file.
Read certificate from file
Certificates can be stored as separate files and loaded into memory when running sudo gitlab-ctl reconfigure
. Files containing
certificates must be plaintext.
In this example, the PostgreSQL server certificate is read directly from a file rather than copying and pasting into /etc/gitlab/gitlab.rb
directly.
postgresql['internal_certificate'] = File.read('/path/to/server.crt')
Store Git data in an alternative directory
By default, Linux package installations store the Git repository data under
/var/opt/gitlab/git-data
. The repositories are stored in a subfolder called
repositories
.
To change the location of the git-data
parent directory:
-
Edit
/etc/gitlab/gitlab.rb
:git_data_dirs({ "default" => { "path" => "/mnt/nas/git-data" } })
You can also add more than one Git data directory:
git_data_dirs({ "default" => { "path" => "/var/opt/gitlab/git-data" }, "alternative" => { "path" => "/mnt/nas/git-data" } })
The target directories and any of its subpaths must not be a symlink.
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
-
Optional. If you already have existing Git repositories in
/var/opt/gitlab/git-data
, you can move them to the new location:-
Prevent users from writing to the repositories while you move them:
sudo gitlab-ctl stop
-
Sync the repositories to the new location. Note there is no slash behind
repositories
, but there is a slash behindgit-data
:sudo rsync -av --delete /var/opt/gitlab/git-data/repositories /mnt/nas/git-data/
-
Reconfigure to start the necessary processes and fix any wrong permissions:
sudo gitlab-ctl reconfigure
-
Double-check the directory layout in
/mnt/nas/git-data/
. The expected output should berepositories
:sudo ls /mnt/nas/git-data/
-
Start GitLab and verify that you can browse through the repositories in the web interface:
sudo gitlab-ctl start
-
If you’re running Gitaly on a separate server, remember to also include the
gitaly_address
for each Git data directory. See
the documentation on configuring Gitaly.
If you’re not looking to move all repositories, but instead want to move specific
projects between existing repository storages, use the
Edit Project API
endpoint and specify the repository_storage
attribute.
Change the name of the Git user or group
By default, Linux package installations use the user name git
for Git GitLab Shell login,
ownership of the Git data itself, and SSH URL generation on the web interface.
Similarly, the git
group is used for group ownership of the Git data.
To change the user and group on a new Linux package installation:
-
Edit
/etc/gitlab/gitlab.rb
:user['username'] = "gitlab" user['group'] = "gitlab"
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
If you are changing the username of an existing installation, the reconfigure run doesn’t change the ownership of the nested directories, so you must do that manually.
At the very least, you must change ownership of the repositories and uploads directories:
sudo chown -R gitlab:gitlab /var/opt/gitlab/git-data/repositories
sudo chown -R gitlab:gitlab /var/opt/gitlab/gitlab-rails/uploads
Specify numeric user and group identifiers
Linux package installations create users for GitLab, PostgreSQL, Redis, NGINX, etc. To specify the numeric identifiers for these users:
-
Write down the old user and group identifiers, as you might need them later:
sudo cat /etc/passwd
-
Edit
/etc/gitlab/gitlab.rb
and change any of the identifiers you want:user['uid'] = 1234 user['gid'] = 1234 postgresql['uid'] = 1235 postgresql['gid'] = 1235 redis['uid'] = 1236 redis['gid'] = 1236 web_server['uid'] = 1237 web_server['gid'] = 1237 registry['uid'] = 1238 registry['gid'] = 1238 mattermost['uid'] = 1239 mattermost['gid'] = 1239 prometheus['uid'] = 1240 prometheus['gid'] = 1240
-
Stop, reconfigure, and then start GitLab:
sudo gitlab-ctl stop sudo gitlab-ctl reconfigure sudo gitlab-ctl start
-
Optional. If you’re changing
user['uid']
anduser['gid']
, make sure to update the uid/guid of any files not managed by the Linux package directly, for example, the logs:find /var/log/gitlab -uid <old_uid> | xargs -I:: chown git :: find /var/log/gitlab -gid <old_uid> | xargs -I:: chgrp git :: find /var/opt/gitlab -uid <old_uid> | xargs -I:: chown git :: find /var/opt/gitlab -gid <old_uid> | xargs -I:: chgrp git ::
Disable user and group account management
By default, Linux package installations create system user and group accounts, as well as keeping the information updated. These system accounts run various components of the package. Most users don’t need to change this behavior. However, if your system accounts are managed by other software, for example, LDAP, you might need to disable account management done by the GitLab package.
By default, the Linux package installations expect the following users and groups to exist:
Linux user and group | Required | Description | Default home directory | Default shell |
---|---|---|---|---|
git
| Yes | GitLab user/group | /var/opt/gitlab
| bin/sh
|
gitlab-www
| Yes | Web server user/group | /var/opt/gitlab/nginx
| /bin/false
|
gitlab-prometheus
| Yes | Prometheus user/group for Prometheus monitoring and various exporters | /var/opt/gitlab/prometheus
| /bin/sh
|
gitlab-redis
| Only when using the packaged Redis | Redis user/group for GitLab | /var/opt/gitlab/redis
| /bin/false
|
gitlab-psql
| Only when using the packaged PostgreSQL | PostgreSQL user/group | /var/opt/gitlab/postgresql
| /bin/sh
|
gitlab-consul
| Only when using GitLab Consul | GitLab Consul user/group | /var/opt/gitlab/consul
| /bin/sh
|
registry
| Only when using GitLab Registry | GitLab Registry user/group | /var/opt/gitlab/registry
| /bin/sh
|
mattermost
| Only when using GitLab Mattermost | GitLab Mattermost user/group | /var/opt/gitlab/mattermost
| /bin/sh
|
To disable user and group accounts management:
-
Edit
/etc/gitlab/gitlab.rb
:manage_accounts['enable'] = false
-
Optional. You can also use different user/group names, but then you must specify the user/group details:
# GitLab user['username'] = "git" user['group'] = "git" user['shell'] = "/bin/sh" user['home'] = "/var/opt/custom-gitlab" # Web server web_server['username'] = 'webserver-gitlab' web_server['group'] = 'webserver-gitlab' web_server['shell'] = '/bin/false' web_server['home'] = '/var/opt/gitlab/webserver' # Prometheus prometheus['username'] = 'gitlab-prometheus' prometheus['group'] = 'gitlab-prometheus' prometheus['shell'] = '/bin/sh' prometheus['home'] = '/var/opt/gitlab/prometheus' # Redis (not needed when using external Redis) redis['username'] = "redis-gitlab" redis['group'] = "redis-gitlab" redis['shell'] = "/bin/false" redis['home'] = "/var/opt/redis-gitlab" # Postgresql (not needed when using external Postgresql) postgresql['username'] = "postgres-gitlab" postgresql['group'] = "postgres-gitlab" postgresql['shell'] = "/bin/sh" postgresql['home'] = "/var/opt/postgres-gitlab" # Consul consul['username'] = 'gitlab-consul' consul['group'] = 'gitlab-consul' consul['dir'] = "/var/opt/gitlab/registry" # Registry registry['username'] = "registry" registry['group'] = "registry" registry['dir'] = "/var/opt/gitlab/registry" # Mattermost mattermost['username'] = 'mattermost' mattermost['group'] = 'mattermost' mattermost['home'] = '/var/opt/gitlab/mattermost'
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Move the home directory for a user
For the GitLab user, we recommended that the home directory is set on a local disk and not on shared storage like NFS, for better performance. When setting it in NFS, Git requests must make another network request to read the Git configuration and this increases latency in Git operations.
To move an existing home directory, GitLab services need to be stopped and some downtime is required:
-
Stop GitLab:
sudo gitlab-ctl stop
-
Stop the runit server:
sudo systemctl stop gitlab-runsvdir
-
Change the home directory:
sudo usermod -d /path/to/home <username>
If you had existing data, you need to manually copy/rsync it to the new location:
-
Edit
/etc/gitlab/gitlab.rb
:user['home'] = "/var/opt/custom-gitlab"
-
Start the runit server:
sudo systemctl start gitlab-runsvdir
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Disable storage directories management
The Linux package takes care of creating all the necessary directories with the correct ownership and permissions, as well as keeping this updated.
Some of the directories hold large amounts of data so in certain setups, those directories are most likely mounted on an NFS (or some other) share.
Some types of mounts don’t allow the automatic creation of directories by the root user
(default user for initial setup), for example, NFS with root_squash
enabled on the
share. To work around this, the Linux package attempts to create
those directories using the directory’s owner user.
Disable the /etc/gitlab
directory management
If you have the /etc/gitlab
directory mounted, you can turn off the management of
that directory:
-
Edit
/etc/gitlab/gitlab.rb
:manage_storage_directories['manage_etc'] = false
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Disable the /var/opt/gitlab
directory management
If you are mounting all GitLab storage directories, each on a separate mount, you should completely disable the management of storage directories.
Linux package installations expect these directories to exist on the file system. It is up to you to create and set correct permissions if this setting is set.
Enabling this setting prevents the creation of the following directories:
Default location | Permissions | Ownership | Purpose |
---|---|---|---|
/var/opt/gitlab/git-data
| 0700
| git:git
| Holds repositories directory |
/var/opt/gitlab/git-data/repositories
| 2770
| git:git
| Holds Git repositories |
/var/opt/gitlab/gitlab-rails/shared
| 0751
| git:gitlab-www
| Holds large object directories |
/var/opt/gitlab/gitlab-rails/shared/artifacts
| 0700
| git:git
| Holds CI artifacts |
/var/opt/gitlab/gitlab-rails/shared/external-diffs
| 0700
| git:git
| Holds external merge request diffs |
/var/opt/gitlab/gitlab-rails/shared/lfs-objects
| 0700
| git:git
| Holds LFS objects |
/var/opt/gitlab/gitlab-rails/shared/packages
| 0700
| git:git
| Holds package repository |
/var/opt/gitlab/gitlab-rails/shared/dependency_proxy
| 0700
| git:git
| Holds dependency proxy |
/var/opt/gitlab/gitlab-rails/shared/terraform_state
| 0700
| git:git
| Holds terraform state |
/var/opt/gitlab/gitlab-rails/shared/ci_secure_files
| 0700
| git:git
| Holds uploaded secure files |
/var/opt/gitlab/gitlab-rails/shared/pages
| 0750
| git:gitlab-www
| Holds user pages |
/var/opt/gitlab/gitlab-rails/uploads
| 0700
| git:git
| Holds user attachments |
/var/opt/gitlab/gitlab-ci/builds
| 0700
| git:git
| Holds CI build logs |
/var/opt/gitlab/.ssh
| 0700
| git:git
| Holds authorized keys |
To disable the management of storage directories:
-
Edit
/etc/gitlab/gitlab.rb
:manage_storage_directories['enable'] = false
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Start Linux package installation services only after a given file system is mounted
If you want to prevent Linux package installation services (NGINX, Redis, Puma, etc.)
from starting before a given file system is mounted, you can set the
high_availability['mountpoint']
setting:
-
Edit
/etc/gitlab/gitlab.rb
:# wait for /var/opt/gitlab to be mounted high_availability['mountpoint'] = '/var/opt/gitlab'
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
If the mount point doesn’t exist, GitLab fails to reconfigure.
Configure the runtime directory
When Prometheus monitoring is enabled, the GitLab Exporter conducts measurements of each Puma process (Rails metrics). Every Puma process needs to write a metrics file to a temporary location for each controller request. Prometheus then collects all these files and processes their values.
To avoid creating disk I/O, the Linux package uses a runtime directory.
During reconfigure
, the package check if /run
is a tmpfs
mount.
If it is not, the following warning is shown and Rails metrics are disabled:
Runtime directory '/run' is not a tmpfs mount.
To enable the Rails metrics again:
-
Edit
/etc/gitlab/gitlab.rb
to create atmpfs
mount (note that there is no=
in the configuration):runtime_dir '/path/to/tmpfs'
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Configure a failed authentication ban
You can configure a failed authentication ban for Git and the container registry. When a client is banned, a 403 error code is returned.
The following settings can be configured:
Setting | Description |
---|---|
enabled
|
false by default. Set this to true to enable the Git and registry authentication ban.
|
ip_whitelist
| IPs to not block. They must be formatted as strings in a Ruby array. You can use either single IPs or CIDR notation, for example, ["127.0.0.1", "127.0.0.2", "127.0.0.3", "192.168.0.1/24"] .
|
maxretry
| The maximum amount of times a request can be made in the specified time. |
findtime
| The maximum amount of time in seconds that failed requests can count against an IP before it’s added to the denylist. |
bantime
| The total amount of time in seconds that an IP is blocked. |
To configure the Git and container registry authentication ban:
-
Edit
/etc/gitlab/gitlab.rb
:gitlab_rails['rack_attack_git_basic_auth'] = { 'enabled' => true, 'ip_whitelist' => ["127.0.0.1"], 'maxretry' => 10, # Limit the number of Git HTTP authentication attempts per IP 'findtime' => 60, # Reset the auth attempt counter per IP after 60 seconds 'bantime' => 3600 # Ban an IP for one hour (3600s) after too many auth attempts }
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Disable automatic cache cleaning during installation
If you have a large GitLab installation, you might not want to run a rake cache:clear
task
as it can take a long time to finish. By default, the cache clear task runs automatically
during reconfiguring.
To disable automatic cache cleaning during installation:
-
Edit
/etc/gitlab/gitlab.rb
:# This is an advanced feature used by large gitlab deployments where loading # whole RAILS env takes a lot of time. gitlab_rails['rake_cache_clear'] = false
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Error Reporting and Logging with Sentry
Sentry is an open source error reporting and logging tool which can be used as SaaS (https://sentry.io) or host it yourself.
To configure Sentry:
- Create a project in Sentry.
- Find the Data Source Name (DSN) of the project you created.
-
Edit
/etc/gitlab/gitlab.rb
:gitlab_rails['sentry_enabled'] = true gitlab_rails['sentry_dsn'] = 'https://<public_key>@<host>/<project_id>' # value used by the Rails SDK gitlab_rails['sentry_clientside_dsn'] = 'https://<public_key>@<host>/<project_id>' # value used by the Browser JavaScript SDK gitlab_rails['sentry_environment'] = 'production'
The Sentry environment can be used to track errors and issues across several deployed GitLab environments, for example, lab, development, staging, and production.
-
Optional. To set custom Sentry tags on every event sent from a particular server, the
GITLAB_SENTRY_EXTRA_TAGS
an environment variable can be set. This variable is a JSON-encoded hash representing any tags that should be passed to Sentry for all exceptions from that server.For instance, setting:
gitlab_rails['env'] = { 'GITLAB_SENTRY_EXTRA_TAGS' => '{"stage": "main"}' }
Would add the
stage
tag with a value ofmain
. -
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Set a Content Delivery Network URL
Service static assets with a Content Delivery Network (CDN) or asset host
using gitlab_rails['cdn_host']
. This configures a Rails asset host.
To set a CDN/asset host:
-
Edit
/etc/gitlab/gitlab.rb
:gitlab_rails['cdn_host'] = 'https://mycdnsubdomain.fictional-cdn.com'
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Additional documentation for configuring common services to act as an asset host is tracked in this issue.
Set a Content Security Policy
Setting a Content Security Policy (CSP) can help thwart JavaScript cross-site scripting (XSS) attacks. See the Mozilla documentation on CSP for more details.
GitLab 12.2 added support for CSP and nonce-source with inline JavaScript. It is not configured by default yet.
report_only
to true
to test the configuration.To add a CSP:
-
Edit
/etc/gitlab/gitlab.rb
:gitlab_rails['content_security_policy'] = { enabled: true, report_only: false }
GitLab automatically provides secure default values for the CSP. Explicitly setting the
<default_value>
value for a directive is equivalent to not setting a value and will use the default values.To add a custom CSP:
gitlab_rails['content_security_policy'] = { enabled: true, report_only: false, directives: { default_src: "'none'", script_src: "https://example.com" } }
In GitLab 14.9 and later, secure default values are used for directives that aren’t explicitly configured.
To unset a CSP directive, set a value of
false
. -
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
Set initial root password on installation
The initial password for the administrator user root
can be set at installation time. For more information, see
Set up the initial password.
Set allowed hosts to prevent host header attacks
To prevent GitLab from accepting a host header other than what’s intended:
-
Edit
/etc/gitlab/gitlab.rb
:gitlab_rails['allowed_hosts'] = ['gitlab.example.com']
-
Reconfigure GitLab:
sudo gitlab-ctl reconfigure
There are no known security issues in GitLab caused by not configuring allowed_hosts
,
but it’s recommended for defense in depth against potential HTTP Host header attacks.
If using a custom external proxy such as Apache, it may be necessary to add the localhost address or name (localhost
or 127.0.0.1
). You should add filters to the external proxy to mitigate potential HTTP Host header attacks passed through the proxy to workhorse.
gitlab_rails['allowed_hosts'] = ['gitlab.example.com', '127.0.0.1', 'localhost']
Provide sensitive configuration to components without plain text storage
Some components expose an extra_config_command
option in gitlab.rb
. This allows an external script to provide secrets
dynamically rather than read them from plain text storage.
The available options are:
gitlab.rb setting
| Responsibility |
---|---|
gitlab_rails['redis_extra_config_command']
| Provides extra configuration to the Redis configuration files used by GitLab Rails application. (resque.yml , redis.yml , redis.<redis_instance>.yml files)
|
gitlab_rails['db_extra_config_command']
| Provides extra configuration to the DB configuration file used by GitLab Rails application. (database.yml )
|
gitlab_kas['extra_config_command']
| Provides extra configuration to GitLab agent server for Kubernetes (KAS). |
gitlab_workhorse['extra_config_command']
| Provides extra configuration to GitLab Workhorse. |
gitlab_exporter['extra_config_command']
| Provides extra configuration to GitLab Exporter. |
The value assigned to any of these options should be an absolute path to an executable script that writes the sensitive configuration in the required format to STDOUT. The components:
- Execute the supplied script.
- Replace values set by user and default configuration files with those emitted by the script.
Provide Redis password to client components
As an example, you can use the script and gitlab.rb
snippet below to
specify the password of a Redis server to the components that need to connect to
Redis.
-
Save the script below as
/opt/generate-redis-conf
#!/opt/gitlab/embedded/bin/ruby require 'json' require 'yaml' class RedisConfig REDIS_PASSWORD = `echo "toomanysecrets"`.strip # Change the command inside backticks to fetch Redis password class << self def rails puts YAML.dump({ 'password' => REDIS_PASSWORD }) end def kas puts YAML.dump({ 'redis' => { 'password' => REDIS_PASSWORD } }) end def workhorse puts JSON.dump({ redis: { password: REDIS_PASSWORD } }) end def gitlab_exporter puts YAML.dump({ 'probes' => { 'sidekiq' => { 'opts' => { 'redis_password' => REDIS_PASSWORD } } } }) end end end def print_error_and_exit $stdout.puts "Usage: redis_credentials <COMPONENT>" $stderr.puts "Supported components are: rails, kas, workhorse, gitlab_exporter" exit 1 end print_error_and_exit if ARGV.length != 1 component = ARGV.shift begin RedisConfig.send(component.to_sym) rescue NoMethodError print_error_and_exit end
-
Ensure the script created above is executable:
chmod +x /opt/generate-redis-conf
-
Add the snippet below to
/etc/gitlab/gitlab.rb
:gitlab_rails['redis_extra_config_command'] = '/opt/generate-redis-conf rails' gitlab_workhorse['extra_config_command'] = '/opt/generate-redis-conf workhorse' gitlab_kas['extra_config_command'] = '/opt/generate-redis-conf kas' gitlab_exporter['extra_config_command'] = '/opt/generate-redis-conf gitlab_exporter'
-
Run
sudo gitlab-ctl reconfigure
.
Provide the PostgreSQL user password to GitLab Rails
As an example, you can use the script and configuration below to provide the password that GitLab Rails should use to connect to the PostgreSQL server.
-
Save the script below as
/opt/generate-db-config
:#!/opt/gitlab/embedded/bin/ruby require 'yaml' db_password = `echo "toomanysecrets"`.strip # Change the command inside backticks to fetch DB password puts YAML.dump({ 'main' => { 'password' => db_password }, 'ci' => { 'password' => db_password } })
-
Ensure the script created above is executable:
chmod +x /opt/generate-db-config
-
Add the snippet below to
/etc/gitlab/gitlab.rb
:gitlab_rails['db_extra_config_command'] = '/opt/generate-db-config'
-
Run
sudo gitlab-ctl reconfigure
.
Related topics
- Disable impersonation
- Set up LDAP sign-in
- Smartcard authentication
-
Set up NGINX for things like:
- Set up HTTPS
- Redirect
HTTP
requests toHTTPS
- Change the default port and the SSL certificate locations
- Set the NGINX listen-address or addresses
- Insert custom NGINX settings into the GitLab server block
- Insert custom settings into the NGINX configuration
- Enable
nginx_status
- Use a non-packaged web-server
- Use a non-packaged PostgreSQL database management server
- Use a non-packaged Redis instance
- Add
ENV
vars to the GitLab runtime environment - Changing
gitlab.yml
andapplication.yml
settings - Send application email via SMTP
- Set up OmniAuth (Google, Twitter, GitHub login)
- Adjust Puma settings
Troubleshooting
Relative URL troubleshooting
If you notice any issues with GitLab assets appearing broken after moving to a
relative URL configuration (like missing images or unresponsive components),
please raise an issue in GitLab
with the Frontend
label.
Mixlib::ShellOut::ShellCommandFailed: linux_user[GitLab user and group]
When moving the home directory for a user, if the runit service is not stopped and the home directories are not manually moved for the user, GitLab will encounter an error while reconfiguring:
account[GitLab user and group] (gitlab::users line 28) had an error: Mixlib::ShellOut::ShellCommandFailed: linux_user[GitLab user and group] (/opt/gitlab/embedded/cookbooks/cache/cookbooks/package/resources/account.rb line 51) had an error: Mixlib::ShellOut::ShellCommandFailed: Expected process to exit with [0], but received '8'
---- Begin output of ["usermod", "-d", "/var/opt/gitlab", "git"] ----
STDOUT:
STDERR: usermod: user git is currently used by process 1234
---- End output of ["usermod", "-d", "/var/opt/gitlab", "git"] ----
Ran ["usermod", "-d", "/var/opt/gitlab", "git"] returned 8
Make sure to stop runit
before moving the home directory.
GitLab responds with 502 after changing the name of the Git user or group
If you changed the name of the Git user or group on an existing installation, this can cause many side effects.
You can check for errors that relate to files unable to access and try to fix their permissions:
gitlab gitlab-ctl tail -f