Wenn du eine GitHub App registrierst, kannst du eine Setup-URL angeben. Wenn Benutzerinnen deine 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 Benutzerinnen 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.
Warning
Wenn GitHub Benutzer zur Setup-URL weiterleitet, wird ein installation_id-Abfrageparameter mitgesendet. 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 solltest du ein Benutzerzugriffstoken für den Benutzer oder die Benutzerin generieren, der/die GitHub App installiert hat, und dann überprüfen, ob die Installation diesem Benutzer/dieser Benutzerin zugeordnet ist. Weitere Informationen finden Sie unter Generieren eines Benutzerzugriffstokens für eine GitHub-App.
Die Setup-URL ist zwar bei der GitHub App-Registrierung optional, aber sie wird benötigt, wenn du Benutzer*innen erlauben möchtest, deine App im GitHub Marketplace zu erwerben. Weitere Informationen finden Sie unter Behandeln neuer Käufe und kostenloser Testperioden.
Die Setup-URL unterscheidet sich von der Rückruf-URL. Benutzerinnen werden zur Setup-URL umgeleitet, nachdem sie die GitHub App installiert haben. Benutzerinnen werden an die Rückruf-URL umgeleitet, wenn sie eine GitHub App über den Webanwendungsfluss autorisieren. Weitere Informationen finden Sie unter Informationen zur Rückruf-URL für die Benutzerautorisierung.
Weitere Informationen zum Registrieren einer GitHub App findest du unter Registrieren einer GitHub-App. Weitere Informationen zum Ändern einer GitHub App-Registrierung findest du unter Ändern einer GitHub-App-Registrierung.