Hinweis: Deine GitHub App hat Zugriff auf alle Repositorys, die die App erstellt, auch wenn sie nur in ausgewählten Repositorys installiert wird.
Installieren einer privaten GitHub-App in einem Repository
Wenn du eine private GitHub-App erstellt hast, kannst du sie in einem deiner Organisations- oder Benutzerrepositorys installieren. Weitere Informationen findest du unter Öffentlich- oder Privatmachen einer GitHub-App.
- Wähle deine App über die Einstellungsseite für GitHub-Apps aus.
- Klicke auf der linken Randleiste auf App installieren.
- Klicke neben dem Organisations- oder persönlichen Konto, das das entsprechende Repository enthält, auf Installieren.
- Wähle Alle Repositorys oder Nur Repositorys aus.
- Wenn du „Nur Repositorys auswählen“ ausgewählt hast, wähle das Dropdownmenü Repositorys auswählen aus, und klicke auf die Repositorys, in denen du die App installieren möchtest.
- Klicke auf Installieren. Nach der Installation werden Konfigurationsoptionen für die App in deinem ausgewählten Konto angezeigt. Du kannst hier Änderungen vornehmen oder die vorherigen Schritte wiederholen, um die App in einem anderen Konto zu installieren.
Erteilen der Benutzerberechtigung zum Installieren deiner öffentlichen App in einem Repository
Du kannst anderen ermöglichen, deine öffentliche App zu installieren, indem du die Installations-URL beispielsweise auf der Homepage deiner App angibst. Du kannst dann von der Landing Page auf GitHub auf die Homepage deiner App verweisen.
Wenn du von einer OAuth-App zu einer GitHub-App migrierst, kannst du Abfrageparameter verwenden, um die Repositorys und das Konto beim Installieren der GitHub-App vorab auszuwählen. Weitere Informationen findest du unter Migrieren von OAuth-Apps zu GitHub-Apps.
Für diese Schritte wird davon ausgegangen, dass du eine GitHub App erstellt hast:
- Wähle auf der Einstellungsseite für GitHub-Apps die öffentliche App aus, die du für das Installieren durch andere Benutzer*innen konfigurieren möchtest.
- Gib auf der Registerkarte „Allgemein“ unter „Homepage-URL“ die URL für die Homepage der App ein, und klicke auf Änderungen speichern.
- GitHub bietet eine Landing Page für deine App, die einen Link zur Homepage deiner App enthält. Du kannst die Landing Page auf GitHub aufrufen, indem du die URL aus „Öffentlicher Link“ kopierst und in einem Browser einfügst.
- Erstelle eine Homepage für deine App, die die Installations-URL für deine App enthält:
http(s)://HOSTNAME/github-apps/<app name>/installations/new.
Autorisieren von Benutzer*innen während der Installation
Du kannst den Autorisierungsprozess vereinfachen, indem du ihn während der App-Installation abschließt. Wähle hierfür Benutzerautorisierung während der Installation anfordern (OAuth) aus, wenn du deine App auf GitHub erstellst oder bearbeitest. Weitere Informationen findest du unter Erstellen einer GitHub-App.
Sobald eine Benutzerin deine App installiert hat, erhältst du ein Zugriffstoken für ihn oder sie. Weitere Informationen findest du unter Generieren eines Benutzerzugriffstokens für eine GitHub-App.
Beibehalten eines Anwendungszustands während der Installation
Du kannst einen state-Parameter in der Installations-URL einer App angeben, um den Zustand der Anwendungsseite beizubehalten und Benutzerinnen nach dem Installieren, Authentifizieren oder Akzeptieren von Updates für deine GitHub-App in diesen Zustand zurückzuversetzen. Beispielsweise kannst du state verwenden, um eine Installation mit Benutzerinnen oder Konten zu korrelieren.
Um einen Zustand beizubehalten, füge ihn der Installations-URL hinzu:
http(s)://HOSTNAME/github-apps/<app name>/installations/new?state=AB12t