Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit b5b7938

Browse files
author
Katie Horne
committed
Minor fixes
1 parent 44100e4 commit b5b7938

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

guides/troubleshooting/git-oauth.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,34 @@
11
---
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.
44
---
55

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:
88

99
![Failed to link](../../assets/guides/troubleshooting/oauth-error.png)
1010

1111
## Why this happens
1212

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

1717
## Solution
1818

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

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**.
2324

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:
2627

2728
```console
2829
Successfully linked to GitHub account <your-GitHub-username>
2930
```
3031

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

Comments
 (0)