Skip to main content

Self-hosting GitGuardian

Organizations with advanced security and compliance needs can choose to install GitGuardian Internal Repositories Monitoring on their machines. These can be completely self-hosted or provided by a private cloud service.

This section helps you to install and manage your self-hosted version of GitGuardian.

Self-hosted glossary#

The GitGuardian product includes the following main features in the self-hosted version:

  • The Admin Area is the interface where you can configure the application's preferences, activate features and check your version. You can find more information on how to use it in the Application management section.
  • The KOTS Admin Console is the interface where application administrators can configure, update, manage, backup, restore, and troubleshoot the application. You can find more information on how to use it in the Infrastructure management section.

The KOTS Admin Console is deployed during the installation process unless you choose the Helm installation method.
The Admin area is deployed once the application is installed, regardless of the installation method.

info

GitGuardian is using Replicated to deliver the application to self-hosted environments. Before installing the application, you'll have to choose between two installation types: Embedded and Existing Cluster. You can refer to our decision guide if you have any doubts about the decision.

External components installation#

Some external third-party components are installed during the deployment of GitGuardian self-hosted instances:

Replicated#

Replicated is the service used by GitGuardian to ship its self-hosted service. It allows license management, releases, deployment, troubleshooting and analytics.

An overview of Replicated's security posture can be found at: https://www.replicated.com/resources/files/Replicated-Security-Whitepaper.pdf

KOTS#

KOTS is a kubectl plugin and admin console to help manage Kubernetes Off-The-Shelf software. Replicated proposes a UI-based installation process through KOTS.

During the installation, the KOTS add-on is configured to manage the GitGuardian application. KOTS is open-source, Apache 2 licensed software developed by Replicated.

kURL#

If you use an embedded Kubernetes cluster, you will use kURL. kURL is a Kubernetes installer that installs Kubernetes and some other Kubernetes components. kURL is an open-source, Apache 2 licensed software developed by Replicated.

Helm#

As an alternative to KOTS, we propose an installation based on Helm through Replicated.