Erstellen einer GitHub-App

Informationen zum Verwenden von GitHub-App-Manifesten, mit denen vorkonfigurierte GitHub-Apps erstellt werden können, findest du unter Erstellen von GitHub Apps aus einem Manifest.

1. Navigiere zu den Einstellungen für dein Konto.

   • Wenn es sich um eine GitHub App im Besitz eines persönlichen Kontos handelt, klicke in der rechten oberen Ecke einer beliebigen Seite auf dein Profilfoto und dann auf Einstellungen.
   • Wenn es sich um eine GitHub App im Besitz einer Organisation handelt, klicke in der oberen rechten Ecke einer beliebigen Seite auf dein Profilfoto und dann auf Deine Organisationen. Klicke dann rechts neben der Organisation auf Einstellungen.

2. Klicke in der linken Seitenleiste auf Entwicklereinstellungen.

3. Klicke auf der linken Randleiste auf GitHub-Apps.

4. Klicke auf Neue GitHub-App.

5. Gib in „GitHub-App-Name“ den Namen deiner App ein.

   Gib deiner App einen klaren und kurzen Namen. Deine App kann nicht denselben Namen wie ein vorhandenes GitHub-Konto haben, es sei denn, es handelt sich um deinen eigenen Benutzer- oder Organisationsnamen. Eine Slugversion des Namens deiner App wird in der Benutzeroberfläche angezeigt, wenn deine Integration eine Aktion ausführt.

6. Gib optional in „Beschreibung“ eine Beschreibung deiner App ein, die Benutzern angezeigt wird.

7. Gib in „Homepage-URL“ die vollständige URL für die Website deiner App ein.

8. Gib in „Rückruf-URL“ die vollständige URL ein, zu der umgeleitet werden soll, nachdem ein Benutzer die Installation autorisiert hat. Diese URL wird verwendet, wenn deine App Benutzer-zu-Server-Anforderungen identifizieren und autorisieren muss.

   Mit Rückruf-URL hinzufügen kannst du maximal 10 zusätzliche Rückruf-URLs bereitstellen.

   

9. Um die Sicherheit deiner App zu verbessern, verwendet deine App standardmäßig ablaufende Benutzerberechtigungstoken. Um die Verwendung ablaufender Benutzertoken zu deaktivieren, musst du „Benutzerautorisierungs-Token ablaufen lassen“ deaktivieren. Weitere Informationen zum Einrichten eines Aktualisierungstokenflows und der Vorteile des Ablaufs von Benutzertoken findest du unter Aktualisieren von Benutzer-zu-Server-Zugriffstoken.

10. Wenn deine App Benutzer mit dem OAuth-Flow autorisiert, kannst du Während der Installation „Benutzerautorisierung anfordern (OAuth)“ auswählen auswählen, damit die Benutzer die App autorisieren können, wenn sie sie installieren, und dabei einen Schritt sparen. Wenn du diese Option auswählst, ist die „Setup-URL“ nicht mehr verfügbar, und Benutzer werden nach der Installation der App zu deiner „Rückruf-URL für Benutzerautorisierung“ umgeleitet. Weitere Informationen findest du unter Autorisieren von Benutzern während der Installation.

11. Wenn deine GitHub-App den Geräteflow verwendet, um Benutzer zu identifizieren und zu autorisieren, klicke auf Geräteflow aktivieren. Weitere Informationen zum Geräteflow findest du unter Autorisieren von OAuth-Apps.

12. Wenn nach der Installation zusätzliche Setups erforderlich sind, füge eine „Setup-URL“ hinzu, um Benutzer dorthin umzuleiten, nachdem sie deine App installiert haben.

    Hinweis: Wenn du im vorherigen Schritt Während der Installation „Benutzerautorisierung anfordern (OAuth)“ auswählen ausgewählt hast, ist dieses Feld nicht mehr verfügbar, und die Benutzer werden nach der Installation der App zur „Rückruf-URL für Benutzerautorisierung“ umgeleitet.

13. Gib in „Webhook-URL“ die URL ein, an die die Ereignisse GEPOSTET werden sollen. Jede App erhält einen eigenen Webhook, der dich jedes Mal benachrichtigt, wenn die App installiert oder geändert wird, sowie über alle anderen Ereignisse, die die App abonniert hat.

14. Gib optional in „Webhook-Geheimnis“ ein optionales geheimes Token ein, das zum Sichern deines Webhooks verwendet wird.

    Hinweis: Es wird dringend empfohlen, ein geheimes Token festzulegen. Weitere Informationen findest du unter Sichern deiner Webhooks.

15. Wähle in „Berechtigungen“ die Berechtigungen aus, die deine App anfordert. Verwende für jeden Berechtigungstyp das Dropdownmenü, und klicke auf Schreibgeschützt, Lesen & schreiben oder Kein Zugriff.

16. Wähle in „Ereignisse abonnieren“ die Ereignisse aus, die deine App empfangen soll.

17. Um auszuwählen, wo die App installiert werden kann, wähle entweder Nur auf diesem Konto oder Beliebiges Konto aus. Weitere Informationen zu Installationsoptionen findest du unter Eine GitHub App öffentlich oder privat machen.

18. Klicke auf GitHub-App erstellen.