-
Notifications
You must be signed in to change notification settings - Fork 889
(Do not merge) Add docs for Vercel provider #2837
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
Open
brkalow
wants to merge
8
commits into
main
Choose a base branch
from
brk.feat/vercel-social-connection
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+78
−0
Open
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
0e17efd
Add docs for Vercel provider
brkalow e037c0f
Apply suggestion from @brkalow
brkalow 4758c96
format
brkalow e163217
exclude file from manifest check
brkalow b69bf6c
Update docs/guides/configure/auth-strategies/social-connections/verce…
brkalow d3f5b09
Address PR feedback
brkalow 9112d87
Update docs/guides/configure/auth-strategies/social-connections/verce…
brkalow b2d345e
Tweak wording
brkalow File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
69 changes: 69 additions & 0 deletions
69
docs/guides/configure/auth-strategies/social-connections/vercel.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| title: Add Vercel as a social connection | ||
| description: Learn how to allow users to sign up and sign in to your Clerk app with their Vercel account using OAuth. | ||
|
|
||
| --- | ||
|
|
||
| <TutorialHero | ||
| beforeYouStart={[ | ||
| { | ||
| title: "A Clerk app is required.", | ||
| link: "/docs/getting-started/quickstart/setup-clerk", | ||
| icon: "clerk", | ||
| }, | ||
| { | ||
| title: "A Vercel account is required.", | ||
| link: "https://vercel.com/signup", | ||
| icon: "user-circle", | ||
| }, | ||
| ]} | ||
| /> | ||
|
|
||
| Enabling OAuth with [Vercel](https://vercel.com/docs/sign-in-with-vercel) allows your users to sign up and sign in to your Clerk app with their Vercel account. | ||
|
|
||
| ## Configure for your development instance | ||
|
|
||
| For _development instances_, Clerk uses preconfigured shared OAuth credentials and redirect URIs—no other configuration is needed. | ||
|
|
||
| 1. In the Clerk Dashboard, navigate to the [**SSO connections**](https://dashboard.clerk.com/~/user-authentication/sso-connections) page. | ||
| 1. Select **Add connection** and select **For all users**. | ||
| 1. In the **Choose provider** dropdown, select **Vercel**. | ||
| 1. Select **Add connection**. | ||
|
|
||
| ## Configure for your production instance | ||
|
|
||
| For _production instances_, you must provide custom credentials. | ||
|
|
||
| To make the setup process easier, it's recommended to keep two browser tabs open: one for the [Clerk Dashboard](https://dashboard.clerk.com/~/user-authentication/sso-connections) and one for your [Vercel team settings](https://vercel.com/account). | ||
|
|
||
| <Steps> | ||
| ### Enable Vercel as a social connection in Clerk | ||
|
|
||
| 1. In the Clerk Dashboard, navigate to the [**SSO connections**](https://dashboard.clerk.com/~/user-authentication/sso-connections) page. | ||
| 1. Select **Add connection** and choose **For all users**. | ||
| 1. In the **Choose provider** dropdown, select **Vercel**. | ||
| 1. Ensure that both **Enable for sign-up and sign-in** and **Use custom credentials** are toggled on. | ||
| 1. Save the **Authorization Callback URL** somewhere secure. Keep the modal and page open. | ||
|
|
||
| ### Create a Vercel app | ||
|
|
||
| 1. In your Vercel dashboard, navigate to your team's **Settings** tab. | ||
| 1. Scroll down and select **Apps**, then select **Create**. | ||
| 1. Enter a **Name** and **Slug** for your app. | ||
| 1. Optionally, upload a logo for your app. | ||
brkalow marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Select **Save**. | ||
| 1. Under **Client Authentication Method**, select the appropriate method for your app. For server-side applications, `client_secret_basic` or `client_secret_post` are recommended. | ||
SarahSoutoul marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Select **Generate** to create a client secret. Save the **Client ID** and **Client Secret** somewhere secure. | ||
SarahSoutoul marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Scroll to **Authorization Callback URLs** and add the **Authorization Callback URL** you saved from the Clerk Dashboard. | ||
SarahSoutoul marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Navigate to the **Permissions** tab and enable the scopes your app needs (e.g., `openid`, `email`, `profile`). | ||
brkalow marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Select **Save**. | ||
|
|
||
| ### Set the Client ID and Client Secret in the Clerk Dashboard | ||
|
|
||
| <Include src="_partials/authentication/social-connections/set-client-id-secret" /> | ||
|
|
||
| ### Test your connection | ||
|
|
||
| <Include src="_partials/authentication/social-connections/test-your-connection" /> | ||
| </Steps> | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.