mirror of
https://github.com/supabase/supabase.git
synced 2026-10-16 22:59:11 +03:00
Ivan Vasilov
156e8fd9b7
* Regenerate the registry. * Fix the paths of the ai editor rules. * Fix headings on clients and auth blocks. * Fix realtime chat and avatar demos. * Setup mdx-lint for the ui-library. Fix some obvious wordings. * Fix the tooltips for the examples. Reorder the example pages.
121 lines
4.0 KiB
Plaintext
121 lines
4.0 KiB
Plaintext
---
|
|
title: Password-based Authentication
|
|
description: Password-based authentication block for React Single Page Applications
|
|
---
|
|
|
|
<BlockPreview name="password-based-auth/auth/sign-up" />
|
|
|
|
## Installation
|
|
|
|
<BlockItem
|
|
name="password-based-auth-react"
|
|
description="All needed components for the password based auth flow"
|
|
/>
|
|
|
|
## Folder structure
|
|
|
|
<RegistryBlock itemName="password-based-auth-react" />
|
|
|
|
## Usage
|
|
|
|
Once you install the block in your React project, you'll get all the necessary pages and components to set up a password-based authentication flow.
|
|
|
|
### Getting started
|
|
|
|
First, add a `.env` file to your project with the following environment variables:
|
|
|
|
```env
|
|
VITE_SUPABASE_URL=
|
|
VITE_SUPABASE_ANON_KEY=
|
|
```
|
|
|
|
- If you're using supabase.com, you can find these values in the [Connect modal](https://supabase.com/dashboard/project/_?showConnect=true) 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 signup</h2>
|
|
|
|
<p>Follow this link to confirm your user:</p>
|
|
<p>
|
|
<a
|
|
href="{{ .SiteURL }}/auth/confirm?token_hash={{ .TokenHash }}&type=email&next={{ .RedirectTo }}"
|
|
>Confirm your email</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/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 Password</h2>
|
|
|
|
<p>Follow this link to reset the password for your user:</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 the `login.tsx` and `update-password.tsx` components to point to the logged-in routes in your app.
|
|
|
|
1. Add the following code in the authenticated route to redirect to login if the user is unauthenticated.
|
|
|
|
## Examples
|
|
|
|
### Redirect to `/login` page if the user is unauthenticated
|
|
|
|
```ts
|
|
import { useEffect } from "react"
|
|
import { createClient } from "@supabase/supabase-js"
|
|
|
|
export default function AuthenticatedRoute() {
|
|
useEffect(() => {
|
|
const checkAuth = async () => {
|
|
const client = createClient()
|
|
const { error } = await client.auth.getUser()
|
|
|
|
if (error) {
|
|
location.href = "/login"
|
|
}
|
|
}
|
|
checkAuth()
|
|
}, [])
|
|
|
|
return <div>Authenticated page</div>;
|
|
}
|
|
```
|
|
|
|
### Redirect to `/profile` page if the user is authenticated
|
|
|
|
```ts
|
|
import { useEffect } from "react";
|
|
import { createClient } from "@supabase/supabase-js"
|
|
|
|
export default function AuthenticatedRoute() {
|
|
useEffect(() => {
|
|
const checkAuth = async () => {
|
|
const client = createClient()
|
|
const { user } = await client.auth.getUser()
|
|
|
|
user ? location.href = "/profile" : location.href = "/login"
|
|
}
|
|
checkAuth()
|
|
}, [])
|
|
|
|
return <div>Profile page</div>
|
|
}
|
|
```
|