Enterprise Server 3.20 ist derzeit als Release Candidate verfügbar.

Registrieren einer GitHub-App

Sie können eine GitHub App unter Ihrem persönlichen Konto, einer Organisation, die Sie besitzen, oder Ihrem Unternehmen .

In diesem Artikel

Informationen zum Registrieren von GitHub Apps

Sie können eine GitHub App auf verschiedene Weise registrieren.

  • Unter Ihrem persönlichen Konto.
  • Unter einer -Organisation, die Sie besitzen.
  • Unter einer Organisation, die Ihnen die Berechtigung zum Verwalten aller zugehörigen Apps erteilt hat. Weitere Informationen findest du unter Hinzufügen und Entfernen von GitHub App-Managern in Ihrer Organisation.
  • Unter deinem Unternehmen; kann jedoch nur für -Organisationen innerhalb des Unternehmens installiert werden.

Registrieren einer GitHub App

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

  2. Navigieren Sie zu den Einstellungen für Ihr 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 Sie auf Ihre Organisationen.
      2. Klicken Sie rechts neben der Organisation auf Einstellungen.
    • Für eine App im Besitz eines Unternehmens:
      1. Klicken Sie auf Enterprise-Einstellungen.

  3. Navigieren Sie zu den GitHub App-Einstellungen.

    • Für eine App, die einem persönlichen Konto oder einer Organisation gehört:
      1. Klicke in der linken Randleiste auf Developer settings und dann auf GitHub Apps.
    • Für eine App im Besitz eines Unternehmens:
      1. Klicken Sie in der linken Randleiste auf Einstellungen, und dann auf GitHub Apps.

  4. Klicken Sie auf Neue GitHub App .

  5. Geben Sie unter „Name der GitHub App“ einen Namen für Ihre App ein. Du solltest einen klaren und kurzen Namen auswählen. Der Name darf nicht länger als 34 Zeichen sein. 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. Sie können nicht den gleichen Namen wie für ein vorhandenes GitHub-Konto verwenden, es sei denn, es handelt sich um den eigenen Benutzer- oder Organisationsnamen.

  6. Gib optional unter „Beschreibung“ eine Beschreibung für deine App ein. Benutzenden wird diese Beschreibung angezeigt, wenn sie deine App installieren.

  7. 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 des Kontos verwenden, das die App besitzt.

  8. 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 findest du unter Authentifizieren mit einer GitHub App im Namen eines Benutzers und Generieren eines Benutzerzugriffstokens für eine GitHub App.

  9. 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.

  10. 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 eines Benutzers und Generieren eines Benutzerzugriffstokens für eine GitHub App.

  11. Optional kannst du, falls du den Gerätefluss zum Generieren eines Benutzerzugriffstokens verwenden möchtest, Gerätefluss aktivieren auswählen. Weitere Informationen finden Sie unter Generieren eines Benutzerzugriffstokens für eine GitHub App.

  12. 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 finden Sie 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.

  13. 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.

  14. 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 finden Sie unter Verwenden von Webhooks mit GitHub Apps.

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

  16. Optional, wenn du im vorherigen Schritt Aktiv ausgewählt hast, gib unter "Webhook-Geheimnis" ein geheimes Token ein, um deine Webhooks zu schützen. GitHub empfiehlt dringend, ein Webhook-Geheimnis festzulegen. Weitere Informationen finden Sie unter Verwenden von Webhooks mit GitHub Apps.

  17. 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.

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

  19. 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 Webhook-Nutzlasten.

  20. Wählen Sie unter „Wo kann diese GitHub App installiert werden?“ Nur auf diesem Konto oder Beliebiges Konto aus. Weitere Informationen zu Installationsoptionen findest du unter Erstellen einer GitHub App öffentlich oder privat.

    Hinweis

    Wenn Ihre GitHub App unter einem Unternehmen registriert ist, gilt dieser Schritt nicht.

  21. Klicken Sie 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:

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/quickstart)

  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-github-app-that-responds-to-webhook-events)

  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-login-with-github-button-with-a-github-app)

  •         [AUTOTITLE](/apps/creating-github-apps/guides/building-a-cli-with-a-github-app)

  •         [AUTOTITLE](/apps/creating-github-apps/writing-code-for-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)

Du solltest versuchen, bewährten Methoden zu folgen. Weitere Informationen finden Sie unter Bewährte Methoden zum 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 Ihrer eigenen GitHub App und Freigeben deiner GitHub-App.

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