From d0518c4fe99cb31efea9dd48fec91936eb8b7676 Mon Sep 17 00:00:00 2001 From: Rafael Eyng Date: Tue, 10 Sep 2024 19:51:17 -0300 Subject: [PATCH 1/2] add SMTP docs --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 9d078c4..70c85b8 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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:@smtp.resend.com:465/ +PDS_EMAIL_FROM_ADDRESS=admin@your.domain +``` + +_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. From 30fc35e3c37e68a0aed48e5bf86bcc5a7fb29e70 Mon Sep 17 00:00:00 2001 From: Rafael Eyng Date: Sun, 10 Nov 2024 00:45:20 -0300 Subject: [PATCH 2/2] Add more details to doc --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 70c85b8..48cceb6 100644 --- a/README.md +++ b/README.md @@ -207,14 +207,14 @@ To be able to verify users' email addresses and send other emails, you need to s 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): +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:@smtp.resend.com:465/ PDS_EMAIL_FROM_ADDRESS=admin@your.domain ``` -_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._ +_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