Skip to content

init: oauth docs #2565

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 4 commits into from
Jun 22, 2022
Merged

init: oauth docs #2565

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76ae807
init: oauth docs
ericpaulsen Jun 21, 2022
0607e8c
chore: update directories
ericpaulsen Jun 21, 2022
5720279
update: feedback
ericpaulsen Jun 22, 2022
7de4c98
fix: conflicts
ericpaulsen Jun 22, 2022
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
Next Next commit
init: oauth docs
  • Loading branch information
@ericpaulsen
ericpaulsen committed Jun 21, 2022
commit 76ae807243cfe5a7491ec46b498425248bb6d2b6
38 changes: 38 additions & 0 deletions docs/oauth.md
View file
Open in desktop
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:

- **Homepage URL**: Set to your Coder domain, e.g. `https://coder.domain.com`
- **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
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:

```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.