2019-02-08 13:24:31 +00:00
---
2021-01-11 15:10:32 +00:00
stage: Enablement
group: Distribution
2020-11-26 06:09:20 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2019-02-08 13:24:31 +00:00
comments: false
---
2021-04-19 18:09:09 +00:00
# Upgrading Community Edition and Enterprise Edition from source **(FREE SELF)**
2019-02-08 13:24:31 +00:00
2020-12-04 21:09:29 +00:00
NOTE:
2020-12-07 18:10:36 +00:00
Users wishing to upgrade to 12.0.0 must take some extra steps. See the
2019-06-18 11:57:10 +00:00
version specific upgrade instructions for 12.0.0 for more details.
2019-02-08 13:24:31 +00:00
Make sure you view this update guide from the branch (version) of GitLab you
2021-08-17 00:10:22 +00:00
would like to install (for example, `11.8` ). You can select the required version of documentation in the dropdown at the top right corner of GitLab documentation page.
2019-02-08 13:24:31 +00:00
2021-08-17 00:10:22 +00:00
In each of the following examples, replace `BRANCH` with the branch of the version you upgrading to (for example, `11-8-stable` for `11.8` ). Replace `PREVIOUS_BRANCH` with the
branch for the version you are upgrading from (for example, `11-7-stable` for `11.7` ).
2019-02-08 13:24:31 +00:00
If the highest number stable branch is unclear please check the
[GitLab Blog ](https://about.gitlab.com/blog/archives.html ) for installation
guide links by version.
2019-05-05 12:17:20 +00:00
If you are changing from GitLab Community Edition to GitLab Enterprise Edition, see
the [Upgrading from CE to EE ](upgrading_from_ce_to_ee.md ) documentation.
2020-01-09 15:07:42 +00:00
## Upgrading to a new major version
Major versions are reserved for backwards incompatible changes. We recommend that
2021-08-17 00:10:22 +00:00
you first upgrade to the latest available minor version of your current major version.
2020-01-09 15:07:42 +00:00
Please follow the [Upgrade Recommendations ](../policy/maintenance.md#upgrade-recommendations )
to identify the ideal upgrade path.
Before upgrading to a new major version, you should ensure that any background
migration jobs from previous releases have been completed. To see the current size of the `background_migration` queue,
2021-02-11 09:09:18 +00:00
[Check for background migrations before upgrading ](index.md#checking-for-background-migrations-before-upgrading ).
2020-01-09 15:07:42 +00:00
2019-02-08 13:24:31 +00:00
## Guidelines for all versions
This section contains all the steps necessary to upgrade Community Edition or
Enterprise Edition, regardless of the version you are upgrading to. Version
specific guidelines (should there be any) are covered separately.
2019-05-15 16:30:30 +00:00
### 1. Backup
2019-02-08 13:24:31 +00:00
2020-12-16 03:09:46 +00:00
If you installed GitLab from source, make sure `rsync` is installed.
2019-02-08 13:24:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:create RAILS_ENV=production
```
2019-05-15 16:30:30 +00:00
### 2. Stop server
2020-01-30 15:09:15 +00:00
```shell
2019-05-15 16:30:30 +00:00
sudo service gitlab stop
```
2019-02-08 13:24:31 +00:00
### 3. Update Ruby
2020-12-16 03:09:46 +00:00
NOTE:
Beginning in GitLab 13.6, we only support Ruby 2.7 or higher, and dropped
2020-11-26 00:09:35 +00:00
support for Ruby 2.6. Be sure to upgrade if necessary.
2019-02-08 13:24:31 +00:00
You can check which version you are running with `ruby -v` .
Download Ruby and compile it:
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
mkdir /tmp/ruby & & cd /tmp/ruby
2020-12-09 06:09:41 +00:00
curl --remote-name --progress "https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz"
2020-11-26 00:09:35 +00:00
echo 'cb9731a17487e0ad84037490a6baf8bfa31a09e8 ruby-2.7.2.tar.gz' | shasum -c - & & tar xzf ruby-2.7.2.tar.gz
cd ruby-2.7.2
2019-02-08 13:24:31 +00:00
2021-04-02 09:09:02 +00:00
./configure --disable-install-rdoc --enable-shared
2019-02-08 13:24:31 +00:00
make
sudo make install
```
2020-01-14 15:07:55 +00:00
### 4. Update Node.js
2019-02-08 13:24:31 +00:00
2021-05-21 09:10:16 +00:00
To check the minimum required Node.js version, see [Node.js versions ](../install/installation.md#software-requirements ).
2019-02-08 13:24:31 +00:00
2020-01-14 15:07:55 +00:00
GitLab also requires the use of Yarn `>= v1.10.0` to manage JavaScript
2019-02-08 13:24:31 +00:00
dependencies.
2020-01-14 15:07:55 +00:00
In Debian or Ubuntu:
2020-01-30 15:09:15 +00:00
```shell
2021-04-27 15:09:52 +00:00
sudo apt-get remove yarn
npm install --global yarn
2019-02-08 13:24:31 +00:00
```
2020-04-04 09:09:16 +00:00
More information can be found on the [Yarn website ](https://classic.yarnpkg.com/en/docs/install ).
2019-02-08 13:24:31 +00:00
### 5. Update Go
2021-05-21 09:10:16 +00:00
To check the minimum required Go version, see [Go versions ](../install/installation.md#software-requirements ).
2019-02-08 13:24:31 +00:00
You can check which version you are running with `go version` .
2020-01-14 15:07:55 +00:00
Download and install Go (for Linux, 64-bit):
2019-02-08 13:24:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
# Remove former Go installation folder
sudo rm -rf /usr/local/go
2020-12-09 06:09:41 +00:00
curl --remote-name --progress "https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz"
2020-01-14 15:07:55 +00:00
echo '512103d7ad296467814a6e3f635631bd35574cab3369a97a323c9a585ccaa569 go1.13.5.linux-amd64.tar.gz' | shasum -a256 -c - & & \
sudo tar -C /usr/local -xzf go1.13.5.linux-amd64.tar.gz
2019-02-08 13:24:31 +00:00
sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/
2020-01-14 15:07:55 +00:00
rm go1.13.5.linux-amd64.tar.gz
2019-02-08 13:24:31 +00:00
```
2019-08-29 08:50:59 +00:00
### 6. Update Git
2019-06-07 07:09:49 +00:00
2020-06-02 00:08:07 +00:00
To check you are running the minimum required Git version, see
2021-05-21 09:10:16 +00:00
[Git versions ](../install/installation.md#software-requirements ).
2020-01-14 15:07:55 +00:00
2021-03-11 06:09:43 +00:00
From GitLab 13.6, we recommend you use the [Git version provided by
Gitaly](https://gitlab.com/gitlab-org/gitaly/-/issues/2729)
that:
2019-06-07 07:09:49 +00:00
2021-03-11 06:09:43 +00:00
- Is always at the version required by GitLab.
- May contain custom patches required for proper operation.
2019-06-07 07:09:49 +00:00
2021-03-11 06:09:43 +00:00
```shell
2019-06-07 07:09:49 +00:00
# Install dependencies
2021-03-11 06:09:43 +00:00
sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev libpcre2-dev build-essential
2019-06-07 07:09:49 +00:00
2021-03-11 06:09:43 +00:00
# Clone the Gitaly repository
git clone https://gitlab.com/gitlab-org/gitaly.git -b < X-Y-stable > /tmp/gitaly
2019-06-07 07:09:49 +00:00
2021-03-11 06:09:43 +00:00
# Compile and install Git
cd /tmp/gitaly
sudo make git GIT_PREFIX=/usr/local
2019-06-07 07:09:49 +00:00
```
2021-03-11 06:09:43 +00:00
Replace `<X-Y-stable>` with the stable branch that matches the GitLab version you want to
install. For example, if you want to install GitLab 13.6, use the branch name `13-6-stable` .
Remember to set `git -> bin_path` to `/usr/local/bin/git` in `config/gitlab.yml` .
2020-09-11 15:08:30 +00:00
### 7. Update PostgreSQL
2020-12-04 21:09:29 +00:00
WARNING:
2021-06-14 18:10:28 +00:00
From GitLab 14.0, you must use at least PostgreSQL 12.
2020-09-11 15:08:30 +00:00
2021-03-10 00:09:13 +00:00
The latest version of GitLab might depend on a more recent PostgreSQL version
2021-08-17 00:10:22 +00:00
than what you are running. You may also have to enable some
2021-03-10 00:09:13 +00:00
extensions. For more information, see the
[PostgreSQL requirements ](../install/requirements.md#postgresql-requirements )
2020-09-11 15:08:30 +00:00
2021-03-10 00:09:13 +00:00
To upgrade PostgreSQL, refer to its [documentation ](https://www.postgresql.org/docs/11/upgrading.html ).
2020-09-11 15:08:30 +00:00
### 8. Get latest code
2019-02-08 13:24:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
sudo -u git -H git fetch --all --prune
2021-03-11 06:09:43 +00:00
sudo -u git -H git checkout -- Gemfile.lock db/structure.sql locale
2019-02-08 13:24:31 +00:00
```
For GitLab Community Edition:
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
sudo -u git -H git checkout BRANCH
```
OR
For GitLab Enterprise Edition:
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
sudo -u git -H git checkout BRANCH-ee
```
2021-03-11 06:09:43 +00:00
### 9. Update configuration files
2019-02-08 13:24:31 +00:00
#### New configuration options for `gitlab.yml`
2021-06-08 18:10:23 +00:00
There might be configuration options available for [`gitlab.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/gitlab.yml.example )).
2020-01-14 15:07:55 +00:00
View them with the command below and apply them manually to your current `gitlab.yml` :
2019-02-08 13:24:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
git diff origin/PREVIOUS_BRANCH:config/gitlab.yml.example origin/BRANCH:config/gitlab.yml.example
```
2019-10-02 12:06:04 +00:00
#### NGINX configuration
2019-02-08 13:24:31 +00:00
Ensure you're still up-to-date with the latest NGINX configuration changes:
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
# For HTTPS configurations
git diff origin/PREVIOUS_BRANCH:lib/support/nginx/gitlab-ssl origin/BRANCH:lib/support/nginx/gitlab-ssl
# For HTTP configurations
git diff origin/PREVIOUS_BRANCH:lib/support/nginx/gitlab origin/BRANCH:lib/support/nginx/gitlab
```
2021-08-17 00:10:22 +00:00
If you are using Strict-Transport-Security in your installation, you must enable it in your
NGINX configuration to continue using it. This is because the GitLab application no longer
sets it.
2019-02-08 13:24:31 +00:00
2020-01-14 15:07:55 +00:00
If you are using Apache instead of NGINX see the updated [Apache templates ](https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server/apache ).
2019-02-08 13:24:31 +00:00
Also note that because Apache does not support upstreams behind Unix sockets you
2020-12-07 18:10:36 +00:00
must let GitLab Workhorse listen on a TCP port. You can do this
2021-06-08 18:10:23 +00:00
via [`/etc/default/gitlab` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/support/init.d/gitlab.default.example#L38 ).
2019-02-08 13:24:31 +00:00
#### SMTP configuration
2020-12-07 18:10:36 +00:00
If you're installing from source and use SMTP to deliver mail, you must
2019-02-08 13:24:31 +00:00
add the following line to `config/initializers/smtp_settings.rb` :
```ruby
ActionMailer::Base.delivery_method = :smtp
```
2021-06-08 18:10:23 +00:00
See [`smtp_settings.rb.sample` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/initializers/smtp_settings.rb.sample#L13 ) as an example.
2019-02-08 13:24:31 +00:00
#### Init script
There might be new configuration options available for
2021-06-08 18:10:23 +00:00
[`gitlab.default.example` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/support/init.d/gitlab.default.example ).
2020-01-14 15:07:55 +00:00
View them with the command below and apply them manually to your current `/etc/default/gitlab` :
2019-02-08 13:24:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
git diff origin/PREVIOUS_BRANCH:lib/support/init.d/gitlab.default.example origin/BRANCH:lib/support/init.d/gitlab.default.example
```
Ensure you're still up-to-date with the latest init script changes:
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab
```
For Ubuntu 16.04.1 LTS:
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
sudo systemctl daemon-reload
```
2021-03-11 06:09:43 +00:00
### 10. Install libraries, migrations, etc
2019-02-08 13:24:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
2021-03-11 06:09:43 +00:00
# If you haven't done so during installation or a previous upgrade already
2021-03-19 09:08:53 +00:00
sudo -u git -H bundle config set --local deployment 'true'
sudo -u git -H bundle config set --local without 'development test mysql aws kerberos'
2021-03-11 06:09:43 +00:00
# Update gems
sudo -u git -H bundle install
2019-02-08 13:24:31 +00:00
# Optional: clean up old gems
sudo -u git -H bundle clean
# Run database migrations
sudo -u git -H bundle exec rake db:migrate RAILS_ENV=production
# Compile GetText PO files
sudo -u git -H bundle exec rake gettext:compile RAILS_ENV=production
# Update node dependencies and recompile assets
2019-05-15 16:30:30 +00:00
sudo -u git -H bundle exec rake yarn:install gitlab:assets:clean gitlab:assets:compile RAILS_ENV=production NODE_ENV=production NODE_OPTIONS="--max_old_space_size=4096"
2019-02-08 13:24:31 +00:00
# Clean up cache
sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production
```
2021-03-11 06:09:43 +00:00
### 11. Update GitLab Shell
```shell
cd /home/git/gitlab-shell
sudo -u git -H git fetch --all --tags --prune
sudo -u git -H git checkout v$(< /home/git/gitlab/GITLAB_SHELL_VERSION)
sudo -u git -H make build
```
### 12. Update GitLab Workhorse
Install and compile GitLab Workhorse.
```shell
cd /home/git/gitlab
sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production
```
### 13. Update Gitaly
#### Compile Gitaly
```shell
cd /home/git/gitaly
sudo -u git -H git fetch --all --tags --prune
sudo -u git -H git checkout v$(< /home/git/gitlab/GITALY_SERVER_VERSION)
sudo -u git -H make
```
### 14. Update GitLab Pages
#### Only needed if you use GitLab Pages
Install and compile GitLab Pages. GitLab Pages uses
[GNU Make ](https://www.gnu.org/software/make/ ).
If you are not using Linux you may have to run `gmake` instead of
`make` below.
```shell
cd /home/git/gitlab-pages
sudo -u git -H git fetch --all --tags --prune
sudo -u git -H git checkout v$(< /home/git/gitlab/GITLAB_PAGES_VERSION)
sudo -u git -H make
```
2020-09-11 15:08:30 +00:00
### 15. Start application
2019-02-08 13:24:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
sudo service gitlab start
sudo service nginx restart
```
2020-09-11 15:08:30 +00:00
### 16. Check application status
2019-02-08 13:24:31 +00:00
Check if GitLab and its environment are configured correctly:
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production
```
To make sure you didn't miss anything run a more thorough check:
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production
```
If all items are green, then congratulations, the upgrade is complete!
## Version specific upgrading instructions
This section contains upgrading instructions for specific versions. When
present, first follow the upgrading guidelines for all versions. If the version
you are upgrading to is not listed here, then no additional steps are required.
<!--
Example:
### 11.8.0
Additional instructions here.
-->
2020-06-08 12:08:26 +00:00
### 13.0.1
As part of [deprecating Rack Attack throttles on Omnibus GitLab ](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/4750 ), Rack Attack initializer on GitLab
was renamed from [`config/initializers/rack_attack_new.rb` to `config/initializers/rack_attack.rb` ](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33072 ).
If this file exists on your installation, consider creating a backup before updating:
```shell
cd /home/git/gitlab
cp config/initializers/rack_attack.rb config/initializers/rack_attack_backup.rb
```
2020-01-14 15:07:55 +00:00
## Troubleshooting
2019-02-08 13:24:31 +00:00
### 1. Revert the code to the previous version
2021-08-17 00:10:22 +00:00
To revert to a previous version, you must follow the upgrading guides
2020-01-14 15:07:55 +00:00
for the previous version.
For example, if you have upgraded to GitLab 12.6 and want to revert back to
2021-08-17 00:10:22 +00:00
12.5, follow the guides for upgrading from 12.4 to 12.5. You can
2019-02-08 13:24:31 +00:00
use the version dropdown at the top of the page to select the right version.
2020-01-14 15:07:55 +00:00
When reverting, you should **not** follow the database migration guides, as the
backup has already been migrated to the previous version.
2019-02-08 13:24:31 +00:00
### 2. Restore from the backup
2020-01-30 15:09:15 +00:00
```shell
2019-02-08 13:24:31 +00:00
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:backup:restore RAILS_ENV=production
```
2020-01-14 15:07:55 +00:00
If you have more than one backup `*.tar` file, add `BACKUP=timestamp_of_backup` to the above.