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.
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
init: oauth docs #2565
init: oauth docs #2565
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,38 @@ | ||||||||||||||
# GitHub OAuth | ||||||||||||||
|
||||||||||||||
By default, Coder is accessible via built-in authentication. Alternatively, you | ||||||||||||||
can configure Coder to enable logging in through GitHub OAuth. See below for | ||||||||||||||
configuration steps. | ||||||||||||||
|
||||||||||||||
## Step 1: Configure the OAuth application in GitHub | ||||||||||||||
|
||||||||||||||
When [https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/](creating an OAuth app), | ||||||||||||||
GitHub will ask you for the following Coder parameters: | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
||||||||||||||
- **Homepage URL**: Set to your Coder domain, e.g. `https://coder.domain.com` | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
- **User Authorization Callback URL**: Set to `https://coder.domain.com/api/v2/users/oauth2/github/callback` | ||||||||||||||
|
||||||||||||||
Note the Client ID and Client secret generated by GitHub. You will use these | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
values in the next step. | ||||||||||||||
|
||||||||||||||
## Step 2: Configure Coder with the OAuth credentials | ||||||||||||||
|
||||||||||||||
Navigate to your Coder host and run the following command to start up the Coder | ||||||||||||||
server: | ||||||||||||||
|
||||||||||||||
```console | ||||||||||||||
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" | ||||||||||||||
``` | ||||||||||||||
|
||||||||||||||
Alternatively, if you already have a running Coder instance, you can achieve the | ||||||||||||||
same result as the command above by adding the following environment variables | ||||||||||||||
to the `/etc/coder.d/coder.env` file: | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
||||||||||||||
```console | ||||||||||||||
CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS=true | ||||||||||||||
CODER_OAUTH2_GITHUB_ALLOWED_ORGS="your-org" | ||||||||||||||
CODER_OAUTH2_GITHUB_CLIENT_ID="8d1...e05" | ||||||||||||||
CODER_OAUTH2_GITHUB_CLIENT_SECRET="57ebc9...02c24c" | ||||||||||||||
``` | ||||||||||||||
|
||||||||||||||
Once complete, run `sudo systemctl enable --now coder` to reboot Coder. | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -26,8 +26,13 @@ | |||||
{ | ||||||
"title": "Postgres", | ||||||
"description": "Learn how to create and use your own Postgres database.", | ||||||
"path": "./postgres.md" | ||||||
} | ||||||
"path": "./install/postgres.md" | ||||||
}, | ||||||
{ | ||||||
"title": "GitHub OAuth", | ||||||
"description": "Learn how to authenticate with GitHub.", | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
"path": "./install/oauth.md" | ||||||
} | ||||||
] | ||||||
}, | ||||||
{ | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this work with GitHub Enterprise or just GitHub? Might be nice to specify ;)
cc @kylecarbs