|
1 | 1 | ---
|
2 |
| -title: Troubleshooting GitHub OAuth integration |
3 |
| -description: Troubleshooting "Failed to link account" OAuth error |
| 2 | +title: GitHub OAuth integration |
| 3 | +description: Learn how to fix a "Failed to link account" OAuth error. |
4 | 4 | ---
|
5 | 5 |
|
6 |
| -When configuring the OAuth integration between Coder & GitHub, you |
7 |
| -may encounter the error below: |
| 6 | +When configuring the OAuth integration between Coder and GitHub, you may |
| 7 | +encounter the following error: |
8 | 8 |
|
9 | 9 | 
|
10 | 10 |
|
11 | 11 | ## Why this happens
|
12 | 12 |
|
13 |
| -This happens when your Coder public key has been uploaded to your |
14 |
| -GitHub profile prior to your attempt to link Coder & GitHub. The error is thrown |
15 |
| -due to the OAuth integration duplicating your public key in GitHub. |
| 13 | +This error occurs when your Coder public key has been uploaded to your GitHub |
| 14 | +profile; when you attempt to link Coder and GitHub, the OAuth integration |
| 15 | +attempts to add your public key again to GitHub. |
16 | 16 |
|
17 | 17 | ## Solution
|
18 | 18 |
|
19 |
| -1. Remove your Coder public key from your GitHub account |
| 19 | +1. [Remove your Coder public key](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/reviewing-your-ssh-keys) |
| 20 | + from your GitHub account. |
20 | 21 |
|
21 |
| -1. In Coder, navigate to **Account** > **Linked Accounts** and click |
22 |
| -**Link Your GitHub Account** |
| 22 | +1. In Coder, navigate to **Account** > **Linked Accounts** and click **Link Your |
| 23 | + GitHub Account**. |
23 | 24 |
|
24 |
| -1. If successful, you will be re-directed back to the account page, with a |
25 |
| - message in the bottom right corner stating: |
| 25 | +1. If successful, you will be re-directed back to the **Account** page. There |
| 26 | + will be a message in the bottom right corner that says: |
26 | 27 |
|
27 | 28 | ```console
|
28 | 29 | Successfully linked to GitHub account <your-GitHub-username>
|
29 | 30 | ```
|
30 | 31 |
|
31 |
| -If the above is not the source of the issue, then it may be |
32 |
| -related to your configuration values in Coder's Admin panel. To view such values |
33 |
| -navigate to **Manage** > **Admin** > **Git OAuth**. |
| 32 | +If the steps above do not fix the problem, the error may be related to the |
| 33 | +GitHub configuration values set using Coder's **Admin** panel. Site managers can |
| 34 | +view and update these values at **Manage** > **Admin** > **Git OAuth**. |
0 commit comments