mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
docs: mention making the GitHub App public and APP_INSTALL_URL (#25188)
## Summary The GitHub App walkthrough in `docs/admin/external-auth/index.md` stops after \"install the app for your organization,\" which is enough for the admin who created the app but not for anyone else. Every other Coder user hitting **Link GitHub** lands on a GitHub 404 (`This is not the web page you are looking for`) because: 1. New GitHub Apps default to **\"Only on this account\"** / not public. GitHub returns 404 from the OAuth-authorize URL for any user other than the owner. 2. `CODER_EXTERNAL_AUTH_0_APP_INSTALL_URL` — the env var that makes Coder render an \"Install GitHub App\" link in the UI — is undocumented today. This PR adds one extra step at the end of the GitHub App configuration walkthrough covering both. ## Test plan - [x] \`make fmt/markdown\` clean - [x] Doc reviewer eyes
This commit is contained in:
@@ -334,6 +334,19 @@ CODER_EXTERNAL_AUTH_0_SCOPES="repo:read repo:write write:gpg_key"
|
||||
|
||||

|
||||
|
||||
1. Make the app installable by other users. In the app's **Advanced**
|
||||
tab, select **Make this GitHub App public**.
|
||||
|
||||
Without this, anyone outside the app's owning account or owning
|
||||
organization gets a GitHub 404 when they select **Link GitHub** in
|
||||
Coder. Each user must also install the app on their own account
|
||||
before linking. To surface an **Install GitHub App** link in the
|
||||
Coder UI, set the following environment variable:
|
||||
|
||||
```env
|
||||
CODER_EXTERNAL_AUTH_0_APP_INSTALL_URL=https://github.com/apps/<your-app-slug>/installations/new
|
||||
```
|
||||
|
||||
## Multiple External Providers (Premium)
|
||||
|
||||
Below is an example configuration with multiple providers:
|
||||
|
||||
Reference in New Issue
Block a user