mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: add redirect URL override for external auth (#28082)
This commit is contained in:
@@ -43,6 +43,27 @@ Set it with a value that helps you identify the provider.
|
||||
For example, if you use `CODER_EXTERNAL_AUTH_0_ID="primary-github"` for your GitHub provider,
|
||||
configure your callback URL as `https://example.com/external-auth/primary-github/callback`.
|
||||
|
||||
By default, the redirect URL is built from the access URL Coder is configured
|
||||
with. You can override the base URL with:
|
||||
|
||||
```dotenv
|
||||
CODER_EXTERNAL_AUTH_0_REDIRECT_URL=https://my.tld
|
||||
```
|
||||
|
||||
This would change the callback in the above example to
|
||||
`https://my.tld/external-auth/primary-github/callback` (any path component on
|
||||
the redirect URL is ignored).
|
||||
|
||||
Using this setting can break OAuth, so use with caution. The override is
|
||||
intended to be used when the access URL is internal and either:
|
||||
|
||||
- Users access Coder via some other URL that proxies to the internal one.
|
||||
- The redirect URL redirects to the internal access URL (this can be used to
|
||||
work around providers that require public domains for the callback).
|
||||
|
||||
Ultimately, the user must end up on the same domain they were on when the
|
||||
authentication flow was initiated.
|
||||
|
||||
### Add an authentication button to the workspace template
|
||||
|
||||
Add the following code to any template to add a button to the workspace setup page which will allow you to authenticate with your provider:
|
||||
|
||||
Reference in New Issue
Block a user