-
Notifications
You must be signed in to change notification settings - Fork 174
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #86 from rafaeleyng/add-smtp-doc
add SMTP docs
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,6 +25,7 @@ Head over to the [AT Protocol PDS Admins Discord](https://discord.gg/e7hpHxRfBP) | |
* [Creating an account using pdsadmin](#creating-an-account-using-pdsadmin) | ||
* [Creating an account using an invite code](#creating-an-account-using-an-invite-code) | ||
* [Using the Bluesky app with your PDS](#using-the-bluesky-app-with-your-pds) | ||
* [Setting up SMTP](#setting-up-smtp) | ||
* [Updating your PDS](#updating-your-pds) | ||
|
||
<!-- tocstop --> | ||
|
@@ -200,6 +201,21 @@ You can use the Bluesky app to connect to your PDS. | |
|
||
_Note: because the subdomain TLS certificate is created on-demand, it may take 10-30s for your handle to be accessible. If you aren't seeing your first post/profile, wait 30s and try to make another post._ | ||
|
||
### Setting up SMTP | ||
|
||
To be able to verify users' email addresses and send other emails, you need to set up an SMTP server. | ||
|
||
One way to do this is to use an email service. [Resend](https://resend.com/) and [SendGrid](https://sendgrid.com/) are two popular choices. | ||
|
||
Create an account and API key on an email service, ensure your server allows access on the required ports, and set these variables in `/pds/pds.env` (example with Resend): | ||
|
||
``` | ||
PDS_EMAIL_SMTP_URL=smtps://resend:<your api key here>@smtp.resend.com:465/ | ||
[email protected] | ||
``` | ||
|
||
_Note: Your PDS will need to be restarted with those variables. This varies depending on your setup. If you followed this installation guide, run `systemctl restart pds`. You might need to restart the server or recreate the container, depending on what you are using._ | ||
|
||
### Updating your PDS | ||
|
||
It is recommended that you keep your PDS up to date with new versions, otherwise things may break. You can use the `pdsadmin` tool to update your PDS. | ||
|