Wenn Sie eine GitHub AppRegistrierung durchführen, können Sie eine Setup-URL angeben. Wenn Nutzer Ihr GitHub App installieren, werden sie zur Setup-URL umgeleitet. Wenn nach der Installation ein zusätzliches Setup erforderlich ist, kannst du diese URL verwenden, um Benutzer*innen mitzuteilen, welche Schritte als Nächstes ausgeführt werden müssen.
Wenn du eine Setup-URL angibst, kannst du auch Bei Update umleiten auswählen, um anzugeben, dass Benutzer nach dem Aktualisieren einer Installation zur Setup-URL umgeleitet werden sollen. Ein Update umfasst das Hinzufügen oder Entfernen des Zugriffs auf ein Repository für eine Installation.
Warnung
Wenn GitHub Benutzer an die Einrichtungs-URL weiterleitet, enthält sie einen installation_id Abfrageparameter. Böswillige Personen können diese URL mit einer gefälschten installation_id ausnutzen. Daher solltest du dich nicht auf die Gültigkeit des installation_id-Parameters verlassen. Stattdessen sollten Sie ein Benutzerzugriffstoken für den Benutzer generieren, der die GitHub App Installation installiert hat, und dann überprüfen, ob die Installation diesem Benutzer zugeordnet ist. Weitere Informationen finden Sie unter Generieren eines Benutzerzugriffstokens für eine GitHub App.
Obwohl die Setup-URL bei der Registrierung über GitHub App optional ist, ist sie erforderlich, wenn Sie Benutzern erlauben möchten, Ihre App in GitHub Marketplace zu kaufen. Weitere Informationen finden Sie unter Verwaltung von neuen Käufen und kostenlosen Testversionen.
Die Setup-URL unterscheidet sich von der Rückruf-URL. Benutzer werden nach der Installation eines GitHub App zur Einrichtungs-URL weitergeleitet. Benutzer werden an die Callback-URL umgeleitet, wenn sie einen GitHub App über den Webanwendungs-Flow autorisieren. Weitere Informationen finden Sie unter Informationen zur Rückruf-URL für die Benutzerautorisierung.
Weitere Informationen zum Registrieren eines GitHub AppEintrags finden Sie unter Registrieren einer GitHub-App. Weitere Informationen zum Ändern einer GitHub App Registrierung finden Sie unter Ändern einer GitHub App-Registrierung.