mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45:10 +03:00
Add docs for email template in local supabase
This commit is contained in:
1 parent
297584a0dd
commit
e21f68bd42
3 files changed
+67
No files matched your search
@@ -1037,6 +1037,10 @@ export const supabase_cli: NavMenuConstant = {
|
||||
name: 'Testing and linting',
|
||||
url: '/guides/cli/testing-and-linting',
|
||||
},
|
||||
{
|
||||
name: 'Customizing email templates',
|
||||
url: '/guides/cli/customizing-email-templates',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
import Layout from '~/layouts/DefaultGuideLayout'
|
||||
|
||||
export const meta = {
|
||||
id: 'customizing-email-templates',
|
||||
title: 'Customizing email teplates',
|
||||
description: 'Customizing local email templates using config.toml.',
|
||||
}
|
||||
|
||||
The Supabase CLI uses a `config.toml` file to manage local configuration. This file is located in the `supabase` directory of your project.
|
||||
|
||||
## Config reference
|
||||
|
||||
The `config.toml` file is automatically created when you run `supabase start`.
|
||||
|
||||
There are a wide variety of options available, which can be found in the [CLI Config Reference](/docs/reference/cli/config).
|
||||
|
||||
For example, to update the "Invite" email subject and content for local development, you can append the following information to `config.toml`:
|
||||
|
||||
```toml
|
||||
[auth.email.template.invite]
|
||||
subject = "You are invited to Acme Inc"
|
||||
content_path = "./supabase/auth/email/invite.html"
|
||||
```
|
||||
|
||||
The `content_path` should contain the html file you are pointing to otherwise the CLI won't start the project.
|
||||
|
||||
> Note: These settings are only for local development, if you want to use the same content for your hosted Supabase you will need to copy and paste these into the Supabase Dashboard
|
||||
|
||||
export const Page = ({ children }) => <Layout meta={meta} children={children} />
|
||||
|
||||
export default Page
|
||||
@@ -260,6 +260,38 @@ parameters:
|
||||
links:
|
||||
- name: 'Auth Server configuration'
|
||||
link: 'https://supabase.com/docs/reference/auth'
|
||||
|
||||
- id: 'auth.email.template.type.subject'
|
||||
title: 'auth.email.template.<type>.subject'
|
||||
tags: ['auth']
|
||||
required: false
|
||||
description: |
|
||||
The full list of email template types are:
|
||||
|
||||
- `invite`
|
||||
- `confirmation`
|
||||
- `recovery`
|
||||
- `magic_link`
|
||||
- `email_change`
|
||||
links:
|
||||
- name: 'Auth Server configuration'
|
||||
link: 'https://supabase.com/docs/reference/auth'
|
||||
|
||||
- id: 'auth.email.template.type.content_path'
|
||||
title: 'auth.email.template.<type>.content_path'
|
||||
tags: ['auth']
|
||||
required: false
|
||||
description: |
|
||||
The full list of email template types are:
|
||||
|
||||
- `invite`
|
||||
- `confirmation`
|
||||
- `recovery`
|
||||
- `magic_link`
|
||||
- `email_change`
|
||||
links:
|
||||
- name: 'Auth Server configuration'
|
||||
link: 'https://supabase.com/docs/reference/auth'
|
||||
|
||||
- id: 'auth.external.provider.enabled'
|
||||
title: 'auth.external.<provider>.enabled'
|
||||
|
||||
Reference in new issue
Block a user