Skip to content

chore(docs): make external auth docs easier to follow #12970

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 5 commits into from
Apr 20, 2024
Merged

chore(docs): make external auth docs easier to follow #12970

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9b4e4c4
add additional context to github external auth provider documentation
doodzik Apr 16, 2024
00cd35e
Apply suggestions from code review
doodzik Apr 16, 2024
9e8b403
Update docs/admin/external-auth.md
doodzik Apr 16, 2024
d71024d
fmt
doodzik Apr 19, 2024
fd943a4
fmt
kylecarbs Apr 20, 2024
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
Apply suggestions from code review 
Co-authored-by: Kyle Carberry <kyle@carberry.com>
  • Loading branch information
@doodzik @kylecarbs
doodzik and kylecarbs authored Apr 16, 2024
commit 00cd35effb5adc6261ed22c67ea14ec2f33c51d6
12 changes: 6 additions & 6 deletions docs/admin/external-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ application. The following providers are supported:
The next step is to [configure the Coder server](./configure.md) to use the OAuth application by setting the following environment variables:

```env
CODER_EXTERNAL_AUTH_0_ID="USER_DEFINED"
CODER_EXTERNAL_AUTH_0_ID="USER_DEFINED_ID"
CODER_EXTERNAL_AUTH_0_TYPE=<github|gitlab|azure-devops|bitbucket-cloud|bitbucket-server|etc>
CODER_EXTERNAL_AUTH_0_CLIENT_ID=xxxxxx
CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=xxxxxxx
Expand All @@ -38,15 +38,15 @@ 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 to an arbitrary ID (e.g., `primary-github` for your GitHub provider).
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).


### GitHub

> If you don't fined-grained control you can configure a GitHub OAuth app, which is less overhead.
> If you don't require fine-grained access control, it's easier to configure a GitHub OAuth app!

1. [Create a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)
* Set the callback URL to `https://coder.example.com/external-auth/primary-github/callback`.
* Set the callback URL to `https://coder.example.com/external-auth/USER_DEFINED_ID/callback`.
* Deactivate Webhooks.
* Enable fine-grained access to specific repositories or a subset of
permissions for security.
Expand All @@ -72,7 +72,7 @@ The `CODER_EXTERNAL_AUTH_0_ID` environment variable is used for internal referen
![Install GitHub App](../images/admin/github-app-install.png)

```env
CODER_EXTERNAL_AUTH_0_ID="primary-github"
CODER_EXTERNAL_AUTH_0_ID="USER_DEFINED_ID"
CODER_EXTERNAL_AUTH_0_TYPE=github
CODER_EXTERNAL_AUTH_0_CLIENT_ID=xxxxxx
CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=xxxxxxx
Expand Down Expand Up @@ -221,7 +221,7 @@ coder:
env:
# […]
- name: CODER_EXTERNAL_AUTH_0_ID
value: primary-github
value: USER_DEFINED_ID

- name: CODER_EXTERNAL_AUTH_0_TYPE
value: github
Expand Down
Loading