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

Show file tree
Hide file tree
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
inc suggestions from review
  • Loading branch information
@EdwardAngert
EdwardAngert committed Jan 7, 2025
commit 30a4221aad1834dd3742a5d0dd0b109c0505cbc1
13 changes: 8 additions & 5 deletions docs/admin/external-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ External authentication can also be used to integrate with external services
like JFrog Artifactory and others.

To add an external authentication provider, you'll need to create an OAuth
application. The following providers are supported:
application. The following providers have been tested and work with Coder:

- [GitHub](#github)
- [GitLab](https://docs.gitlab.com/ee/integration/oauth_provider.html)
- [BitBucket](https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/)
- [Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops)
- [Azure DevOps (via Entra ID)](https://learn.microsoft.com/en-us/entra/architecture/auth-oauth2)
- [BitBucket](https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/)
- [GitHub](#github)
- [GitLab](https://docs.gitlab.com/ee/integration/oauth_provider.html)

If you have experience with a provider that is not listed here, please [file an issue](https://github.com/coder/internal/issues/new?title=request%28docs%29%3A+external-auth+-+request+title+here%0D%0A
&labels=["customer-feedback","docs"]&body=doc%3A+%5Bexternal-auth%5D%28https%3A%2F%2Fcoder.com%2Fdocs%2Fadmin%2Fexternal-auth%29%0D%0A%0D%0Aplease+enter+your+request+here%0D%0A)

## Configuration

Expand Down Expand Up @@ -52,7 +55,7 @@ Inside your Terraform code, you now have access to authentication variables. Ref

### Workspace CLI

Use `coder external-auth` to access a token within the workspace:
Use [`external-auth`](../reference/cli/external-auth.md) in the Coder CLI to access a token within the workspace:

```shell
coder external-auth <USER_DEFINED_ID> access-token
Expand Down
4 changes: 2 additions & 2 deletions docs/admin/setup/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ If you are using the built-in PostgreSQL deployment and need to use `psql` (aka
the PostgreSQL interactive terminal), output the connection URL with the
following command:

```shell
coder server postgres-builtin-url
```console
$ coder server postgres-builtin-url
psql "postgres://coder@localhost:49627/coder?sslmode=disable&password=feU...yI1"
```

Expand Down
Loading