Configuring secret scanning for your repositories

You can configure how GitHub scans your repositories for secrets.

People with admin permissions to a repository can enable secret scanning for the repository.

Secret scanning is available for all public repositories, and for private repositories owned by organizations where GitHub Advanced Security is enabled. Weitere Informationen findest Du unter „Informationen zu GitHub Advanced Security“.

Note: Secret scanning is enabled by default on public repositories and cannot be turned off. You can configure secret scanning for your private repositories only.

Enabling secret scanning for private repositories

Once enabled, secret scanning scans for any secrets in your entire Git history on all branches present in your GitHub repository.

  1. Navigiere in GitHub zur Hauptseite des Repository.

  2. Klicke unter Deinem Repository-Namen auf Settings (Einstellungen). Schaltfläche „Repository settings" (Repository-Einstellungen)

  3. Klicke in der linken Seitenleiste auf Security & analysis (Sicherheit und Analysen). Registerkarte "Security & analysis" (Sicherheit und Analysen) in den Repository-Einstellungen

  4. If Advanced Security is not already enabled for the repository, to the right of "GitHub Advanced Security", click Enable. Enable GitHub Advanced Security for your repository

  5. Review the impact of enabling Advanced Security, then click Enable GitHub Advanced Security for this repository.

  6. When you enable Advanced Security, secret scanning may automatically be enabled for the repository due to the organization's settings. If "Secret scanning" is shown with an Enable button, you still need to enable secret scanning by clicking Enable. If you see a Disable button, secret scanning is already enabled. Enable secret scanning for your repository

Excluding alerts from secret scanning in private repositories

Du kannst eine secret_scanning.yml-Datei verwenden, um Verzeichnisse von secret scanning auszuschließen. Beispielsweise kannst Du Verzeichnisse ausschließen, welche Tests oder zufällig generierte Inhalte enthalten.

  1. Navigiere in GitHub zur Hauptseite des Repository.

  2. Above the list of files, using the Add file drop-down, click Create new file. "Create new file" in the "Add file" dropdown

  3. Gib im Feld „Dateiname" .github/secret_scanning.yml ein.

  4. Gib unter Edit new file (Neue Datei bearbeiten) paths-ignore: ein, gefolgt von den Pfaden, die Du von secret scanning ausschließen willst.

    paths-ignore:
      - "foo/bar/*.js"
    

    Du kannst Sonderzeichen wie * verwenden, um Pfade zu filtern. Weitere Informationen zu Filtermustern findest Du unter „Workflow-Syntax für GitHub-Aktionen."

    Hinweise:

    • Wenn es mehr als 1.000 Einträge in paths-ignore gibt, wird secret scanning nur die ersten 1.000 Verzeichnisse von Scans ausschließen.
    • Wenn secret_scanning.yml größer als 1 MB ist, wird secret scanning die ganze Datei ignorieren.

Du kannst auch einzelne Warnungen von secret scanning ignorieren. Weitere Informationen findest Du unter „Warnungen von secret scanning verwalten."

Weiterführende Informationen

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Oder, learn how to contribute.