From c80e8e881cd6e2d23a6a7bf2a622aba0c5ee8104 Mon Sep 17 00:00:00 2001 From: Tyler Myracle Date: Sat, 20 Jan 2024 14:46:21 -0600 Subject: [PATCH] update notes --- .env.example | 5 +++-- README.md | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.env.example b/.env.example index 9e738fad..5839b3cb 100644 --- a/.env.example +++ b/.env.example @@ -44,8 +44,9 @@ NX_TELLER_ENV=sandbox # EMAIL ######################################################################## -# We currently support Postmark for transactional emails. You can sign up for a free account -# and get a free API key at https://postmarkapp.com +# We currently support Postmark for transactional emails. You can sign +# up for a free account and get a free API key at https://postmarkapp.com. +# If using Postmark set the email provider to postmark NX_EMAIL_FROM_ADDRESS=account@example.com NX_EMAIL_REPLY_TO_ADDRESS=support@example.com NX_EMAIL_PROVIDER= diff --git a/README.md b/README.md index ee4d0c15..1a9ed5bb 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ cp .env.example .env Then, create a new secret using `openssl rand -base64 32` and populate `NEXTAUTH_SECRET` in your `.env` file with it. -To enable transactional emails, you'll need to create a [Postmark](https://postmarkapp.com/) account and add your API key to your `.env` file (`NX_EMAIL_PROVIDER_API_TOKEN`) and set `NX_EMAIL_PROVIDER` to `postmark`. You can also set the from and reply-to email addresses (`NX_EMAIL_FROM_ADDRESS` and `NX_EMAIL_REPLY_TO_ADDRESS`). If you want to run the app without email, you can set `NX_EMAIL_PROVIDER_API_TOKEN` to a dummy value. +To enable transactional emails, you'll need to create a [Postmark](https://postmarkapp.com/) account and add your API key to your `.env` file (`NX_EMAIL_PROVIDER_API_TOKEN`) and set `NX_EMAIL_PROVIDER` to `postmark`. You can also set the from and reply-to email addresses (`NX_EMAIL_FROM_ADDRESS` and `NX_EMAIL_REPLY_TO_ADDRESS`). If you want to run the app without email, you can set `NX_EMAIL_PROVIDER_API_TOKEN` to a dummy value or leave `NX_EMAIL_PROVIDER` blank. Maybe uses [Teller](https://teller.io/) for connecting financial accounts. To get started with Teller, you'll need to create an account. Once you've created an account: