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.
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:
Synchronization for KOTS-based installation
GitGuardian may update some information on your license, such as changing the expiration date, modifying the number of seats, etc.
For customers not in an air-gap environment, from the 2025.3.0 release onward, GitGuardian will automatically synchronize the license information with your application. As a result, you no longer need to manually sync your license.
For Airgap Installation, GitGuardian teams will send you the information to upload a new license in the Admin console.
Once the license has been updated (automatically for non-air gap environments), deploy the updated configuration to your instance.
Synchronization for Helm-based installation
With Helm, the license data is provided during the installation or the upgrade.
For customers not in an air-gap environment, from the 2025.3.0 release onward, GitGuardian will automatically synchronize the license information with your application. As a result, you no longer need to manually sync your license after installation or upgrades.
For Airgap Installation, GitGuardian teams will send you the information to upload a new license manually.
If you are using an earlier version and need to sync the license, you would 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.
To find the release name and the version currently installed, use helm ls:
helm ls
NAME UPDATED STATUS CHART APP VERSION
<release-name> 2025-03-20 12:40 deployed gitguardian-2025.3.0 2025.3.0
Here, the version installed is 2025.3.0. To synchronize the license manually, you would run the following command, using the version installed in your environment:
helm upgrade <release-name> -n <namespace> oci://registry.replicated.com/gitguardian/gitguardian --version 2025.3.0 -f local-values.yaml
Replace <release-name> with the name used during the initial installation. If needed, specify the Kubernetes namespace with -n (the default namespace is used if not specified).
