GitGuardian

https://docs.gitguardian.com/
Admin
GitGuardian provides a comprehensive platform for detecting and preventing security vulnerabilities,...
Tokens:2,078,298
Snippets:13,920
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### ggshield machine setup command syntax

Source: https://docs.gitguardian.com/ggshield-docs/reference/machine/setup

Shows the command-line syntax for `ggshield machine setup`. Running this command configures all protections (AI hooks, git hooks, honeytoken) in one idempotent run. It is safe to re-run; it adds missing entries and leaves existing ones untouched.

```text
ggshield machine setup [OPTIONS]
```

--------------------------------

### Install from a URL

Source: https://docs.gitguardian.com/ggshield-docs/reference/plugin/install

Installs a plugin from a URL. The second example includes a SHA256 checksum for verification.

```text
ggshield plugin install https://example.com/plugin.whl
```

```text
ggshield plugin install https://example.com/plugin.whl --sha256 abc123...
```

--------------------------------

### Install from GitGuardian

Source: https://docs.gitguardian.com/ggshield-docs/reference/plugin/install

Installs a plugin from GitGuardian, requiring authentication. The second example specifies a version.

```text
ggshield plugin install machine_scan
```

```text
ggshield plugin install machine_scan --version 0.1.0
```

--------------------------------

### Install ggshield on Linux/macOS using install script

Source: https://docs.gitguardian.com/ggshield-docs/getting-started

Recommended installation method. Runs the install script and also triggers `ggshield auth login` for authentication.

```shell
curl -sSfL \
  https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.sh | bash
```

--------------------------------

### Example local-values.yaml for GitGuardian Helm Installation

Source: https://docs.gitguardian.com/self-hosting/installation/installation-existing-cluster-helm

This example values file configures the essential elements required for a GitGuardian Helm installation: hostname, PostgreSQL, Redis, and onPrem.adminUser. It references existing Kubernetes secrets for PostgreSQL and Redis credentials. Customize the values according to your environment.

```yaml
hostname: gitguardian.internal.yourcompany.com # Hostname where the instance will be accessed

postgresql:
  host: gitguardian-postgres # PostgreSQL host
  username: postgres # PostgreSQL username
  database: gitguardian # PostgreSQL database name
  existingSecret: gitguardian-postgresql-secret # Kubernetes secret where to check the PostgreSQL password
  existingSecretKeys:
    password: postgres-password # Name of the key containing password in the secret

redis:
  main:
    host: gitguardian-redis # Redis host
    tls:
      enabled: false # Set TLS encryption for Redis
    existingSecret: gitguardian-redis-secret # Kubernetes secret where to check the Redis password
    existingSecretKeys:
      url: redis-url # Name of the key containing redis url in the secret

onPrem:
  adminUser:
    email: your.name@yourcompany.com # email of the instance admin user
    firstname: YourName # name of the instance admin user
```

--------------------------------

### Set up AI Hooks on a single machine with ggshield machine setup

Source: https://docs.gitguardian.com/endpoint-protection/ai-hooks

Run this command as the logged-in user to configure hooks for all detected AI coding assistants, install git pre-commit and pre-push hooks, and plant a honeytoken. Use --no-git-hooks or --no-honeytokens to install AI Hooks alone, and --agent or --exclude-agent to select specific assistants. Requires ggshield 1.53.0 or later.

```bash
ggshield machine setup
```
Tokens:
Raw