Skip to content

docs: update external auth to better explain process #16027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jan 7, 2025
Merged

docs: update external auth to better explain process #16027

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2db695b
docs: update external auth to better explain process (#15970)
ChristopherJTrent Jan 3, 2025
625f3ba
Merge remote-tracking branch 'origin/main' into 15970-external-auth-u…
EdwardAngert Jan 3, 2025
096326d
make lint/fmt
EdwardAngert Jan 3, 2025
85b8e36
md alignment
EdwardAngert Jan 3, 2025
cc0939a
external-auth intro from setup/index
EdwardAngert Jan 3, 2025
1cba651
Merge remote-tracking branch 'origin/main' into 15970-external-auth-u…
EdwardAngert Jan 6, 2025
e84811c
abc git providers
EdwardAngert Jan 6, 2025
b1f32b5
git providers to tabs
EdwardAngert Jan 6, 2025
1af84ed
Revert "git providers to tabs"
EdwardAngert Jan 6, 2025
1782454
parent heading to git providers
EdwardAngert Jan 6, 2025
db03ea0
highlight oauth provider in intro
EdwardAngert Jan 6, 2025
30a4221
inc suggestions from review
EdwardAngert Jan 7, 2025
411fb43
add issue link and align example variables
EdwardAngert Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
make lint/fmt
  • Loading branch information
@EdwardAngert
EdwardAngert committed Jan 3, 2025
commit 096326d019523dccf71b680d5540ce675014e0f8
7 changes: 4 additions & 3 deletions docs/admin/external-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=<OAuth app client secret>
CODER_EXTERNAL_AUTH_0_DISPLAY_NAME="Google Calendar"
CODER_EXTERNAL_AUTH_0_DISPLAY_ICON="https://mycustomicon.com/google.svg"
```

The `CODER_EXTERNAL_AUTH_0_ID` environment variable is used for internal
reference. Therefore, it can be set arbitrarily (e.g., `primary-github` for your
GitHub provider).
Expand All @@ -32,7 +33,7 @@ You can now add the following code to any template. This will add a button to th

```tf
data "coder_external_auth" "<github|gitlab|azure-devops|bitbucket-cloud|bitbucket-server|etc>" {
id = "<USER_DEFINED_ID>"
id = "<USER_DEFINED_ID>"
}

# Github Example (CODER_EXTERNAL_AUTH_0_ID="github-auth")
Expand All @@ -46,13 +47,13 @@ data "coder_external_auth" "github" {
Inside your terraform code, you now have access to authentication variables. Reference the documentation for your chosen provider for more information on how to supply it with a token.

### Workspace CLI

An access token can be accessed within the workspace by using

```
```shell
coder external-auth <USER_DEFINED_ID> access-token
```


## GitHub

> If you don't require fine-grained access control, it's easier to configure a
Expand Down
Loading