Skip to content

Commit 57578cf

Browse files
docs: document AUTH_EE_* identity provider removal in v4-to-v5 guide
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 014d1b4 commit 57578cf

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

docs/docs/upgrade/v4-to-v5-guide.mdx

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,67 @@ docker exec sourcebot rm /data/.sourcebot/.secret /data/.sourcebot/.authjs-secre
176176
Sourcebot warns at startup if either file is still present.
177177
</Expandable>
178178

179+
### Identity providers must be configured via the config file
180+
<Note>
181+
**Who's affected:** Deployments that configure GitHub, GitLab, Google, Okta, Keycloak, or Microsoft Entra ID single sign-on through the deprecated `AUTH_EE_*` environment variables. Deployments that already define these providers in the [`identityProviders`](/docs/configuration/idp) config file section are not affected. GCP IAP (`AUTH_EE_GCP_IAP_ENABLED` and `AUTH_EE_GCP_IAP_AUDIENCE`) is not affected.
182+
</Note>
183+
184+
#### Description
185+
186+
In v4, you could configure these identity providers using `AUTH_EE_*` environment variables (for example `AUTH_EE_GITHUB_CLIENT_ID`). Those variables were deprecated in favor of the [`identityProviders`](/docs/configuration/idp) section of the config file. Starting in v5, the environment variable path has been removed. Sourcebot no longer reads these variables, and any provider configured only through them will stop appearing on the login screen.
187+
188+
The following environment variables are no longer read:
189+
190+
| Provider | Removed environment variables |
191+
| :------- | :---------------------------- |
192+
| GitHub | `AUTH_EE_GITHUB_CLIENT_ID`, `AUTH_EE_GITHUB_CLIENT_SECRET`, `AUTH_EE_GITHUB_BASE_URL` |
193+
| GitLab | `AUTH_EE_GITLAB_CLIENT_ID`, `AUTH_EE_GITLAB_CLIENT_SECRET`, `AUTH_EE_GITLAB_BASE_URL` |
194+
| Google | `AUTH_EE_GOOGLE_CLIENT_ID`, `AUTH_EE_GOOGLE_CLIENT_SECRET` |
195+
| Okta | `AUTH_EE_OKTA_CLIENT_ID`, `AUTH_EE_OKTA_CLIENT_SECRET`, `AUTH_EE_OKTA_ISSUER` |
196+
| Keycloak | `AUTH_EE_KEYCLOAK_CLIENT_ID`, `AUTH_EE_KEYCLOAK_CLIENT_SECRET`, `AUTH_EE_KEYCLOAK_ISSUER` |
197+
| Microsoft Entra ID | `AUTH_EE_MICROSOFT_ENTRA_ID_CLIENT_ID`, `AUTH_EE_MICROSOFT_ENTRA_ID_CLIENT_SECRET`, `AUTH_EE_MICROSOFT_ENTRA_ID_ISSUER` |
198+
199+
#### Action Items
200+
201+
<Expandable title="Migrating to the config file">
202+
<br/>
203+
204+
Move each affected provider into the `identityProviders` array in your [config file](/docs/configuration/config-file). You don't need to rotate any secrets. Reference your existing environment variable values from the config using [tokens](/docs/configuration/config-file#tokens), keeping the same variable names if you like.
205+
206+
For example, a GitHub provider previously configured with environment variables:
207+
208+
```bash wrap icon="terminal"
209+
AUTH_EE_GITHUB_CLIENT_ID='your-client-id'
210+
AUTH_EE_GITHUB_CLIENT_SECRET='your-client-secret'
211+
```
212+
213+
becomes the following in the config file:
214+
215+
```json wrap icon="code"
216+
{
217+
"$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
218+
"identityProviders": [
219+
{
220+
"provider": "github",
221+
"purpose": "sso",
222+
"clientId": {
223+
"env": "AUTH_EE_GITHUB_CLIENT_ID"
224+
},
225+
"clientSecret": {
226+
"env": "AUTH_EE_GITHUB_CLIENT_SECRET"
227+
}
228+
}
229+
]
230+
}
231+
```
232+
233+
<Note>
234+
Set `purpose` to `sso` to keep the provider usable for login. For providers that take an issuer (Okta, Keycloak, Microsoft Entra ID), add an `issuer` token. For self-hosted GitHub or GitLab, add a `baseUrl` string (this replaces `AUTH_EE_GITHUB_BASE_URL` and `AUTH_EE_GITLAB_BASE_URL`).
235+
</Note>
236+
237+
See the [external identity providers](/docs/configuration/idp) docs for the full per-provider config reference.
238+
</Expandable>
239+
179240

180241
## Upgrading
181242

0 commit comments

Comments
 (0)