mirror of
https://github.com/supabase/supabase.git
synced 2026-05-31 18:03:33 +08:00
38e09e1754
## What kind of change does this PR introduce? Docs update. Part of DEPR-198. ## What is the current behaviour? Auth email template examples and Studio template labels still reflect older default copy in a few places. ## What is the new behaviour? Updates Auth docs, local development docs, related snippets, Studio template labels, and UI Library examples to [match the updated default Auth email copy](https://linear.app/supabase/document/email-template-copywriting-updates-04bba460fd2a). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated authentication email template names and descriptions across guides, replacing "Magic link" with "Sign-in link or code" terminology * Revised security notification email naming from "Identity linked/unlinked" to "Sign-in method linked/removed" and "MFA method" to "Verification method" * Updated email template example content with improved wording (e.g., "Confirm your email address" instead of "Confirm your signup") * **UI Updates** * Refined authentication-related UI text labels and descriptions in the dashboard [](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/45706) <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
80 lines
3.8 KiB
Plaintext
80 lines
3.8 KiB
Plaintext
---
|
|
title: Password-based Authentication
|
|
description: Password-based authentication block for TanStack Start
|
|
---
|
|
|
|
<BlockPreview name="password-based-auth/auth/sign-up" />
|
|
|
|
## Installation
|
|
|
|
<BlockItem name="password-based-auth-tanstack" description="Supabase Client for TanStack Start" />
|
|
|
|
## 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="password-based-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 password-based 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).
|
|
|
|
### Adding email templates
|
|
|
|
1. Add an [email template for sign-up](https://supabase.com/dashboard/project/_/auth/templates) to the Supabase project. Your signup email template should contain at least the following HTML:
|
|
|
|
```html
|
|
<h2>Confirm your email address</h2>
|
|
|
|
<p>Follow the link below to confirm this email address and finish signing up.</p>
|
|
<p>
|
|
<a
|
|
href="{{ .SiteURL }}/auth/confirm?token_hash={{ .TokenHash }}&type=email&next={{ .RedirectTo }}"
|
|
>Confirm email address</a
|
|
>
|
|
</p>
|
|
```
|
|
|
|
For detailed instructions on how to configure your email templates, including the use of variables like `{{ .SiteURL }}`,`{{ .TokenHash }}`, and `{{ .RedirectTo }}`, refer to our [Email Templates guide](https://supabase.com/docs/guides/auth/auth-email-templates).
|
|
|
|
1. Add an [email template for reset password](https://supabase.com/dashboard/project/_/auth/templates) to the Supabase project. Your reset password email template should contain at least the following HTML:
|
|
|
|
```html
|
|
<h2>Reset your password</h2>
|
|
|
|
<p>We received a request to reset your password. Follow the link below to choose a new one.</p>
|
|
<p>
|
|
<a
|
|
href="{{ .SiteURL }}/auth/confirm?token_hash={{ .TokenHash }}&type=recovery&next={{ .RedirectTo }}"
|
|
>Reset password</a
|
|
>
|
|
</p>
|
|
```
|
|
|
|
### 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. Set up the route users will visit to reset or update their password. Go to the [URL Configuration](https://supabase.com/dashboard/project/_/auth/url-configuration) settings and add the `forgot-password` route to the list of Redirect URLs. It should look something like: `http://example.com/auth/forgot-password`.
|
|
1. Update the redirect paths in `login.tsx` and `update-password.tsx` components to point to the logged-in routes in your app. 1. Our examples use `/protected`, but you can set this to whatever fits your app.
|
|
|
|
## Further reading
|
|
|
|
- [Password-based authentication (PKCE flow)](https://supabase.com/docs/guides/auth/passwords?queryGroups=flow&flow=pkce)
|
|
- [Authentication error codes](https://supabase.com/docs/guides/auth/debugging/error-codes)
|
|
- [Email templates](https://supabase.com/docs/guides/auth/auth-email-templates)
|
|
- [Email templates for local development](https://supabase.com/docs/guides/local-development/customizing-email-templates)
|
|
- [Custom SMTP](https://supabase.com/docs/guides/auth/auth-smtp)
|