October 11-13, 2022

GitKon 2022

GitKraken Client Documentation

Upgrade Self-Hosted GitKraken

The upgrade procedure is the same whether you are running GitKraken Self-Hosted on CentOS, Ubuntu, or RHEL7.


Upgrade Enterprise Server

1. Go to the folder where the previous installation of GitKraken Self-Hosted resides
(the folder that contains the docker-compose.yml).

2. Take down the current instance of GitKraken Self-Hosted:

sudo docker-compose down

3. Back up the docker-compose.yml file.

4. Extract GitKrakenEnterpriseServer.zip in the folder you installed GitKraken Self-Hosted.
This should overwrite your current docker-compose.yml file.

5. Make sure to address any configuration differences between the new docker-compose.yml and the
old docker-compose.yml. This includes:

  • Any public facing port changes.
  • Location of volumes on the host computer.
  • Any environment variable changes.

6. For setups that do not utilize docker-compose, make note of the image names and tags,
and ensure that your swarm manager addresses those changes (an example would be Nomad
setups).

7. Load the images into Docker:

sudo sh loadImages.sh

8. In the same folder containing the docker-compose.yml file, run the following command:

sudo docker-compose up

Note: If server configuration is lost after upgrading, verify that docker-compose up was ran from the same directory as before.

Note: If upgrading in CentOS or RHEL7, you may need to specify the full path to the docker-compose installation. The following commands should allow you to run the docker-compose command successfully:

sudo systemctl start docker.service
sudo /usr/local/bin/docker-compose up

Upgrade Enterprise Clients

1. Open your docker-compose.yml file where you installed GitKraken Self-Hosted.

2. Locate the gk-enterprise-controller service. Under volumes, there should be a volume:

-./gk-data/release:/controller/release # The volume where GitKraken Self-Hosted clients go.

3. We can divide this line into 2 distinct parts by separating at the ":".
The first half in our example is ./gk-data/release and the second half is /enterprise/release.
The first half represents where the clients are located on your host machine, and it may be different
than this example.

4. Navigate to the folder where the clients are stored. Extract release.zip and overwrite all data in that
folder at the top level.

5. When you have completed extracting the zip, in our example, our release folder will have the following shape:

./gk-data/
   └── release/
       ├── linux/
       ├── darwin/
       ├── win32/
       └── win64/

6. Users of GitKraken Self-Hosted should now start receiving the latest client.

Update License

If you need to update your GitKraken Self-Hosted license, you will first need to copy the license.dat file over to your GitKraken Self-Hosted server. Then, select the new license by going to the License tab on your Enterprise site. From here you can browse to the new license file:

Reset the Super User Password

Follow these steps to reset the Super User password.

Shutdown GitKraken Self-Hosted by running:

sudo docker-compose down

Set the gk-services environment variable SUPER_USER_RESET to 1 in the docker-compose.yml file.

environment:
  SUPER_USER_RESET: 1

Restart GitKraken Self-Hosted by running:

sudo docker-compose up

On the account site, visit /reset/super-user and provide the new password.

After resetting the super user, verify that you can login as the super user.

Once login is verified, you need to restart without the reset flag. Shutdown GitKraken Self-Hosted by running:

sudo docker-compose down

Delete the SUPER_USER_RESET environment variable from gk-services in the docker-compose.yml.

Restart GitKraken Self-Hosted by running:

sudo docker-compose up
Have feedback about this article? Did we miss something? Let us know!
On this page