Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add SMTP docs #86

Merged
merged 3 commits into from
Nov 10, 2024
Merged

add SMTP docs #86

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0518c4
add SMTP docs
rafaeleyng Sep 10, 2024
30fc35e
Add more details to doc
rafaeleyng Nov 10, 2024
2b350d3
Merge branch 'main' into add-smtp-doc
rafaelbsky Nov 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down Expand Up @@ -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 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 a bit depending on your setup. You might need to just 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.
Expand Down