License management

The license file is a crucial component of your GitGuardian self-hosted installation, containing all necessary information for the setup process. This file is essential regardless of the installation method you select.

danger

Handle the license file as sensitive information; it includes credentials for GitGuardian's registry and image repository.

Download

To download the license, you will need 2 pieces of information:

the portal URL, which will usually be sent by email.
the password, which ideally will be sent on a different channel (via SMS for example).

Once connected to the portal, you will be able to download the license file:

Download portal

Synchronization for KOTS-based installation

GitGuardian could update some information on your license. For example, we can change the expiration date, modify the number of seats, etc. In this case, you will need to update the license in the application.

To perform this action, go to the "License" tab of the Admin console, and click on "Sync license".

For Airgap Installation, GitGuardian teams will send you the information to upload a new license in the Admin console.

After synchronizing the license, deploy the updated configuration to your instance.

Deploying the updated configuration

Synchronization for Helm-based installation

With Helm, the license data is provided during the installation or the upgrade. To synchronize it, you need to use the helm upgrade command and specify the same version as the one currently installed, to prevent unwanted upgrades to the latest version.

Get the release name and the version currently installed with helm ls:

helm ls
NAME             UPDATED             STATUS     CHART                   APP VERSION
<release-name>   2024-04-18 12:40    deployed   gitguardian-2024.1.3    2024.11.0

Here the version installed is 2024.11.0. You can now synchronize the license by running the following command, using the version you have in your installation:

helm upgrade <release-name> -n <namespace> oci://registry.replicated.com/gitguardian/gitguardian --version 2024.x.y -f local-values.yaml

Replace <release-name> with the name used during the initial installation. If needed, specify the Kubernetes namespace with -n (default namespace is used if not specified).