mirror of
https://github.com/supabase/supabase.git
synced 2026-05-07 23:19:23 +08:00
69ce915a9e
This PR renames all `SUPABASE_PUBLISHABLE_OR_ANON_KEY` env vars into `SUPABASE_PUBLISHABLE_KEY` to make the new API keys default. This is in coordination with the rest of the docs. I've also cleaned up the `blocks/vue` package from unused files. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Breaking Changes** * Public environment variable names renamed from PUBLISHABLE_OR_ANON_KEY → PUBLISHABLE_KEY across all framework integrations; update your environment configs. * **Documentation** * All framework guides, .env examples and registry docs updated to use the new variable names. * **Chores** * Cleaned up UI registry/templates: some example Vue registry items and autogenerated registry artifacts were removed or simplified. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
62 lines
2.9 KiB
Plaintext
62 lines
2.9 KiB
Plaintext
---
|
||
title: Social Authentication
|
||
description: Social authentication block for Tanstack Start
|
||
---
|
||
|
||
<BlockPreview name="social-auth/auth/login" />
|
||
|
||
<Callout className="mt-4">
|
||
The block is using GitHub provider by default, but can be easily switched by changing a single
|
||
parameter.
|
||
</Callout>
|
||
|
||
## Installation
|
||
|
||
<BlockItem name="social-auth-nextjs" description="All needed components for the social auth flow" />
|
||
|
||
## Folder structure
|
||
|
||
This block includes the [Supabase client](/ui/docs/tanstack/client). If you already have one installed, you can skip overwriting it.
|
||
|
||
<RegistryBlock itemName="social-auth-tanstack" />
|
||
|
||
## Usage
|
||
|
||
Once you install the block in your Tanstack Start project, you'll get all the necessary pages and components to set up a social authentication flow.
|
||
|
||
### Getting started
|
||
|
||
After installing the block, you'll have the following environment variables in your `.env.local` file:
|
||
|
||
```env
|
||
VITE_SUPABASE_URL=
|
||
VITE_SUPABASE_PUBLISHABLE_KEY=
|
||
```
|
||
|
||
- If you're using supabase.com, you can find these values in the [Connect modal](https://supabase.com/dashboard/project/_?showConnect=true&connectTab=frameworks&framework=react&using=vite&with=supabasejs) under App Frameworks or in your project's [API settings](https://supabase.com/dashboard/project/_/settings/api).
|
||
|
||
- If you're using a local instance of Supabase, you can find these values by running `supabase start` or `supabase status` (if you already have it running).
|
||
|
||
### Setting up third party providers
|
||
|
||
We support a wide variety of social providers that you can use to integrate with your application. The full list is available [here](https://supabase.com/docs/guides/auth/social-login).
|
||
This block uses the PKCE flow with GitHub as the provider. To switch providers, just update the `provider` field in the `supabase.auth.signInWithOAuth` call. Enable the provider you want to use under [Auth Providers](https://supabase.com/dashboard/project/_/auth/providers) in the Supabase Dashboard and add the necessary credentials.
|
||
|
||
### Setting up routes and redirect URLs
|
||
|
||
1. Set the site URL in the [URL Configuration](https://supabase.com/dashboard/project/_/auth/url-configuration) settings in the Supabase Dashboard.
|
||
1. Update the redirect paths in `login-form.tsx` to point to your app’s logged-in routes. Our examples use `/protected`, but you can set this to whatever fits your app.
|
||
1. Visit `http://your-site-url/login` to see this component in action.
|
||
|
||
### Combining social auth with password-based auth
|
||
|
||
If you want to combine this block with the password-based auth, you need to:
|
||
|
||
- Copy the `handleSocialLogin` function into the password-based `login-form.tsx` component and bind it to a "Login with ..." button.
|
||
- Copy the `@/routes/auth/oauth.ts` in your app under the same route.
|
||
|
||
## Further reading
|
||
|
||
- [Social login](https://supabase.com/docs/guides/auth/social-login)
|
||
- [Authentication error codes](https://supabase.com/docs/guides/auth/debugging/error-codes)
|