# GitGuardian Documentation

> GitGuardian is a code security platform that detects and remediates secrets (API keys, passwords, certificates) leaked in source code across the entire Software Development Lifecycle.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [API Reference](https://docs.gitguardian.com/api-docs/api-reference.md): Links to the GitGuardian API reference documentation and notes the base URL differences for self-hosted instances.
- [Authentication](https://docs.gitguardian.com/api-docs/authentication.md): How the GitGuardian API authenticates requests using API keys, covering service accounts, personal access tokens, and permission scopes.
- [Introduction](https://docs.gitguardian.com/api-docs/introduction.md): Overview of the GitGuardian API, its use cases for managing dashboard data, using the secrets detection engine, and key limitations.
- [Pagination](https://docs.gitguardian.com/api-docs/pagination.md): Explains cursor-based pagination for navigating large datasets returned by the GitGuardian API, with examples in Python and Bash.
- [Personal access tokens](https://docs.gitguardian.com/api-docs/personal-access-tokens.md): How to create and manage personal access tokens for authenticating with the GitGuardian API and ggshield on local workstations.
- [Service accounts](https://docs.gitguardian.com/api-docs/service-accounts.md): How to create and manage service accounts, non-human API keys for automated scenarios like CI pipeline scanning, on the Business plan.
- [Usage and quotas](https://docs.gitguardian.com/api-docs/usage-and-quotas.md): GitGuardian API usage details including stateless scanning, quota limits per plan, monthly quota calculations, and rate limiting.
- [Authentication](https://docs.gitguardian.com/ggmcp-docs/authentication.md): Configure authentication for the GitGuardian MCP server using OAuth, personal access tokens, or authorization headers.
- [Installation](https://docs.gitguardian.com/ggmcp-docs/installation.md): Install the GitGuardian MCP server in Cursor, Claude Desktop, Windsurf, or Zed.
- [Overview](https://docs.gitguardian.com/ggmcp-docs/overview.md): Learn what the GitGuardian MCP Server is, what tools it provides, and how it fits into your AI-assisted development workflow.
- [Security](https://docs.gitguardian.com/ggmcp-docs/security.md): Security model of the GitGuardian MCP server — read-only permissions, server-side scanning, and secret redaction.
- [Tools reference](https://docs.gitguardian.com/ggmcp-docs/tools-reference.md): Full list of Developer tools available through the GitGuardian MCP server.
- [Deploy and configure ggscout](https://docs.gitguardian.com/ggscout-docs/configure-ggscout.md): Guide to deploying and configuring ggscout as a CLI binary, Docker container, or Kubernetes Helm chart, including GitGuardian authentication setup.
- [Configure integrations](https://docs.gitguardian.com/ggscout-docs/configure-integrations.md): How to configure ggscout integration sources in the TOML configuration file, including modes, environment variables, and filtering.
- [GitHub Actions Integration](https://docs.gitguardian.com/ggscout-docs/integrations/github-actions.md): Guide to configuring ggscout to inventory GitHub Actions secrets for NHI governance.
- [GitLab Integration](https://docs.gitguardian.com/ggscout-docs/integrations/gitlab-ci.md): Guide to configuring ggscout to collect and inventory CI/CD variables from GitLab instances for secret monitoring.
- [Kubernetes](https://docs.gitguardian.com/ggscout-docs/integrations/infrastructure/kubernetes.md): Configure ggscout to collect secrets from Kubernetes clusters, supporting Secrets, ConfigMaps, Deployments, and Service Accounts.
- [Akeyless](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers/akeyless.md): Guide to configuring ggscout to collect and monitor secrets from Akeyless using API key authentication.
- [AWS Secrets Manager](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers/aws-secrets-manager.md): Guide to configuring ggscout to collect and monitor secrets from AWS Secrets Manager, including authentication and region configuration.
- [Azure Key Vault](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers/azure-key-vault.md): Guide to configuring ggscout to collect and monitor secrets from Azure Key Vault, including authentication methods and filtering options.
- [CyberArk Secrets Manager SaaS](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers/cyberark-secrets-manager-saas.md): Guide to configuring ggscout to collect and monitor secrets from CyberArk Secrets Manager SaaS, with multiple authentication modes.
- [CyberArk Secrets Manager Self-Hosted](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers/cyberark-secrets-manager-self-hosted.md): Configure ggscout to collect and monitor secrets from CyberArk Secrets Manager Self-Hosted (Conjur) with user and API authentication.
- [Delinea Secret Server](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers/delinea-secret-server.md): Guide to configuring ggscout to collect and monitor secrets from Delinea Secret Server using OAuth authentication.
- [Google Secret Manager](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers/google-secret-manager.md): Configure ggscout to collect and monitor secrets from Google Secret Manager with service account and Workload Identity authentication.
- [HashiCorp Vault](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers/hashicorp-vault.md): Guide to configuring ggscout to collect and monitor secrets from HashiCorp Vault, including KV1/KV2 engines, namespace filtering, and HCD support.
- [Secrets Managers integrations](https://docs.gitguardian.com/ggscout-docs/integrations/secret-managers.md): GitGuardian integrates with Secrets Managers through ggscout, enabling you to synchronize secrets incidents with secrets stored in your Secrets Man...
- [Integrations](https://docs.gitguardian.com/ggscout-docs/integrations.md): Overview of all ggscout integration types including secrets managers, CI/CD systems, and infrastructure sources, with their read/write capabilities.
- [ggscout for self-hosted installations](https://docs.gitguardian.com/ggscout-docs/self-hosted-configuration.md): Explains how to deploy and configure ggscout alongside a GitGuardian self-hosted instance using the provided Helm chart.
- [Secret synchronization](https://docs.gitguardian.com/ggscout-docs/sync-secrets.md): The ggscout sync-secrets command that writes unvaulted secrets from GitGuardian into configured secrets managers for remediation.
- [What is ggscout?](https://docs.gitguardian.com/ggscout-docs/what-is-ggscout.md): Introduces ggscout, a CLI tool that collects and hashes secrets from secrets managers and reconciles them with GitGuardian-detected leaks.
- [Configuration](https://docs.gitguardian.com/ggshield-docs/configuration.md): Configure ggshield via CLI options, environment variables, and config files, and how settings interact with the GitGuardian dashboard.
- [Getting started](https://docs.gitguardian.com/ggshield-docs/getting-started.md): Guide to installing and configuring ggshield, the GitGuardian CLI application that detects over 400 types of secrets in local and CI environments.
- [Secret scanning for AI coding tools](https://docs.gitguardian.com/ggshield-docs/integrations/ai-coding-tools/secret-scanning-for-ai-coding-tools.md): Set up ggshield to detect and block secrets in AI coding tool interactions, including prompts, commands, and file reads in Cursor, Claude Code, Cod...
- [Azure pipelines](https://docs.gitguardian.com/ggshield-docs/integrations/cicd-integrations/azure-pipelines.md): Step-by-step guide to integrating ggshield secret scanning into Azure Pipelines using the GitGuardian Docker image.
- [Bitbucket pipelines](https://docs.gitguardian.com/ggshield-docs/integrations/cicd-integrations/bitbucket-pipelines.md): Step-by-step guide to integrating ggshield secret scanning into Bitbucket Pipelines using the GitGuardian Docker image.
- [CircleCI](https://docs.gitguardian.com/ggshield-docs/integrations/cicd-integrations/circle-ci.md): Step-by-step guide to integrating ggshield secret scanning into CircleCI using the ggshield-orb.
- [Drone CI](https://docs.gitguardian.com/ggshield-docs/integrations/cicd-integrations/drone-ci.md): Step-by-step guide to integrating ggshield secret scanning into Drone CI pipelines using the GitGuardian Docker image.
- [GitHub Actions](https://docs.gitguardian.com/ggshield-docs/integrations/cicd-integrations/github-actions.md): Integrate ggshield secret scanning into GitHub Actions CI/CD workflows.
- [GitLab pipelines](https://docs.gitguardian.com/ggshield-docs/integrations/cicd-integrations/gitlab-pipelines.md): Step-by-step guide to integrating ggshield secret scanning into GitLab CI/CD pipelines using the GitGuardian Docker image.
- [Jenkins CI](https://docs.gitguardian.com/ggshield-docs/integrations/cicd-integrations/jenkins-ci.md): Step-by-step guide to integrating ggshield secret scanning into Jenkins CI pipelines using the GitGuardian Docker image.
- [Travis CI](https://docs.gitguardian.com/ggshield-docs/integrations/cicd-integrations/travis-ci.md): Step-by-step guide to integrating ggshield secret scanning into Travis CI pipelines.
- [Docker images](https://docs.gitguardian.com/ggshield-docs/integrations/docker/docker_image.md): `ggshield` docker scanning tool (`ggshield secret scan docker`) is used to
- [Pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit.md): Set up ggshield as a pre-commit git hook to detect secrets before they are committed.
- [Pre-push](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-push.md): Explains how to set up a ggshield pre-push git hook to scan commits for secrets before they are pushed to a remote repository.
- [Pre-receive](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-receive.md): Explains how to set up a ggshield pre-receive hook on self-managed VCS instances to reject commits containing secrets before they are pushed.
- [Antigravity Extension](https://docs.gitguardian.com/ggshield-docs/integrations/ide-integrations/antigravity.md): Guide to installing and configuring the GitGuardian Antigravity extension for real-time secret detection in the Antigravity IDE.
- [Cursor Extension](https://docs.gitguardian.com/ggshield-docs/integrations/ide-integrations/cursor.md): Guide to installing and configuring the GitGuardian Cursor extension for real-time secret detection in the Cursor IDE.
- [Visual Studio Code Extension](https://docs.gitguardian.com/ggshield-docs/integrations/ide-integrations/vscode.md): Guide to installing and configuring the GitGuardian Visual Studio Code extension for real-time secret detection in VS Code.
- [Windsurf Extension](https://docs.gitguardian.com/ggshield-docs/integrations/ide-integrations/windsurf.md): Guide to installing and configuring the GitGuardian Windsurf extension for real-time secret detection in the Windsurf IDE.
- [Scanning Other Data Sources for Secrets](https://docs.gitguardian.com/ggshield-docs/integrations/other-data-sources/other-data-sources.md): Describes the ggshield docset input format for scanning non-git data sources like messaging systems and wikis using the secret scan docset command.
- [Overview](https://docs.gitguardian.com/ggshield-docs/integrations/overview.md): Overview of all ggshield integration options including IDE extensions, CI/CD pipelines, git hooks, Docker image scanning, and other data sources.
- [Detect code leakage on public GitHub](https://docs.gitguardian.com/honeytoken/code-leakage.md): Explains how GitGuardian detects when honeytokens are publicly exposed on GitHub and tags them accordingly for quick identification.
- [Configure your alerts](https://docs.gitguardian.com/honeytoken/configure-alerts.md): Describes how to configure email notifications, Slack and Microsoft Teams alerts, and custom webhooks for honeytoken trigger events.
- [Core concepts](https://docs.gitguardian.com/honeytoken/core-concepts.md): Introduces honeytokens as decoy credentials that detect unauthorized access, with use cases and recommended placement strategies.
- [Deployment jobs](https://docs.gitguardian.com/honeytoken/deploy-honeytokens/deployment-jobs.md): Deployment jobs enable the efficient dissemination of honeytokens across multiple code repositories by creating pull requests to insert honeytoken ...
- [Deployment methods](https://docs.gitguardian.com/honeytoken/deploy-honeytokens/deployment-methods.md): Available methods for deploying honeytokens: automated deployment jobs, manual insertion, and custom scripts via the GitGuardian API.
- [Monitor the deployment of your honeytokens](https://docs.gitguardian.com/honeytoken/deploy-honeytokens/monitor.md): Track and monitor the deployment status of your honeytokens across git repositories integrated with GitGuardian.
- [Troubleshoot sources for Deployment jobs](https://docs.gitguardian.com/honeytoken/deploy-honeytokens/troubleshoot-sources-deployment-jobs.md): Troubleshoot source selection issues in honeytoken deployment jobs, including eligibility criteria and VCS-specific requirements.
- [Frequently Asked Questions](https://docs.gitguardian.com/honeytoken/frequently-asked-questions.md): Common questions about GitGuardian honeytokens, including how they differ from honeypots, supported types, and deployment best practices.
- [Getting started](https://docs.gitguardian.com/honeytoken/getting-started.md): Walks through creating, deploying, and testing your first honeytoken using the GitGuardian dashboard and AWS CLI.
- [Manage your population of honeytokens](https://docs.gitguardian.com/honeytoken/manage.md): Explains how to view, filter, and manage your population of honeytokens in the GitGuardian dashboard, including tagging and honeytoken limits.
- [Respond to a triggered honeytoken](https://docs.gitguardian.com/honeytoken/respond.md): Covers the honeytoken lifecycle and how to respond to a triggered honeytoken by resetting it or revoking it.
- [Honeytoken for self-hosted installations](https://docs.gitguardian.com/honeytoken/self-hosted.md): Enable and configure the Honeytoken feature on self-hosted GitGuardian installations.
- [Understand honeytoken events and trigger mechanism](https://docs.gitguardian.com/honeytoken/understand-events.md): Describes honeytoken events, the trigger mechanism, event data and tags, event states, and IP rules for enriching and managing events.
- [Analytics](https://docs.gitguardian.com/internal-monitoring/analytics.md): Internal Monitoring analytics covering protection coverage, leak detection, remediation tracking, and prevention effectiveness.
- [Collaboration between Application Security and development teams](https://docs.gitguardian.com/internal-monitoring/core-concepts/collaboration-between-appsecs-and-devs.md): Describes the Application Security Shared Responsibility Model and how GitGuardian enables collaboration between security and development teams.
- [How Internal Monitoring works](https://docs.gitguardian.com/internal-monitoring/core-concepts/how-internal-monitoring-works.md): How Internal Monitoring integrates with sources via APIs, webhooks, and native integrations to detect secrets in real-time and historically.
- [Incident statuses](https://docs.gitguardian.com/internal-monitoring/detect/incident-statuses.md): Understand the lifecycle of secret incidents in internal monitoring, including Triggered, Assigned, Resolved, and Ignored statuses.
- [Secrets incidents](https://docs.gitguardian.com/internal-monitoring/detect/secrets-incidents.md): Defines what a secret incident is in GitGuardian Internal Monitoring and explains why hardcoded secrets represent a security threat.
- [Secrets occurrences](https://docs.gitguardian.com/internal-monitoring/detect/secrets-occurrences.md): Understand how GitGuardian groups multiple detections of the same secret into a single incident with individual occurrences.
- [Export data](https://docs.gitguardian.com/internal-monitoring/export-data.md): Export secret incident data as CSV reports with options for filtering, secret visibility, and report formats.
- [Bring Your Own Sources](https://docs.gitguardian.com/internal-monitoring/integrate-sources/bring-your-own-sources.md): Extend GitGuardian secret detection to custom data sources beyond native integrations using ggshield, scripts, or automation tools via the API.
- [Integrate Amazon ECR](https://docs.gitguardian.com/internal-monitoring/integrate-sources/container-registries-integrations/amazon-ecr.md): Set up and configure the Amazon ECR integration with GitGuardian to scan container images for exposed secrets using IAM roles.
- [Integrate Azure Container Registry](https://docs.gitguardian.com/internal-monitoring/integrate-sources/container-registries-integrations/azure-container-registry.md): Integrate Azure Container Registry with GitGuardian to scan container images for exposed secrets using a scoped read-only token.
- [Integrate Docker Hub](https://docs.gitguardian.com/internal-monitoring/integrate-sources/container-registries-integrations/docker-hub.md): Integrate Docker Hub with GitGuardian to scan container images for exposed secrets using a read-only personal access token.
- [Integrate Google Artifact Registry](https://docs.gitguardian.com/internal-monitoring/integrate-sources/container-registries-integrations/google-artifact-registry.md): Integrate Google Artifact Registry with GitGuardian to scan container images for exposed secrets using a GCP service account.
- [Integrate JFrog Container Registry](https://docs.gitguardian.com/internal-monitoring/integrate-sources/container-registries-integrations/jfrog-container-registry.md): Integrate JFrog Container Registry with GitGuardian to scan container images and build artifacts for exposed secrets.
- [Integrate Red Hat Quay](https://docs.gitguardian.com/internal-monitoring/integrate-sources/container-registries-integrations/red-hat-quay.md): Integrate Red Hat Quay with GitGuardian to scan container images for exposed secrets using OAuth2 authentication.
- [Integrate Confluence Cloud](https://docs.gitguardian.com/internal-monitoring/integrate-sources/documentation-integrations/confluence-cloud.md): Integrate Confluence Cloud with GitGuardian via OAuth2 to scan pages, blog posts, and comments for exposed secrets.
- [Integrate Confluence Data Center](https://docs.gitguardian.com/internal-monitoring/integrate-sources/documentation-integrations/confluence-data-center.md): Integrate Confluence Data Center with GitGuardian to scan pages, blog posts, and comments for exposed secrets.
- [Integrate Microsoft OneDrive](https://docs.gitguardian.com/internal-monitoring/integrate-sources/documentation-integrations/microsoft-onedrive.md): Integrate Microsoft OneDrive for Business with GitGuardian to scan user files and shared documents for exposed secrets.
- [Integrate Microsoft SharePoint Online](https://docs.gitguardian.com/internal-monitoring/integrate-sources/documentation-integrations/microsoft-sharepoint-online.md): Integrate Microsoft SharePoint Online with GitGuardian to scan documents, pages, and shared files for exposed secrets.
- [Integrate Microsoft Teams](https://docs.gitguardian.com/internal-monitoring/integrate-sources/messaging-integrations/microsoft-teams.md): Guide to integrating Microsoft Teams with GitGuardian to monitor channel messages and file attachments for exposed secrets.
- [Integrate Slack](https://docs.gitguardian.com/internal-monitoring/integrate-sources/messaging-integrations/slack.md): Monitor Slack workspaces for exposed secrets in channel messages and team discussions.
- [Manage your monitored perimeter](https://docs.gitguardian.com/internal-monitoring/integrate-sources/monitored-perimeter.md): Manage your monitored perimeter: source statuses, scanning types, visibility, criticality settings, and connectivity troubleshooting.
- [Sources Integration Overview](https://docs.gitguardian.com/internal-monitoring/integrate-sources/overview.md): All source integrations for Internal Monitoring: VCS, container registries, messaging, documentation, ticketing, and custom sources.
- [Integrate JFrog Package Registries (beta)](https://docs.gitguardian.com/internal-monitoring/integrate-sources/package-registries-integrations/jfrog-package-registry.md): Integrate JFrog Package Registries with GitGuardian to scan package artifacts across Maven, npm, PyPI, NuGet, Go, Gradle, and more for exposed secr...
- [Secrets Managers integrations](https://docs.gitguardian.com/internal-monitoring/integrate-sources/secrets-managers-integrations/overview.md): How ggscout integrates with secrets managers to match vaulted secrets against detected incidents for prioritization and remediation.
- [Integrate Jira Cloud](https://docs.gitguardian.com/internal-monitoring/integrate-sources/ticketing-integrations/jira-cloud.md): Integrate Jira Cloud with GitGuardian via a Jira Cloud app to monitor issue descriptions and comments for exposed secrets.
- [Integrate Jira Data Center](https://docs.gitguardian.com/internal-monitoring/integrate-sources/ticketing-integrations/jira-data-center.md): Integrate Jira Data Center with GitGuardian to monitor issue descriptions, comments, and project documentation for exposed secrets.
- [Integrate ServiceNow](https://docs.gitguardian.com/internal-monitoring/integrate-sources/ticketing-integrations/servicenow.md): Integrate ServiceNow with GitGuardian to monitor tickets, knowledge articles, and service management workflows for exposed secrets.
- [Integrate Azure DevOps](https://docs.gitguardian.com/internal-monitoring/integrate-sources/vcs-integrations/azure-repos.md): Integrate Azure DevOps Repos with GitGuardian at the instance or organization level to monitor repositories for exposed secrets.
- [Integrate Bitbucket Cloud](https://docs.gitguardian.com/internal-monitoring/integrate-sources/vcs-integrations/bitbucket-cloud.md): Integrate Bitbucket Cloud with GitGuardian to monitor repositories for exposed secrets using an API token with workspace-level access.
- [Integrate Bitbucket Data Center/Server](https://docs.gitguardian.com/internal-monitoring/integrate-sources/vcs-integrations/bitbucket.md): Integrate Bitbucket Data Center/Server with GitGuardian at the instance or project level to monitor repositories for exposed secrets.
- [Integrate Gerrit](https://docs.gitguardian.com/internal-monitoring/integrate-sources/vcs-integrations/gerrit.md): Monitor Gerrit repositories for exposed secrets via historical scanning, with optional real-time detection using the Gerrit webhook plugin.
- [Integrate GitHub Enterprise Server](https://docs.gitguardian.com/internal-monitoring/integrate-sources/vcs-integrations/github-enterprise.md): Integrate GitHub Enterprise Server with GitGuardian by creating a dedicated GitHub App to monitor repositories for exposed secrets.
- [Integrate GitHub](https://docs.gitguardian.com/internal-monitoring/integrate-sources/vcs-integrations/github.md): Integrate GitHub with GitGuardian via the GitHub App to monitor repositories for exposed secrets with real-time and historical scanning.
- [Integrate GitLab](https://docs.gitguardian.com/internal-monitoring/integrate-sources/vcs-integrations/gitlab.md): Integrate GitLab with GitGuardian using system hooks or group hooks to monitor repositories for exposed secrets.
- [Block secrets from the VCS](https://docs.gitguardian.com/internal-monitoring/prevent/block-secrets-from-entering-vcs.md): Use ggshield with pre-receive git hooks to block secrets from reaching shared repositories on self-hosted GitHub or GitLab instances.
- [Detect secrets in CI pipelines](https://docs.gitguardian.com/internal-monitoring/prevent/detect-secrets-in-ci-cd-pipelines.md): Integrate ggshield into CI/CD pipelines to detect hardcoded secrets and raise developer awareness around credential leaks.
- [Detect secrets in GitHub PRs](https://docs.gitguardian.com/internal-monitoring/prevent/detect-secrets-in-real-time-in-github.md): Describes how GitGuardian GitHub Check Runs detect secrets in pull requests and how to configure check run conclusions and per-repository settings.
- [Detect secrets on developer workstations](https://docs.gitguardian.com/internal-monitoring/prevent/detect-secrets-on-workstations.md): Use ggshield with git hooks to detect secrets on developer workstations before they reach shared repositories.
- [Overview](https://docs.gitguardian.com/internal-monitoring/prevent/overview.md): Explains the shift-left approach to secrets detection and why organizations should use both ggshield CLI and VCS integrations for layered security.
- [Bulk actions on incidents](https://docs.gitguardian.com/internal-monitoring/remediate/bulk-actions.md): Use bulk actions to perform status changes, assignments, tagging, and sharing across multiple incidents simultaneously.
- [Investigate incidents](https://docs.gitguardian.com/internal-monitoring/remediate/investigate-incidents.md): Investigate secret incidents using risk scoring, presence checks, leak checks, secret manager insights, and ML-powered grouping.
- [Prioritize incidents](https://docs.gitguardian.com/internal-monitoring/remediate/prioritize-incidents.md): Prioritize secret incidents using the incidents table, saved views, severity scoring, validity checks, tags, and ML-powered risk scores.
- [Remediate incidents](https://docs.gitguardian.com/internal-monitoring/remediate/remediate-incidents.md): Platform features for remediating secret incidents: developer collaboration, workflow customization, and direct secret revocation.
- [Secret Remediation Overview](https://docs.gitguardian.com/internal-monitoring/remediate/remediation-overview.md): GitGuardian's remediation philosophy and recommended six-step approach for addressing secret incidents while maintaining operational continuity.
- [Historical incidents](https://docs.gitguardian.com/internal-monitoring/remediate/remediation-scenarios/historical-incidents.md): Step-by-step workflow for triaging and remediating historical secret incidents, including handling orphan incidents from departed developers.
- [Remediation scenarios and workflows](https://docs.gitguardian.com/internal-monitoring/remediate/remediation-scenarios/overview.md): Different remediation scenarios including emergency response, real-time, historical, and bulk workflows with guidance for choosing the right approach.
- [Real-time incidents](https://docs.gitguardian.com/internal-monitoring/remediate/remediation-scenarios/realtime-incidents.md): How to establish remediation processes for real-time secret incidents by involving developers through external sharing or workspace membership.
- [AWS IAM Integration](https://docs.gitguardian.com/nhi-governance/aws-iam-integration.md): Integrate AWS IAM with GitGuardian NHI Governance using OIDC authentication to enrich the security graph with comprehensive permission context.
- [Microsoft Entra Integration](https://docs.gitguardian.com/nhi-governance/azure-entra-integration.md): Integrate Microsoft Entra ID with GitGuardian NHI Governance to collect identity, permission, and credential data using Workload Identity Federation.
- [Core concepts](https://docs.gitguardian.com/nhi-governance/core-concepts.md): Understand Non-Human Identities (NHIs), why they matter for security, and how GitGuardian helps manage their lifecycle and access.
- [Discover your NHIs](https://docs.gitguardian.com/nhi-governance/discover-your-nhis.md): Describes the NHI inventory for discovering and exploring Non-Human Identities, including ownership management and the visual exploration map.
- [Assess and improve your NHI security posture](https://docs.gitguardian.com/nhi-governance/improve-your-posture.md): NHI Governance security policies to assess your posture, including checks for leaked, reused, duplicated, and long-lived secrets.
- [Integrate your NHI sources](https://docs.gitguardian.com/nhi-governance/integrate-your-sources.md): Lists the supported NHI Governance integrations including secrets managers, CI/infrastructure sources, cloud IAM systems, and identity providers.
- [Track your performance](https://docs.gitguardian.com/nhi-governance/track-your-performance.md): NHI Governance analytics dashboard covering posture management trends, secret hygiene metrics, and secrets incident tracking.
- [AI Management Policy](https://docs.gitguardian.com/platform/ai/ai-management-policy.md): GitGuardian's AI Management Policy: governance, security measures, ethical standards, data usage, compliance, and AI features catalog.
- [AI-Powered Features](https://docs.gitguardian.com/platform/ai/ai-powered-features.md): Detailed breakdown of GitGuardian's AI-powered capabilities: false positive detection, risk scoring, secret enrichment, similar issues, and the Git...
- [AI Settings](https://docs.gitguardian.com/platform/ai/ai-settings.md): Configure workspace-level AI controls: enable or disable external LLM calls, set up Bring Your Own Cloud (BYOC), and manage how AI features use thi...
- [BYOC: AWS Bedrock](https://docs.gitguardian.com/platform/ai/byoc-aws-bedrock.md): Configure GitGuardian to use your own AWS Bedrock account for LLM-powered features via OIDC federation.
- [Why enable third-party LLMs](https://docs.gitguardian.com/platform/ai/why-enable-third-party-llms.md): Enabling third-party LLMs in your workspace unlocks significantly better AI-powered features across GitGuardian.
- [Internal Monitoring](https://docs.gitguardian.com/platform/analytics/internal-monitoring.md): Detailed analytics for Internal Monitoring across four security dimensions: protect, detect, remediate, and prevent.
- [Overview](https://docs.gitguardian.com/platform/analytics/overview.md): Analytics dashboard providing KPIs on security posture across protection, detection, remediation, and governance dimensions.
- [GitGuardian Assistant](https://docs.gitguardian.com/platform/assistant/overview.md): :::info
- [Data security and privacy](https://docs.gitguardian.com/platform/assistant/security.md): :::warning[Alpha]
- [Assistant tools reference](https://docs.gitguardian.com/platform/assistant/tools-reference.md): :::warning[Alpha]
- [Available playbooks](https://docs.gitguardian.com/platform/automate-with-playbooks/available-playbooks.md): Available GitGuardian playbooks: notifying developers, sending reminders, severity auto-assignment, and auto-closing ignored incidents.
- [Automate with playbooks](https://docs.gitguardian.com/platform/automate-with-playbooks/playbooks-overview.md): Overview of GitGuardian playbooks for automating incident response workflows such as developer notification and severity management.
- [Custom tags](https://docs.gitguardian.com/platform/collaboration-and-sharing/custom-tags.md): Create and manage custom tags to organize and categorize secret incidents in the GitGuardian dashboard.
- [Incident permissions and sharing](https://docs.gitguardian.com/platform/collaboration-and-sharing/incident-permissions-and-sharing.md): Configure incident access permissions and share incidents externally with developers who are not workspace members.
- [Saved views](https://docs.gitguardian.com/platform/collaboration-and-sharing/saved-views.md): Create and manage saved views to filter and organize secret incidents in the GitGuardian dashboard.
- [Search and filter](https://docs.gitguardian.com/platform/collaboration-and-sharing/search-and-filter.md): Use the GitGuardian search bar to filter incidents, sources, and audit logs by value, commit author, file path, raw text, or natural language.
- [Create and manage teams](https://docs.gitguardian.com/platform/collaboration-and-sharing/teams.md): Organize workspace members into teams with scoped access to specific incident perimeters for collaborative secrets management.
- [Add and manage users](https://docs.gitguardian.com/platform/collaboration-and-sharing/users.md): Invite and manage users in your GitGuardian workspace via email, SSO Just-In-Time provisioning, or SCIM.
- [Configure real-time alerting and notifications for your perimeter](https://docs.gitguardian.com/platform/configure-alerting/alerting-and-notifications.md): Overview of GitGuardian's alerting system, including notification types, delivery channels, and integration options for incident management.
- [Jira Cloud](https://docs.gitguardian.com/platform/configure-alerting/issue-tracking-integrations/jira-cloud.md): Configure Jira Cloud integration with GitGuardian for automatic incident ticket creation and bi-directional status synchronization.
- [Jira Data Center](https://docs.gitguardian.com/platform/configure-alerting/issue-tracking-integrations/jira-data-center.md): Configure Jira Data Center integration with GitGuardian for automatic incident ticket creation and bi-directional status synchronization.
- [ServiceNow](https://docs.gitguardian.com/platform/configure-alerting/issue-tracking-integrations/servicenow.md): Configure ServiceNow integration with GitGuardian for automatic incident ticket creation and bi-directional status synchronization.
- [Custom webhook](https://docs.gitguardian.com/platform/configure-alerting/notifiers-integrations/custom-webhook.md): Configure custom webhook notifications to forward GitGuardian incident events to any HTTP endpoint.
- [Discord](https://docs.gitguardian.com/platform/configure-alerting/notifiers-integrations/discord.md): Configure Discord notifications for GitGuardian secrets incidents using a webhook URL.
- [Email alerting](https://docs.gitguardian.com/platform/configure-alerting/notifiers-integrations/email-alerting.md): Configure email notification preferences for GitGuardian secrets incidents and workspace alerts.
- [Microsoft Teams](https://docs.gitguardian.com/platform/configure-alerting/notifiers-integrations/microsoft-teams.md): Configure Microsoft Teams notifications for GitGuardian incident lifecycle events, public monitoring, and honeytoken alerts.
- [PagerDuty](https://docs.gitguardian.com/platform/configure-alerting/notifiers-integrations/pagerduty.md): Configure PagerDuty integration to receive GitGuardian incident alerts through PagerDuty's Events API.
- [Slack](https://docs.gitguardian.com/platform/configure-alerting/notifiers-integrations/slack.md): Configure Slack notifications for GitGuardian secrets incidents, including channel routing and alert customization.
- [Splunk](https://docs.gitguardian.com/platform/configure-alerting/notifiers-integrations/splunk.md): Configure Splunk integration to forward GitGuardian incident events via HTTP Event Collector.
- [Overview](https://docs.gitguardian.com/platform/deployment-model/deployment-models.md): Overview of GitGuardian's deployment options including SaaS, self-hosted, and hybrid architectures with the ggbridge relay.
- [GitGuardian Bridge](https://docs.gitguardian.com/platform/deployment-model/ggbridge.md): Describes ggbridge, a secure relay that enables GitGuardian SaaS to scan self-hosted VCS repositories without exposing them to the internet.
- [Self-Hosted](https://docs.gitguardian.com/platform/deployment-model/self-hosted.md): How GitGuardian self-hosted deployment works, including communication architecture between the on-premise application and cloud services.
- [Audit log](https://docs.gitguardian.com/platform/enterprise-administration/audit-log.md): Review the centralized stream of user activity on your GitGuardian workspace to investigate suspicious behavior and security issues.
- [Manage email domain](https://docs.gitguardian.com/platform/enterprise-administration/email-domain-management.md): Reserve email domains for your GitGuardian workspace to control user registration and enforce SSO.
- [IP allowlist for workspace access](https://docs.gitguardian.com/platform/enterprise-administration/ip-allowlist.md): Restrict access to your GitGuardian workspace to specific IP addresses or CIDR ranges.
- [Configure SAML SSO](https://docs.gitguardian.com/platform/enterprise-administration/saml-sso-configuration.md): Configure SAML-based Single Sign-On for your GitGuardian workspace, including identity provider setup and advanced options.
- [Configure SCIM](https://docs.gitguardian.com/platform/enterprise-administration/scim-configuration.md): Configure SCIM provisioning to automatically synchronize users and groups between your identity provider and GitGuardian workspace.
- [User and Team mapping scripts](https://docs.gitguardian.com/platform/enterprise-administration/scripts-users-teams-sync.md): Automate user and team management in GitGuardian using scripts and the API for bulk provisioning and synchronization.
- [Auth0](https://docs.gitguardian.com/platform/enterprise-administration/sso-providers/auth0.md): Configure SAML-based Single Sign-On (SSO) with Auth0 for GitGuardian.
- [Duo](https://docs.gitguardian.com/platform/enterprise-administration/sso-providers/duo.md): Configure SAML-based Single Sign-On (SSO) with Duo for GitGuardian.
- [Microsoft Entra ID](https://docs.gitguardian.com/platform/enterprise-administration/sso-providers/entra-id.md): Configure SAML-based Single Sign-On (SSO) with Microsoft Entra ID for GitGuardian.
- [Generic SAML2 IdP](https://docs.gitguardian.com/platform/enterprise-administration/sso-providers/generic.md): Configure SAML-based Single Sign-On (SSO) with any SAML2-enabled identity provider for GitGuardian.
- [Google](https://docs.gitguardian.com/platform/enterprise-administration/sso-providers/google.md): Configure SAML-based Single Sign-On (SSO) with Google Workspace for GitGuardian.
- [JumpCloud](https://docs.gitguardian.com/platform/enterprise-administration/sso-providers/jumpcloud.md): Configure SAML-based Single Sign-On (SSO) with JumpCloud for GitGuardian.
- [Keycloak](https://docs.gitguardian.com/platform/enterprise-administration/sso-providers/keycloak.md): Configure SAML-based Single Sign-On (SSO) with Keycloak for GitGuardian.
- [Okta](https://docs.gitguardian.com/platform/enterprise-administration/sso-providers/okta.md): Configure SAML-based Single Sign-On (SSO) with Okta for GitGuardian, using either the Okta Integration Network app or a custom SAML app.
- [Transfer workspace ownership](https://docs.gitguardian.com/platform/enterprise-administration/transfer-ownership.md): Transfer workspace ownership from one GitGuardian user to another.
- [Workspace settings](https://docs.gitguardian.com/platform/enterprise-administration/workspace-settings.md): Configure workspace-level settings for collaboration, sharing, incident permissions, and default behaviors.
- [RSS & Atom feeds](https://docs.gitguardian.com/platform/feeds.md): RSS and Atom feed URLs for tracking GitGuardian platform, detection engine, ggshield, and SDK release updates.
- [Create your GitGuardian account](https://docs.gitguardian.com/platform/getting-started/account-creation.md): How to create a GitGuardian account and set up your workspace, including free plan and trial options.
- [Assess your repositories' health](https://docs.gitguardian.com/platform/getting-started/first-audit.md): Walkthrough of performing your first historical audit of an integrated VCS source to discover existing secrets in your codebase.
- [Investigate and remediate your first open incident](https://docs.gitguardian.com/platform/getting-started/first-incident.md): Step-by-step guide to investigating and remediating your first secret incident in the GitGuardian dashboard.
- [Integrate your first repositories](https://docs.gitguardian.com/platform/getting-started/integrate.md): Guide to integrating your first VCS source with GitGuardian to start monitoring repositories for secrets.
- [Navigate with quick access](https://docs.gitguardian.com/platform/getting-started/quick-access.md): Quick links to key GitGuardian platform features and configuration pages for new users.
- [API](https://docs.gitguardian.com/platform/gitguardian-suite/api.md): Overview of the GitGuardian API for programmatically managing dashboard data and running secrets detection scans.
- [Dashboard](https://docs.gitguardian.com/platform/gitguardian-suite/dashboard.md): Overview of the GitGuardian dashboard web application and its main features for managing secrets incidents, integrations, and team collaboration.
- [GitGuardian CLI (ggshield)](https://docs.gitguardian.com/platform/gitguardian-suite/gitguardian-cli-ggshield.md): Overview of ggshield, the GitGuardian CLI tool for scanning code repositories, Docker images, and CI pipelines for secrets.
- [Python SDK](https://docs.gitguardian.com/platform/gitguardian-suite/python-sdk.md): Overview of py-gitguardian, the official Python SDK for interacting with the GitGuardian API.
- [Glossary](https://docs.gitguardian.com/platform/glossary.md): Definitions of key terms used throughout GitGuardian documentation, including workspace, incidents, detectors, and more.
- [Data retention](https://docs.gitguardian.com/platform/security-data-privacy/data-retention.md): Describes GitGuardian's data retention policies for workspace data, incidents, audit logs, and account information.
- [Privacy mode](https://docs.gitguardian.com/platform/security-data-privacy/privacy-mode.md): Explains how to enable privacy mode to control whether raw secret values are stored by GitGuardian.
- [Support](https://docs.gitguardian.com/platform/support.md): Contact information and resources for getting help from GitGuardian support, including email, documentation, and community channels.
- [Account settings](https://docs.gitguardian.com/platform/user-account/account-settings.md): Manage your GitGuardian account settings including profile information, authentication, and API tokens.
- [Delete your account](https://docs.gitguardian.com/platform/user-account/delete-account.md): Instructions for permanently deleting your GitGuardian user account.
- [Configure email preferences](https://docs.gitguardian.com/platform/user-account/email-preferences.md): Manage your personal email notification preferences for GitGuardian incident alerts and workspace updates.
- [Plan and usage](https://docs.gitguardian.com/platform/user-account/plan-usage.md): View your GitGuardian workspace plan details, usage statistics, and billing information.
- [Core concepts](https://docs.gitguardian.com/public-monitoring/core-concepts.md): Introduces GitGuardian Public Monitoring, explaining how it continuously scans public GitHub to detect exposed secrets related to your organization.
- [Incident lifecycle](https://docs.gitguardian.com/public-monitoring/detect-public-secret-incidents/incident-statuses.md): Understand the lifecycle of public secret incidents, including Triggered, Assigned, Resolved, and Ignored statuses.
- [Incidents and occurrences](https://docs.gitguardian.com/public-monitoring/detect-public-secret-incidents/incidents-occurrences.md): Understand how GitGuardian groups multiple public detections of the same secret into a single incident with individual occurrences.
- [Detect public secret incidents](https://docs.gitguardian.com/public-monitoring/detect-public-secret-incidents/overview.md): How GitGuardian detects public secret incidents through real-time monitoring and historical scanning of public GitHub activity.
- [Explore](https://docs.gitguardian.com/public-monitoring/explore/overview.md): Introduces the Explore feature for proactively searching public GitHub for secrets related to your organization beyond your defined perimeter.
- [Scan and monitor search results](https://docs.gitguardian.com/public-monitoring/explore/scan-and-monitor.md): Scan Explore search results for secrets, create incidents from findings, and set up scheduled monitoring for ongoing automated detection.
- [Search syntax](https://docs.gitguardian.com/public-monitoring/explore/search-syntax.md): Query language and search syntax for Explore to search public GitHub commits, including boolean operators and field-specific searches.
- [Developers](https://docs.gitguardian.com/public-monitoring/perimeter/developers.md): Monitor developers linked to your company on public GitHub to detect leaked secrets and sensitive data.
- [GitHub organizations](https://docs.gitguardian.com/public-monitoring/perimeter/github-organizations.md): Add and manage GitHub organizations in your Public Monitoring perimeter, including monitoring private members via a personal access token.
- [Company public perimeter](https://docs.gitguardian.com/public-monitoring/perimeter/overview.md): The company public perimeter for Public Monitoring, including monitored developers, GitHub organizations, and secret graspers.
- [Secret graspers](https://docs.gitguardian.com/public-monitoring/perimeter/secret-graspers.md): How secret graspers use company-specific terms to identify and attach publicly detected secrets to your organization.
- [Prioritize incidents](https://docs.gitguardian.com/public-monitoring/remediate/prioritize-incidents.md): Prioritize public secret incidents using severity rules, ML-powered risk scores, saved views, and filtering.
- [Remediate incidents](https://docs.gitguardian.com/public-monitoring/remediate/remediate-incidents.md): Remediate public secret incidents: investigate relevance, involve developers, revoke compromised secrets, and close incidents.
- [Public Secret Remediation Overview](https://docs.gitguardian.com/public-monitoring/remediate/remediation-overview.md): Overall approach to remediating public secret exposures, covering assessment, response workflows, and platform capabilities for guided remediation.
- [Investigate public incidents](https://docs.gitguardian.com/public-monitoring/remediate/understand-incident-properties.md): Describes the metadata, risk score, attachment reasons, tags, and exploration map available for investigating public secret incidents.
- [Secure secrets management](https://docs.gitguardian.com/secrets-detection/core-concepts/secure-secrets-management.md): Discusses the challenges of secure secrets management in the SDLC and the role of automated detection and remediation.
- [What is a secret?](https://docs.gitguardian.com/secrets-detection/core-concepts/what-is-a-secret.md): Defines what a secret is in the context of software development and explains how secrets authenticate application components.
- [Where should you scan for secrets in the SDLC?](https://docs.gitguardian.com/secrets-detection/core-concepts/where-to-implement-secrets-detection.md): Recommends a layered approach to implementing secrets detection across all stages of the SDLC.
- [Detector settings](https://docs.gitguardian.com/secrets-detection/customize-detection/detector-settings.md): Activate, deactivate, and request custom secrets detectors in GitGuardian workspace settings.
- [Exclusion rules](https://docs.gitguardian.com/secrets-detection/customize-detection/exclusion-rules.md): Configure filepath exclusions and secret pattern exclusions to reduce noise and focus secrets detection on relevant incidents.
- [Validity checks](https://docs.gitguardian.com/secrets-detection/customize-detection/validity-checks.md): Describes how GitGuardian validity checks verify whether detected secrets are still active through non-intrusive API calls.
- [Encrypted Secrets](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/encrypted_secrets.md): Encrypted secrets are secrets which are not stored in clear-text: they are encrypted using a key stored in a secured area.  
- [Frequently Asked Questions](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/frequently_asked_questions.md): Common questions about GitGuardian's secrets detection engine, including how detectors work, false positives, and custom detection.
- [Glossary](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/glossary.md): Definitions of key terms used in the GitGuardian secrets detection engine, including detector, match, entropy, scanner, and validity check.
- [Secret Enricher Categories Reference](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/gse-categories-providers-reference.md): Reference of all Secret Enricher categories and providers used to classify generic secret incidents by service type.
- [Remediate a leak on public GitHub](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/leaks_remediation.md): If you end up on this page, it is likely that you got an alert from our _pro bono_ alerting service. Don't worry, leaks sometimes just happen... ev...
- [Machine learning](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/machine_learning.md): Detecting secrets with high quality results is a challenging and intricate task. To enhance our detection engine, we've implemented various machine...
- [Secrets Detection Engine](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/quick_start.md): Secrets detection is probabilistic: some secrets are easier to find than others. There is a trade-off between low number of false alerts and low nu...
- [Secrets Analyzers](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/secrets_analyzer.md): Two Slack API keys may seem to offer the same accesses, but their associated
- [Pre-Validators and Post-Validators](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/validation.md): Pre-validator and post-validator components of the detection engine that filter documents and validate matches to reduce false positives.
- [GitGuardian Architecture](https://docs.gitguardian.com/self-hosting/architecture.md): Overview of GitGuardian self-hosted architecture, including Kubernetes components, ingress configuration, and deployment topology.
- [Install on an Existing Cluster using Helm (airgap)](https://docs.gitguardian.com/self-hosting/installation/airgap-installation-existing-cluster-helm.md): Install GitGuardian self-hosted in air-gapped environments using Helm on an existing Kubernetes cluster.
- [Install airgap using KOTS existing cluster](https://docs.gitguardian.com/self-hosting/installation/airgap-installation-existing-cluster-kots.md): [Deprecated] Install GitGuardian in air-gapped environments using KOTS on an existing Kubernetes cluster.
- [Install using Argo CD](https://docs.gitguardian.com/self-hosting/installation/argocd.md): Install GitGuardian self-hosted on an existing Kubernetes cluster using ArgoCD for GitOps-based deployment.
- [Choose your installation method](https://docs.gitguardian.com/self-hosting/installation/choose-embedded-existing.md): Compare and choose between embedded cluster and existing cluster installation methods for GitGuardian self-hosted.
- [Configure your database](https://docs.gitguardian.com/self-hosting/installation/databases/database-config.md): Overview of database configuration options for GitGuardian self-hosted, including PostgreSQL and Redis setup for different cloud providers.
- [Embedded PostgreSQL and Redis](https://docs.gitguardian.com/self-hosting/installation/databases/embedded.md): Use the embedded PostgreSQL and Redis databases included with GitGuardian self-hosted KOTS installations.
- [Azure Database: PostgreSQL on Azure](https://docs.gitguardian.com/self-hosting/installation/databases/postgres-azure.md): Configure Azure Database for PostgreSQL as the database backend for GitGuardian self-hosted.
- [Cloud SQL: PostgreSQL on GCP](https://docs.gitguardian.com/self-hosting/installation/databases/postgres-cloudsql.md): Configure Google Cloud SQL as the PostgreSQL database for GitGuardian self-hosted.
- [RDS: PostgreSQL on AWS](https://docs.gitguardian.com/self-hosting/installation/databases/postgres-rds.md): Configure Amazon RDS as the PostgreSQL database for GitGuardian self-hosted.
- [Azure Cache: Redis on Azure](https://docs.gitguardian.com/self-hosting/installation/databases/redis-azure-cache.md): Configure Azure Cache for Redis as the Redis backend for GitGuardian self-hosted.
- [ElasticCache: Redis on AWS](https://docs.gitguardian.com/self-hosting/installation/databases/redis-elasticache.md): Configure Amazon ElastiCache as the Redis backend for GitGuardian self-hosted.
- [MemoryStore: Redis on GCP](https://docs.gitguardian.com/self-hosting/installation/databases/redis-memorystore.md): Configure Google Cloud Memorystore as the Redis backend for GitGuardian self-hosted.
- [Configure TLS](https://docs.gitguardian.com/self-hosting/installation/databases/tls.md): Configure TLS encryption for PostgreSQL and Redis database connections in GitGuardian self-hosted.
- [Install using Flux CD](https://docs.gitguardian.com/self-hosting/installation/fluxcd.md): Install GitGuardian self-hosted on an existing Kubernetes cluster using Flux CD for GitOps-based deployment.
- [Helm Sensitive Information Management](https://docs.gitguardian.com/self-hosting/installation/helm-secrets.md): Manage sensitive configuration values for GitGuardian self-hosted Helm installations using Kubernetes secrets.
- [Install on an Embedded cluster](https://docs.gitguardian.com/self-hosting/installation/installation-embedded-cluster-v2.md): Install GitGuardian self-hosted using the Replicated Embedded Cluster v2 method for a simplified single-node deployment.
- [Install on an Embedded cluster (kURL)](https://docs.gitguardian.com/self-hosting/installation/installation-embedded-cluster.md): Install GitGuardian self-hosted using the KOTS embedded cluster method for an all-in-one single-node deployment.
- [Install on an Existing Cluster using Helm](https://docs.gitguardian.com/self-hosting/installation/installation-existing-cluster-helm.md): Install GitGuardian self-hosted on an existing Kubernetes cluster using Helm, the recommended installation method.
- [Install on an Existing Cluster using KOTS](https://docs.gitguardian.com/self-hosting/installation/installation-existing-cluster-kots.md): [Deprecated] Install GitGuardian on an existing Kubernetes cluster using KOTS (Kubernetes Off-The-Shelf).
- [Install using OpenShift](https://docs.gitguardian.com/self-hosting/installation/openshift.md): Install GitGuardian self-hosted on OpenShift 4 clusters, including security context and route configuration.
- [License management](https://docs.gitguardian.com/self-hosting/license-management.md): Manage and synchronize your GitGuardian self-hosted license, including online and offline activation methods.
- [Admin Area](https://docs.gitguardian.com/self-hosting/management/application-management/admin-area.md): Access and use the GitGuardian self-hosted admin area for system-wide configuration and user management.
- [Use the API](https://docs.gitguardian.com/self-hosting/management/application-management/api-configuration.md): Configure the GitGuardian API for self-hosted installations, including rate limiting and endpoint settings.
- [Configure the email system](https://docs.gitguardian.com/self-hosting/management/application-management/email-configuration.md): Configure SMTP email settings for GitGuardian self-hosted to enable notification delivery.
- [Machine Learning](https://docs.gitguardian.com/self-hosting/management/application-management/machine-learning.md): This section outlines the machine learning features implemented in GitGuardian, detailing how they work and how to activate them for Self-Hosted. O...
- [Applicative metrics](https://docs.gitguardian.com/self-hosting/management/application-management/metrics.md): Export Prometheus metrics from your GitGuardian self-hosted installation for monitoring and alerting.
- [Non-VCS Sources](https://docs.gitguardian.com/self-hosting/management/application-management/non-vcs-sources.md): Configure non-VCS source integrations (Slack, Confluence, Jira, container registries) for GitGuardian self-hosted installations.
- [Configure preferences](https://docs.gitguardian.com/self-hosting/management/application-management/preferences.md): Configure application-level preferences for your GitGuardian self-hosted instance.
- [KOTS Admin Console](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/admin-console.md): Access and use the KOTS Admin Console for managing your GitGuardian self-hosted installation.
- [Autoscaling](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/autoscaling.md): Configure autoscaling for GitGuardian self-hosted installations using Kubernetes HPA or KEDA.
- [Backup & Restore](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/backup.md): Back up and restore your GitGuardian self-hosted instance, including database and encryption key management.
- [Certificate-Based Authentication (legacy)](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/cert-based-auth.md): [Deprecated] Configure TLS client certificate-based authentication (CAC/PIV) for GitGuardian self-hosted installations.
- [Cluster management](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/cluster-management.md): Manage your GitGuardian self-hosted Kubernetes cluster, including node operations, storage, and resource management.
- [Helm Chart Values 2025.10.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2025.10.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2025.10.0.
- [Helm Chart Values 2025.11.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2025.11.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2025.11.0.
- [Helm Chart Values 2025.12.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2025.12.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2025.12.0.
- [Helm Chart Values 2025.7.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2025.7.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2025.7.0.
- [Helm Chart Values 2025.8.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2025.8.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2025.8.0.
- [Helm Chart Values 2025.9.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2025.9.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2025.9.0.
- [Helm Chart Values 2026.1.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2026.1.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2026.1.0.
- [Helm Chart Values 2026.2.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2026.2.0.md): [//]: # (DO NOT EDIT !)
- [Helm Chart Values 2026.3.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2026.3.0.md): [//]: # (DO NOT EDIT !)
- [Helm Chart Values 2026.4.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2026.4.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2026.4.0.
- [Helm Chart Values 2026.5.0](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values/2026.5.0.md): Helm chart configuration values reference for GitGuardian self-hosted version 2026.5.0.
- [Helm Chart Values Changelog](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/helm-values.md): Index of Helm chart values references for all GitGuardian self-hosted versions.
- [High availability](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/high-availability.md): Configure high availability for GitGuardian self-hosted by scaling replicas and ensuring database redundancy.
- [Ingress routes (legacy)](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/ingress-routes-legacy.md): [Deprecated] Legacy experimental ingress routes configuration for GitGuardian self-hosted Helm installations.
- [Ingress](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/ingress.md): Configure ingress for GitGuardian self-hosted installations on existing Kubernetes clusters using KOTS or Helm.
- [IPv6 networking](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/ipv6-networking.md): Configure IPv6 and dual-stack networking for GitGuardian self-hosted Kubernetes deployments.
- [Load balancer](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/load-balancer.md): Configure load balancer access for GitGuardian self-hosted installations on existing Kubernetes clusters.
- [Network policies](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/network-policies.md): Enable and configure Kubernetes NetworkPolicies to isolate the GitGuardian namespace and control ingress traffic to GitGuardian pods.
- [HTTP Proxy](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/proxy-server.md): Configure HTTP/HTTPS proxy settings for GitGuardian self-hosted installations that require outbound internet access through a proxy.
- [Scaling](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/scaling.md): Configure resource scaling for GitGuardian self-hosted deployments, including replicas, CPU, and memory for different workload types.
- [Upgrade Helm](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/upgrade-helm.md): Upgrade your GitGuardian self-hosted Helm installation, including version-specific migration instructions.
- [Upgrade Embedded cluster](https://docs.gitguardian.com/self-hosting/management/infrastructure-management/upgrade-kots.md): Upgrade your GitGuardian self-hosted KOTS installation, including preflight checks and version-specific instructions.
- [Network requirements](https://docs.gitguardian.com/self-hosting/network-requirements.md): Network requirements for GitGuardian self-hosted, including inbound/outbound rules, domain allowlists, and firewall configuration.
- [SaaS vs Self-Hosted](https://docs.gitguardian.com/self-hosting/saas-vs-self-hosted.md): Compares GitGuardian SaaS and self-hosted deployment models, including feature availability, upgrade process, and support differences.
- [Custom Certificate Authorities](https://docs.gitguardian.com/self-hosting/security/custom-ca.md): Configure custom Certificate Authorities for GitGuardian self-hosted to trust internal TLS certificates.
- [Database Security](https://docs.gitguardian.com/self-hosting/security/database-security.md): Configure database-level security for GitGuardian self-hosted, including encryption at rest and connection security.
- [Security recommendations and information](https://docs.gitguardian.com/self-hosting/security/recommendations.md): Security best practices and hardening recommendations for GitGuardian self-hosted deployments.
- [TLS certificates](https://docs.gitguardian.com/self-hosting/security/tls-certificates.md): Configure TLS certificates for securing external access to your GitGuardian self-hosted instance.
- [Traffic encryption](https://docs.gitguardian.com/self-hosting/security/traffic-encryption.md): Configure internal traffic encryption between GitGuardian self-hosted Kubernetes pods.
- [System requirements](https://docs.gitguardian.com/self-hosting/system-requirements.md): Hardware, software, and infrastructure requirements for deploying GitGuardian self-hosted, including Kubernetes, database, and Redis specifications.
- [Environment health](https://docs.gitguardian.com/self-hosting/troubleshoot/health-check.md): Run health checks on your GitGuardian self-hosted installation to verify component connectivity and configuration.
- [Logs and debug](https://docs.gitguardian.com/self-hosting/troubleshoot/logs.md): View and collect logs from GitGuardian self-hosted Kubernetes pods for debugging and troubleshooting.
- [Support bundle](https://docs.gitguardian.com/self-hosting/troubleshoot/support.md): How to contact GitGuardian support and generate a support bundle for troubleshooting self-hosted installations.
- [Application topology](https://docs.gitguardian.com/self-hosting/troubleshoot/topology.md): Overview of GitGuardian self-hosted Kubernetes resources, including deployment names, types, and their roles.