Skip to content

Commit 9bb8e5f

Browse files
committed
add step numbers
1 parent cea427b commit 9bb8e5f

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/admin/users/github-auth.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -62,30 +62,30 @@ CODER_OAUTH2_GITHUB_DEFAULT_PROVIDER_ENABLE=false
6262
6363
## Step 1: Configure the OAuth application in GitHub
6464

65-
First,
66-
[register a GitHub OAuth app](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/).
67-
GitHub will ask you for the following Coder parameters:
65+
1. [Register a GitHub OAuth app](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/).
6866

69-
- **Homepage URL**: Set to your Coder deployments
70-
[`CODER_ACCESS_URL`](../../reference/cli/server.md#--access-url) (e.g.
71-
`https://coder.domain.com`)
72-
- **User Authorization Callback URL**: Set to `https://coder.domain.com`
67+
1. GitHub will ask you for the following Coder parameters:
7368

74-
If you want to allow multiple Coder deployments hosted on subdomains, such as
75-
`coder1.domain.com`, `coder2.domain.com`, to authenticate with the
76-
same GitHub OAuth app, then you can set **User Authorization Callback URL** to
77-
the `https://domain.com`
69+
- **Homepage URL**: Set to your Coder deployment's
70+
[`CODER_ACCESS_URL`](../../reference/cli/server.md#--access-url) (e.g.
71+
`https://coder.domain.com`)
72+
- **User Authorization Callback URL**: Set to `https://coder.domain.com`
7873

79-
Take note of the Client ID and Client Secret generated by GitHub. You will use these
80-
values in the next step.
74+
If you want to allow multiple Coder deployments hosted on subdomains, such as
75+
`coder1.domain.com`, `coder2.domain.com`, to authenticate with the
76+
same GitHub OAuth app, then you can set **User Authorization Callback URL** to
77+
the `https://domain.com`
8178

82-
Coder will need permission to access user email addresses. Find the "Account
83-
Permissions" settings for your app and select "read-only" for "Email addresses".
79+
1. Take note of the Client ID and Client Secret generated by GitHub.
80+
You will use these values in the next step.
81+
82+
1. Coder needs permission to access user email addresses.
83+
84+
Find the **Account Permissions** settings for your app and select **read-only** for **Email addresses**.
8485

8586
## Step 2: Configure Coder with the OAuth credentials
8687

87-
Navigate to your Coder host and run the following command to start up the Coder
88-
server:
88+
Go to your Coder host and run the following command to start up the Coder server:
8989

9090
```shell
9191
coder server --oauth2-github-allow-signups=true --oauth2-github-allowed-orgs="your-org" --oauth2-github-client-id="8d1...e05" --oauth2-github-client-secret="57ebc9...02c24c"

0 commit comments

Comments
 (0)