Diese Version von GitHub Enterprise Server wurde eingestellt am 2024-03-26. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für bessere Leistung, verbesserte Sicherheit und neue Features aktualisiere auf die neueste Version von GitHub Enterprise Server. Wende dich an den GitHub Enterprise-Support, um Hilfe zum Upgrade zu erhalten.

Registrieren einer GitHub-App

Du kannst eine GitHub App unter deinem persönlichen Konto oder einer Organisation in deinem Besitz registrieren.

In diesem Artikel

Informationen zum Registrieren von GitHub Apps

Du kannst eine GitHub App unter deinem persönlichen Konto, einer Organisation in deinem Besitz oder einer Organisation registrieren, die dir Berechtigung zum Verwalten aller Apps im Besitz der Organisation erteilt hat. Weitere Informationen findest du unter Hinzufügen und Entfernen von GitHub-App-Manager*innen zu bzw. aus deiner Organisation.

Registrieren einer GitHub App

  1. Klicke auf GitHub in der oberen rechten Ecke einer beliebigen Seite auf dein Profilfoto.

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

    • Klicken Sie bei einer App, die zu einem persönlichen Konto gehört, auf Einstellungen.
    • Für eine App im Besitz einer Organisation:
      1. Klicke auf Deine Organisationen.
      2. Klicke dann rechts neben der Organisation auf Einstellungen.

  3. Klicke auf der linken Seitenleiste auf Entwicklereinstellungen.

  4. Klicke auf der linken Randleiste auf GitHub Apps .

  5. Klicke auf Neue GitHub-App.

  6. Gib unter „Name der GitHub-App“ einen Namen für deine App ein. Du solltest einen klaren und kurzen Namen auswählen. Der Name deiner App (in Kleinbuchstaben konvertiert, Leerzeichen ersetzt durch - und Sonderzeichen ersetzt) wird auf der Benutzeroberfläche angezeigt, wenn deine App eine Aktion ausführt. My APp Näme wird beispielsweise als my-app-name angezeigt.

    Der Name muss für GitHub eindeutig sein. Du kannst nicht denselben Namen wie für ein vorhandenes GitHub-Konto verwenden, es sei denn, es handelt sich um deinen eigenen Benutzer- oder Organisationsnamen.

  7. Gib optional unter „Beschreibung“ eine Beschreibung für deine App ein. Benutzer*innen und Organisationen wird diese Beschreibung angezeigt, wenn sie deine App installieren.

  8. Gib unter „Homepage-URL“ die vollständige URL der Website deiner App ein. Wenn du nicht über eine dedizierte URL verfügst und der Code deiner App in einem öffentlichen Repository gespeichert ist, kannst du diese Repository-URL verwenden. Alternativ kannst du die URL der Organisationen oder Benutzer*innen verwenden, die die App besitzen.

  9. Gib optional unter „Rückruf-URL“ die vollständige URL ein, zu der umgeleitet werden soll, nachdem Benutzer*innen die Installation autorisiert haben.

    Du kannst bis zu zehn Rückruf-URLs eingeben. Um zusätzliche Rückruf-URLs hinzuzufügen, klicke auf Rückruf-URL hinzufügen.

    Wenn deine App nicht im Namen von Benutzer*innen handeln muss (Generieren eines Benutzerzugriffstokens nicht erforderlich), wird dieses Feld ignoriert. Wenn deine App den Geräteablauf anstelle des Webanwendungsablaufs verwendet, um ein Benutzerzugriffstoken zu generieren, wird dieses Feld ignoriert.

    Weitere Informationen zur Rückruf-URL findest du unter Informationen zur Rückruf-URL für die Benutzerautorisierung. Weitere Informationen zum Generieren eines Benutzerzugriffstokens für Aktionen im Namen anderer Benutzer*innen findest du unter Authentifizieren mit einer GitHub-App im Namen von Benutzer*innen und Generieren eines Benutzerzugriffstokens für eine GitHub-App.

  10. Um zu verhindern, dass Benutzerzugriffstoken ablaufen, kannst du optional die Option Benutzerautorisierungstoken ablaufen lassen deaktivieren. GitHub empfiehlt dringend, diese Option ausgewählt zu lassen. Weitere Informationen zum Aktualisieren abgelaufener Tokens und den Vorteilen von Benutzerzugriffstoken, die ablaufen, findest du unter Aktualisieren von Benutzerzugriffstoken. Wenn deine App kein Benutzerzugriffstoken generieren muss, wird dieses Feld ignoriert.

  11. Optional kannst du Benutzerautorisierung (OAuth) während der Installation anfordern aktivieren, um Benutzerinnen bei der Installation deiner App aufzufordern, diese zu autorisieren. Wenn Benutzerinnen deine App autorisieren, kann die App ein Benutzerzugriffstoken generieren, um API-Anforderungen im Namen der Benutzerinnen zu stellen und den Benutzerinnen App-Aktivitäten zuzuordnen. Weitere Informationen findest du unter Authentifizieren mit einer GitHub-App im Namen von Benutzer*innen und unter Generieren eines Benutzerzugriffstokens für eine GitHub-App.

  12. Optional kannst du Geräteablauf aktivieren aktivieren, wenn du den Geräteablauf zum Generieren eines Benutzerzugriffstokens verwenden möchtest. Weitere Informationen findest du unter Generieren eines Benutzerzugriffstokens für eine GitHub-App.

  13. Gib optional unter „Setup-URL“ die URL ein, zu der Benutzerinnen nach der Installation deiner App weitergeleitet werden sollen. Wenn nach der Installation ein zusätzliches Setup erforderlich ist, kannst du diese URL verwenden, um Benutzerinnen mitzuteilen, welche Schritte nach der Installation ausgeführt werden müssen. Weitere Informationen findest du unter Informationen zur Setup-URL.

    Wenn du Benutzerautorisierung (OAuth) während der Installation anfordern in einem früheren Schritt aktiviert hast, kannst du hier keine URL eingeben. Benutzer*innen werden im Rahmen des Autorisierungsvorgangs stattdessen zur Rückruf-URL weitergeleitet, wo du das zusätzliche Setup beschreiben kannst.

  14. Wenn du Benutzer*innen nach dem Aktualisieren einer Installation zur Setup-URL umleiten möchtest, kannst du optional Bei Update umleiten aktivieren. Ein Update umfasst das Hinzufügen oder Entfernen eines Repositorys für eine Installation. Wenn „Setup-URL“ leer ist, wird dies ignoriert.

  15. Optional kannst du Aktiv deaktivieren, wenn deine App keine Webhookereignisse empfangen soll. Wenn deine App beispielsweise nur für die Authentifizierung verwendet wird oder nicht auf Webhooks reagieren muss, deaktiviere diese Option. Weitere Informationen findest du unter Verwenden von Webhooks mit GitHub-Apps.

  16. Wenn du im vorherigen Schritt Aktiv ausgewählt hast, gib unter „Webhook-URL“ die URL ein, an die GitHub Webhookereignisse senden soll. Weitere Informationen findest du unter Verwenden von Webhooks mit GitHub-Apps.

  17. Wenn du im vorherigen Schritt Aktiv ausgewählt hast, kannst du optional ein geheimes Token eingeben, um deine Webhooks zu schützen. GitHub empfiehlt dringend, ein Webhookgeheimnis festzulegen. Weitere Informationen findest du unter Verwenden von Webhooks mit GitHub-Apps.

  18. Wenn du eine Webhook-URL eingegeben hast, wähle unter „SSL-Überprüfung“ aus, ob die SSL-Überprüfung aktiviert werden soll. GitHub empfiehlt dringend, die SSL-Überprüfung zu aktivieren.

  19. Wähle unter „Berechtigungen“ die Berechtigungen aus, die deine App benötigt. Verwende für jede Benachrichtigung das Dropdownmenü, und klicke auf Schreibgeschützt, Lesen und Schreiben oder Kein Zugriff. Du solltest die mindestens erforderlichen Berechtigungen für deine App auswählen. Weitere Informationen findest du unter Auswählen von Berechtigungen für eine GitHub-App.

  20. Wenn du im vorherigen Schritt Aktiv ausgewählt hast, um anzugeben, dass deine App Webhookereignisse empfangen soll, wähle unter „Ereignisse abonnieren“ die Webhookereignisse aus, die deine App empfangen soll. Die Berechtigungen, die du im vorherigen Schritt ausgewählt hast, legen fest, welche Webhookereignisse verfügbar sind. Weitere Informationen zu den einzelnen Webhookereignissen findest du unter Webhook-Ereignisse und -Nutzlasten.

  21. Wähle unter „Wo kann diese GitHub-App installiert werden“ die Option Nur in diesem Konto oder Beliebiges Konto aus. Weitere Informationen zu den Installationsoptionen findest du unter Öffentlich- oder Privatmachen einer GitHub-App.

  22. Klicke auf GitHub-App erstellen.

Nächste Schritte

Nachdem du eine GitHub App registriert hast, solltest du Code schreiben, damit deine GitHub App Aktionen ausführt. Beispiele für das Schreiben von Code findest du unter:

Du solltest versuchen, bewährten Methoden zu folgen. Weitere Informationen findest du unter Best Practices beim Erstellen einer GitHub-App.

Sobald deine GitHub App vollständig erstellt wurde, kannst du deine GitHub App installieren und deine GitHub App für andere Personen freigeben. Weitere Informationen findest du unter Installieren einer eigenen GitHub-App und unter Freigeben deiner GitHub-App.

Du kannst die Einstellungen für deine GitHub App jederzeit ändern. Weitere Informationen findest du unter Ändern einer GitHub-App-Registrierung.