Skip to content

Commit f11cd22

Browse files
committed
Add documentation for new email settings
Signed-off-by: Erin Allison <eallison@andrettikarting.com>
1 parent b941b44 commit f11cd22

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

docs/open-source-self-hosting.mdx

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,45 @@ TRIGGER_IMAGE_TAG=v3.0.4
269269

270270
### Auth options
271271

272-
By default, magic link auth is the only login option. If the `RESEND_API_KEY` env var is not set, the magic links will be logged by the webapp container and not sent via email.
272+
By default, magic link auth is the only login option. If the `EMAIL_TRANSPORT` env var is not set, the magic links will be logged by the webapp container and not sent via email.
273+
274+
Depending on your choice of mail provider/transport, you will want to configure a set of variables like one of the following:
275+
276+
##### Resend:
277+
```bash
278+
EMAIL_TRANSPORT=resend
279+
FROM_EMAIL=
280+
REPLY_TO_EMAIL=
281+
RESEND_API_KEY=<your_resend_api_key>
282+
```
283+
284+
##### SMTP
285+
286+
Note that setting `SMTP_SECURE=false` does _not_ mean the email is sent insecurely.
287+
This simply means that the connection is secured using the modern STARTTLS protocol command instead of implicit TLS.
288+
You should only set this to true when the SMTP server host directs you to do so (generally when using port 465)
289+
290+
```bash
291+
EMAIL_TRANSPORT=smtp
292+
FROM_EMAIL=
293+
REPLY_TO_EMAIL=
294+
SMTP_HOST=<your_smtp_server>
295+
SMTP_PORT=587
296+
SMTP_SECURE=false
297+
SMTP_USER=<your_smtp_username>
298+
SMTP_PASSWORD=<your_smtp_password>
299+
```
300+
301+
##### AWS Simple Email Service
302+
303+
Credentials are to be supplied as with any other program using the AWS SDK.
304+
In this scenario, you would likely either supply the additional environment variables `AWS_REGION`, `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` or, when running on AWS, use credentials supplied by the EC2 IMDS.
305+
306+
```bash
307+
EMAIL_TRANSPORT=aws-ses
308+
FROM_EMAIL=
309+
REPLY_TO_EMAIL=
310+
```
273311

274312
All email addresses can sign up and log in this way. If you would like to restrict this, you can use the `WHITELISTED_EMAILS` env var. For example:
275313

0 commit comments

Comments
 (0)