So erstellen Sie eine selbst gehostete GitHub App
Wenn Sie Bencher Cloud verwenden, können Sie sich einfach anmelden oder einloggen
mit dem GitHub Button.
Für die selbstgehostete Bencher-Variante benötigen Sie einen Bencher Plus Enterprise-Plan, müssen Ihre eigene GitHub-App erstellen und Ihre Konsolenkonfiguration sowie die API-Server-Konfiguration aktualisieren.
Eine GitHub App erstellen
- Erstellen Sie eine GitHub App
- GitHub App Name
- Wählen Sie einen eindeutigen Namen (z.B.
Bencher für Mein Unternehmen)
- Wählen Sie einen eindeutigen Namen (z.B.
- Homepage URL
- Stellen Sie diese auf Ihre Bencher Self-Hosted Console URL ein (z.B.
https://bencher.example.com)
- Stellen Sie diese auf Ihre Bencher Self-Hosted Console URL ein (z.B.
- Identifizierung und Autorisierung von Benutzern
- Rückruf-URL
- Setzen Sie die Rückruf-URL auf Ihre Bencher Self-Hosted Console URL mit dem Pfad
/auth/github(z.B.https://bencher.example.com/auth/github)
- Setzen Sie die Rückruf-URL auf Ihre Bencher Self-Hosted Console URL mit dem Pfad
- ✅ Ablauf von Benutzer-Autorisierungstokens
- ✅ Benutzer-Autorisierung (OAuth) während der Installation anfordern
- ✅ Gerätefluss aktivieren
- Rückruf-URL
- Webhook
- ❌ Aktiv - Entfernen Sie das Häkchen in diesem Kästchen
- Berechtigungen
- Kontoberechtigungen
- E-Mail-Adressen:
Nur lesen
- E-Mail-Adressen:
- Kontoberechtigungen
- Wo kann diese GitHub App installiert werden?
- 🔘 Jedes Konto
- Klicken Sie auf
GitHub App erstellen - Jetzt unter
Allgemeinfür die neu erstellte App - Notieren Sie die
Client ID(z.B.Iv1.12864abcd1232048) - Client-Geheimnisse
- Klicken Sie auf
Neues client secret generieren - Notieren Sie dieses Geheimnis (z.B.
00000abcd12345wxyz123456789abcdefgh0000)
- Klicken Sie auf
- Fügen Sie das Bencher Logo PNG unter Display-Informationen hinzu
- Private Schlüssel
- Klicken Sie auf
Privaten Schlüssel generieren
- Klicken Sie auf
GitHub App Konfiguration
Konsole UI
Setzen Sie die Umgebungsvariable GITHUB_CLIENT_ID, wenn Sie das bencher-console Docker-Image ausführen. (z.B. GITHUB_CLIENT_ID=Iv1.12864abcd1232048) Wenn die Client-ID fehlt, werden die GitHub-Buttons nicht in der UI angezeigt.
API-Server
Fügen Sie die client_id und das client_secret zu dem plus.github Abschnitt der Serverkonfiguration hinzu. Wenn der GitHub-Abschnitt fehlt, wird der Server alle GitHub-Authentifizierungsanfragen ablehnen.
Verknüpfte Repositorys
Aktualisieren Sie den Bencher Self-Hosted API-Server und die Console auf v0.6.16 oder neuer, bevor Sie diese Einstellungen ändern.
Damit ein Projekt für seine abgelösten Läufe ein GitHub-Repository verknüpfen kann, setzen Sie zusätzlich diese Einstellungen für die GitHub App:
- Identifizierung und Autorisierung von Benutzern
- Rückruf-URL
- Setzen Sie die erste Rückruf-URL auf Ihre Bencher Self-Hosted Console URL mit dem Pfad
/console/github(z.B.https://bencher.example.com/console/github). GitHub schickt den Benutzer nach der Installation der App zur ersten Rückruf-URL. - Behalten Sie danach die Rückruf-URL mit dem Pfad
/auth/githubfür die Anmeldung (z.B.https://bencher.example.com/auth/github). GitHub lehnt eine Anmeldung ab, deren Rückruf-URL nicht aufgeführt ist.
- Setzen Sie die erste Rückruf-URL auf Ihre Bencher Self-Hosted Console URL mit dem Pfad
- ✅ Benutzer-Autorisierung (OAuth) während der Installation anfordern
- Rückruf-URL
- Webhook
- ✅ Aktiv - Setzen Sie das Häkchen in diesem Kästchen
- Webhook-URL
- Setzen Sie sie auf Ihre Bencher Self-Hosted API-Server-URL mit dem Pfad
/v0/github/webhook(z.B.https://api.bencher.example.com/v0/github/webhook)
- Setzen Sie sie auf Ihre Bencher Self-Hosted API-Server-URL mit dem Pfad
- Webhook-Geheimnis
- Geben Sie ein zufälliges Geheimnis ein und notieren Sie es (z.B.
0123456789abcdef0123456789abcdef)
- Geben Sie ein zufälliges Geheimnis ein und notieren Sie es (z.B.
- Berechtigungen
- Repository-Berechtigungen
- Inhalte:
Lesen und Schreiben
- Inhalte:
- Ereignisse abonnieren
- Lassen Sie jedes Ereignis deaktiviert
- Repository-Berechtigungen
- Notieren Sie den Slug der App, den letzten Teil der URL ihrer öffentlichen Seite (z.B.
my-bencher-appinhttps://github.com/apps/my-bencher-app)
Fügen Sie den Slug, den privaten Schlüssel und das Webhook-Geheimnis als app zu dem plus.github Abschnitt der Serverkonfiguration hinzu.
🐰 Gratulation! Sie haben gelernt, wie man eine GitHub App einrichtet! 🎉