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

(/authentication/social-connections/github) update guide #1602

Merged
merged 20 commits into from
Oct 11, 2024
Merged
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
526181c
change title
victoriaxyz Oct 4, 2024
6416a97
draft
victoriaxyz Oct 4, 2024
ca049f0
Merge branch 'main' into vi/docs-363/oauth-github
victoriaxyz Oct 8, 2024
43ddb26
Merge branch 'main' into vi/docs-363/oauth-github
victoriaxyz Oct 9, 2024
04e7bcb
update
victoriaxyz Oct 9, 2024
21b6cce
Merge branch 'main' into vi/docs-363/oauth-github
victoriaxyz Oct 9, 2024
650aa9e
Update docs/authentication/social-connections/github.mdx
victoriaxyz Oct 9, 2024
4e94904
Update docs/authentication/social-connections/github.mdx
victoriaxyz Oct 9, 2024
09382cd
Update docs/authentication/social-connections/github.mdx
victoriaxyz Oct 10, 2024
3e71d72
Update docs/authentication/social-connections/github.mdx
victoriaxyz Oct 10, 2024
32ff4f5
Update docs/authentication/social-connections/github.mdx
victoriaxyz Oct 10, 2024
67e0de7
Update docs/authentication/social-connections/github.mdx
victoriaxyz Oct 10, 2024
514da1c
Update docs/authentication/social-connections/github.mdx
victoriaxyz Oct 10, 2024
4725c13
Merge branch 'main' into vi/docs-363/oauth-github
victoriaxyz Oct 10, 2024
88282e1
Merge branch 'main' into vi/docs-363/oauth-github
victoriaxyz Oct 10, 2024
8b98b76
update
victoriaxyz Oct 10, 2024
0e32e6b
fix
victoriaxyz Oct 10, 2024
77a91de
Merge branch 'main' into vi/docs-363/oauth-github
victoriaxyz Oct 10, 2024
9824905
Update docs/authentication/social-connections/github.mdx
alexisintech Oct 11, 2024
4a2e32e
Update docs/authentication/social-connections/github.mdx
alexisintech Oct 11, 2024
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
18 changes: 10 additions & 8 deletions docs/authentication/social-connections/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,24 +39,26 @@ For _production instances_, you must provide custom credentials which involves g
To make the setup process easier, it's recommended to keep two browser tabs open: one for your [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) and one for your [GitHub Developers](https://GitHub.com/developers/applications) page.

<Steps>
### Create a GitHub app

1. On a separate page, go to [GitHub's Developer Settings](https://github.com/settings/apps).
1. In the sidebar, select **OAuth Apps**, then select [**New OAuth app**](https://github.com/settings/applications/new). You'll be redirected to the **Register a new OAuth app** form. Keep this page open.

### Enable GitHub as a social connection in Clerk

1. In the Clerk Dashboard, navigate to the [**SSO Connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page.
1. Select **Add connection** and choose **For all users**.
1. In the **Choose provider** dropdown, select **GitHub**.
1. Ensure that both **Enable for sign-up and sign-in** and **Use custom credentials** are toggled on.
1. Copy the **Authorized redirect URI**.
1. Navigate back to your GitHub app's page. In **Authorization callback URL**, paste the **Authorized redirect URI** value you copied.
1. Save the **Authorized redirect URI** somewhere secure. Keep the modal and page open.

### Create a GitHub app

1. On a separate page, go to [GitHub's Developer Settings](https://github.com/settings/apps).
1. In the sidebar, select **OAuth Apps**, then select [**New OAuth app**](https://github.com/settings/applications/new). You'll be redirected to the **Register a new OAuth app** form.
1. Enter your **Application name** and **Homepage URL**.
1. In **Authorization callback URL**, paste the **Authorized Redirect URI** you saved from the Clerk Dashboard.
1. Select **Register application**. You'll be redirected to your GitHub app's **General** page.
1. Select **Generate a new client secret**. Save your **Client ID** and **Client secret** somewhere secure. Keep the modal and page open.
1. Select **Generate a new client secret**.
Copy link
Member

Choose a reason for hiding this comment

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

should we move this to the next step? see the next comment

alexisintech marked this conversation as resolved.
Show resolved Hide resolved

### Set the Client ID and Client Secret in your Clerk Dashboard

1. In the GitHub app's **General** page, save your **Client ID** and **Client secret** somewhere secure.
alexisintech marked this conversation as resolved.
Show resolved Hide resolved
1. Navigate back to your Clerk Dashboard where the modal should still be open and paste these values into the respective fields.
1. Select **Add connection**.

Expand Down
Loading