Install GitLab with the Linux package
Offering: Self-managed
Prerequisites
- Installation Requirements.
- If you want to access your GitLab instance via a domain name, like
mygitlabinstance.com
, make sure the domain correctly points to the IP of the server where GitLab is being installed. You can check this using the commandhost mygitlabinstance.com
. - If you want to use HTTPS on your GitLab instance, make sure you have the SSL certificates for the domain ready. (Note that certain components like Container Registry which can have their own subdomains requires certificates for those subdomains also.)
- If you want to send notification emails, install and configure a mail server (MTA) like Sendmail or Postfix. Alternatively, you can use other third party SMTP servers.
Installation and Configuration
These configuration settings are commonly used when configuring a Linux package installation. For a complete list of settings, see the README file.
- Installing GitLab.
- Setting up a domain name/URL for the GitLab Instance so that it can be accessed easily.
- Enabling HTTPS.
- Enabling notification emails.
- Enabling replying via email.
-
Enabling container registry on GitLab.
- You require SSL certificates for the domain used for container registry.
-
Enabling GitLab Pages.
- If you want HTTPS enabled, you must get wildcard certificates.
- Enabling Elasticsearch.
- GitLab Mattermost. Set up the Mattermost messaging app that ships with the Linux package.
- GitLab Prometheus Set up the Prometheus monitoring included in the Linux package.
- GitLab High Availability Roles.
Set up the initial password
- Introduced in GitLab 14.0.
By default, a Linux package installation automatically generates a password for the
initial administrator user account (root
) and stores it to
/etc/gitlab/initial_root_password
for at least 24 hours. For security reasons,
after 24 hours, this file is automatically removed by the first gitlab-ctl reconfigure
.
To provide a custom initial root password, you have two options:
-
Pass the
GITLAB_ROOT_PASSWORD
environment variable to the installation command provided the hostname for the server is set up correctly:sudo GITLAB_ROOT_PASSWORD="<strongpassword>" EXTERNAL_URL="http://gitlab.example.com" apt install gitlab-ee
If during the installation GitLab doesn’t automatically perform a reconfigure, you have to pass the
GITLAB_ROOT_PASSWORD
variable to the firstgitlab-ctl reconfigure
run. -
Before the first reconfigure, edit
/etc/gitlab/gitlab.rb
(create it if it doesn’t exist) and set:gitlab_rails['initial_root_password'] = '<my_strong_password>'
Both of these methods apply only during the initial database seeding, which happens
during the first reconfigure. For subsequent reconfigure runs, neither of
the aforementioned methods have any effect. In that case, use the random
password in /etc/gitlab/initial_root_password
to log in, or
reset the root password.
Using Docker image
You can also use the Docker images provided by GitLab to install and configure a GitLab instance. Check the documentation to know more.
Uninstall the Linux package (Omnibus)
To uninstall the Linux package, you can opt to either keep your data (repositories, database, configuration) or remove all of them:
-
Optional. To remove all users and groups created by the Linux package before removing the package (with
apt
oryum
):sudo gitlab-ctl stop && sudo gitlab-ctl remove-accounts
If you have problems removing accounts or groups, runuserdel
orgroupdel
manually to delete them. You might also want to manually remove the leftover user home directories from/home/
. -
Choose whether to keep your data or remove all of them:
-
To preserve your data (repositories, database, configuration), stop GitLab and remove its supervision process:
sudo systemctl stop gitlab-runsvdir sudo systemctl disable gitlab-runsvdir sudo rm /usr/lib/systemd/system/gitlab-runsvdir.service sudo systemctl daemon-reload sudo systemctl reset-failed sudo gitlab-ctl uninstall
-
To remove all data:
sudo gitlab-ctl cleanse && sudo rm -r /opt/gitlab
-
-
Uninstall the package (replace with
gitlab-ce
if you have GitLab FOSS installed):# Debian/Ubuntu sudo apt remove gitlab-ee # RedHat/CentOS sudo yum remove gitlab-ee