init: oauth docs #2565
Merged
init: oauth docs #2565
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bpmct
approved these changes
Jun 22, 2022
docs/install/oauth.md
Outdated
Comment on lines
9
to
10
| 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.
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: |
docs/install/oauth.md
Outdated
Comment on lines
27
to
29
| 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.
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: |
docs/install/oauth.md
Outdated
| 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.
Suggested change
| Once complete, run `sudo systemctl enable --now coder` to reboot Coder. | |
| Once complete, run `sudo service coder restart` to restart Coder. |
docs/manifest.json
Outdated
| }, | ||
| { | ||
| "title": "GitHub OAuth", | ||
| "description": "Learn how to authenticate with GitHub.", |
There was a problem hiding this comment.
Suggested change
| "description": "Learn how to authenticate with GitHub.", | |
| "description": "Learn how to set up OAuth using your GitHub organization.", |
| # 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 |
There was a problem hiding this comment.
Does this work with GitHub Enterprise or just GitHub? Might be nice to specify ;)
cc @kylecarbs
khorne3
reviewed
Jun 22, 2022
docs/install/oauth.md
Outdated
| 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` |
There was a problem hiding this comment.
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`) |
docs/install/oauth.md
Outdated
| - **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 |
There was a problem hiding this comment.
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 |
khorne3
approved these changes
Jun 22, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adds new docs on how to configure GitHub OAuth.