Skip to content

Commit c708b78

Browse files
authored
Merge pull request supabase#15949 from supabase/j0/add_doc_on_smtp
feat: add doc on setting up custom smtp provider
2 parents 650a30f + c494368 commit c708b78

File tree

4 files changed

+42
-2
lines changed

4 files changed

+42
-2
lines changed

apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -477,6 +477,7 @@ export const auth = {
477477
url: undefined,
478478
items: [
479479
{ name: 'Enable Captcha Protection', url: '/guides/auth/auth-captcha' },
480+
{ name: 'Configuring Custom SMTP', url: '/guides/auth/auth-smtp' },
480481
{ name: 'Managing User Data', url: '/guides/auth/managing-user-data' },
481482
{ name: 'Multi-Factor Authentication', url: '/guides/auth/auth-mfa' },
482483
{ name: 'Row Level Security', url: '/guides/auth/row-level-security' },
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
import Layout from '~/layouts/DefaultGuideLayout'
2+
3+
export const meta = {
4+
id: 'auth-smtp',
5+
title: 'Configure a Custom SMTP',
6+
description: 'Moving towards production: Configuring a custom SMTP provider',
7+
}
8+
9+
# Auth SMTP
10+
11+
At present, you can trial the Supabase platform by sending up to **4** emails per hour via the built-in service. The default email service as a whole is offered on a best effort basis: we will do our best to maintain it and will review usage of the service on a regular basis to see if the email service should be continued.
12+
13+
As you progress toward production, you may find yourself wanting for a custom SMTP service in order to increase your limits. A custom SMTP server will allow you to set your own cap on the number of emails sent per hour.
14+
15+
Beyond rate limits, an SMTP server might also help with:
16+
17+
- Deliverability and Reputation Management
18+
- Scalability
19+
- Analytics and Tracking
20+
- Compliance and Anti Spam measures
21+
22+
## How to Set up SMTP
23+
24+
Head over to the [Auth Settings Page](https://supabase.com/dashboard/project/_/settings/auth) and hit "Enable Custom SMTP" under the SMTP Provider section.
25+
26+
Fill in fields below with the relevant details obtained from your custom SMTP provider:
27+
28+
![SMTP settings](/docs/img/guides/auth-smtp/smtp.png)
29+
30+
### SMTP Providers
31+
32+
You can use Supabase Auth with any major SMTP provider of your choosing. Some SMTP providers you could consider using are:
33+
34+
- [Twilio SendGrid](https://docs.sendgrid.com/for-developers/sending-email/integrating-with-the-smtp-api)
35+
- [AWS SES](https://docs.aws.amazon.com/ses/latest/dg/send-email-smtp.html)
36+
- [Resend](https://resend.com/docs/dashboard/emails/introduction)
37+
38+
export const Page = ({ children }) => <Layout meta={meta} children={children} />
39+
export default Page

apps/docs/pages/guides/platform/going-into-prod.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ After developing your project and deciding it's Production Ready, you should run
4040
## Availability
4141

4242
- Use your own SMTP credentials so that you have full control over the deliverability of your transactional auth emails (see Settings > Auth)
43-
- you can grab SMTP credentials from any major email provider such as SendGrid, AWS SES, etc.
44-
- The default rate limit for auth emails provided by Supabase is 30 new users per hour, if doing a major public announcement you will likely require more than this.
43+
- you can grab SMTP credentials from any major email provider such as SendGrid, AWS SES, etc. You can refer to our [SMTP guide](/docs/guides/auth/auth-smtp) for more details.
44+
- The default rate limit for auth emails when using a custom SMTP provider is 30 new users per hour, if doing a major public announcement you will likely require more than this.
4545
- If your application is on the free plan and is **not** expected to be queried at least once every 7 days, then it may be paused by Supabase to save on server resources.
4646
- You can restore paused projects from the Supabase dashboard.
4747
- Upgrade to Pro to guarantee that your project will not be paused for inactivity.
183 KB
Loading

0 commit comments

Comments
 (0)