Skip to content
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

Merged
merged 4 commits into from Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/install/oauth.md
@@ -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
Copy link
Member

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

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
First, [https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/](register a GitHub OAuth app). GitHub will ask you for the following Coder parameters:


- **Homepage URL**: Set to your Coder domain, e.g. `https://coder.domain.com`
Copy link
Contributor

Choose a reason for hiding this comment

The 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`
- **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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note the Client ID and Client secret generated by GitHub. You will use these
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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
Alternatively, if you are running Coder as a system servide, 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once complete, run `sudo systemctl enable --now coder` to reboot Coder.
Once complete, run `sudo service coder restart` to restart Coder.

File renamed without changes.
9 changes: 7 additions & 2 deletions docs/manifest.json
Expand Up @@ -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.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Learn how to authenticate with GitHub.",
"description": "Learn how to set up OAuth using your GitHub organization.",

"path": "./install/oauth.md"
}
]
},
{
Expand Down