Démarrer

info

Il s'agit du parcours mono-machine : il utilise une connexion interactive via le navigateur et ne nécessite pas de token de compte de service. Pour un déploiement sur un parc de machines, gérez plutôt l'installation et les identifiants via votre MDM avec un token de compte de service (voir Déployer à grande échelle avec un token de compte de service).

Prérequis

• Un compte GitGuardian business avec Endpoint Protection activé.

Étape 1 : Installer ggshield et activer le scan de machine

Linux / macOS

curl -sSfL \
  https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.sh |
  bash -s -- --plugin machine_scan

Windows (PowerShell)

& ([scriptblock]::Create((irm https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1))) `
  -Plugin machine_scan

remarque

Par défaut, le script cible le workspace US. Pour le workspace EU ou une instance Self-Hosted, exportez l'URL de votre instance avant d'exécuter la commande. Elle s'applique alors à l'installation et à toutes les commandes ci-dessous (même shell) :

export GITGUARDIAN_INSTANCE=https://dashboard.eu1.gitguardian.com   # ou l'URL de votre instance Self-Hosted

Étape 2 : Lancer votre premier scan

ggshield machine scan --dashboard

Étape 3 : Envoyer vos résultats à GitGuardian

ggshield machine submit

submit envoie le scan que vous venez d'exécuter. Pour scanner et envoyer en une seule étape — la forme que vous souhaitez pour une tâche planifiée — utilisez ggshield machine report. Voir Commandes.

Votre machine apparaît alors sous Endpoint protection → Endpoints dans le dashboard GitGuardian. Voir Concepts fondamentaux pour ce que chaque vue affiche.

Vérifier votre configuration

Confirmez à tout moment l'installation et le plugin :

ggshield --version
ggshield plugin list   # machine_scan doit être listé et activé

Notes

Le script installe le build autonome par utilisateur (aucun droit admin ou sudo requis), et chaque artefact de release téléchargé est vérifié par checksum par rapport au condensé que GitHub publie pour cette release. Cette vérification couvre les binaires, pas le script d'installation lui-même, qui est récupéré depuis main. Pour un contrôle plus strict de la chaîne d'approvisionnement, épinglez le script à un commit revu ou servez-le depuis un package interne/hébergé par MDM (voir Déployer à grande échelle avec un token de compte de service).

Supprimer ggshield

Pour désinstaller ultérieurement, suivez Uninstall dans le README des scripts d'installation.

Étapes suivantes

• Déployer sur un parc de machines : Déployer à grande échelle avec un token de compte de service
• Ce qui est scanné : Ce qui est scanné
• Gérer le plugin : Commandes ggshield plugin