Skip to content

Commit d71024d

Browse files
authored
fmt
1 parent 9e8b403 commit d71024d

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

docs/admin/external-auth.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ application. The following providers are supported:
2525
- [Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops)
2626
- [Azure DevOps (via Entra ID)](https://learn.microsoft.com/en-us/entra/architecture/auth-oauth2)
2727

28-
The next step is to [configure the Coder server](./configure.md) to use the OAuth application by setting the following environment variables:
28+
The next step is to [configure the Coder server](./configure.md) to use the
29+
OAuth application by setting the following environment variables:
2930

3031
```env
3132
CODER_EXTERNAL_AUTH_0_ID="<USER_DEFINED_ID>"
@@ -38,18 +39,22 @@ CODER_EXTERNAL_AUTH_0_DISPLAY_NAME="Google Calendar"
3839
CODER_EXTERNAL_AUTH_0_DISPLAY_ICON="https://mycustomicon.com/google.svg"
3940
```
4041

41-
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).
42+
The `CODER_EXTERNAL_AUTH_0_ID` environment variable is used for internal
43+
reference. Therefore, it can be set arbitrarily (e.g., `primary-github` for your
44+
GitHub provider).
4245

4346

4447
### GitHub
4548

46-
> If you don't require fine-grained access control, it's easier to configure a GitHub OAuth app!
49+
> If you don't require fine-grained access control, it's easier to configure a
50+
> GitHub OAuth app!
4751
4852
1. [Create a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)
49-
* Set the callback URL to `https://coder.example.com/external-auth/USER_DEFINED_ID/callback`.
50-
* Deactivate Webhooks.
51-
* Enable fine-grained access to specific repositories or a subset of
52-
permissions for security.
53+
- Set the callback URL to
54+
`https://coder.example.com/external-auth/USER_DEFINED_ID/callback`.
55+
- Deactivate Webhooks.
56+
- Enable fine-grained access to specific repositories or a subset of
57+
permissions for security.
5358

5459
![Register GitHub App](../images/admin/github-app-register.png)
5560

@@ -215,7 +220,9 @@ git config --global credential.useHttpPath true
215220

216221
### Kubernetes environment variables
217222

218-
If you deployed Coder with Kubernetes you can set the environment variables in your `values.yaml` file:
223+
If you deployed Coder with Kubernetes you can set the environment variables in
224+
your `values.yaml` file:
225+
219226
```yaml
220227
coder:
221228
env:
@@ -239,7 +246,8 @@ coder:
239246
key: client-secret
240247
```
241248
242-
You can set the secrets by creating a `github-primary-basic-auth.yaml` file and applying it.
249+
You can set the secrets by creating a `github-primary-basic-auth.yaml` file and
250+
applying it.
243251

244252
```yaml
245253
apiVersion: v1

0 commit comments

Comments
 (0)