Add self-hosting email configuration docs + examples, correct SMTP setup for SendGrid/Mailgun-specific setup

backend/src/config/index.ts

@@ -26,7 +26,7 @@ const POSTHOG_PROJECT_API_KEY =
 const SENTRY_DSN = process.env.SENTRY_DSN!;
 const SITE_URL = process.env.SITE_URL!;
 const SMTP_HOST = process.env.SMTP_HOST! || 'smtp.gmail.com';
-const SMTP_SECURE = process.env.SMTP_SECURE! || false;
+const SMTP_SECURE = process.env.SMTP_SECURE! === 'true' || false;
 const SMTP_PORT = process.env.SMTP_PORT! || 587;
 const SMTP_USERNAME = process.env.SMTP_USERNAME!;
 const SMTP_PASSWORD = process.env.SMTP_PASSWORD!;

backend/src/integrations/exchange.ts

@@ -9,8 +9,7 @@ import {
   INTEGRATION_VERCEL_TOKEN_URL,
   INTEGRATION_NETLIFY_TOKEN_URL,
   INTEGRATION_GITHUB_TOKEN_URL,
-  INTEGRATION_GITHUB_API_URL,
-  ACTION_PUSH_TO_HEROKU
+  INTEGRATION_GITHUB_API_URL
 } from '../variables';
 import {
   SITE_URL,

backend/src/services/smtp.ts

@@ -1,13 +1,14 @@
 import nodemailer from 'nodemailer';
 import { SMTP_HOST, SMTP_PORT, SMTP_USERNAME, SMTP_PASSWORD, SMTP_SECURE } from '../config';
+import { SMTP_HOST_SENDGRID, SMTP_HOST_MAILGUN } from '../variables';
 import SMTPConnection from 'nodemailer/lib/smtp-connection';
 import * as Sentry from '@sentry/node';
 
 const mailOpts: SMTPConnection.Options = {
   host: SMTP_HOST,
-  secure: SMTP_SECURE as boolean,
   port: SMTP_PORT as number
 };
+
 if (SMTP_USERNAME && SMTP_PASSWORD) {
   mailOpts.auth = {
     user: SMTP_USERNAME,
@@ -15,6 +16,23 @@ if (SMTP_USERNAME && SMTP_PASSWORD) {
   };
 }
 
+if (SMTP_SECURE) {
+  switch (SMTP_HOST) {
+    case SMTP_HOST_SENDGRID:
+      mailOpts.requireTLS = true;
+      break;
+    case SMTP_HOST_MAILGUN:
+      mailOpts.requireTLS = true; 
+      mailOpts.tls = {
+        ciphers: 'TLSv1.2'
+      }
+      break;
+    default:
+      mailOpts.secure = true;
+      break;
+  }
+}
+
 export const initSmtp = () => {
   const transporter = nodemailer.createTransport(mailOpts);
   transporter

backend/src/variables/action.ts

@@ -1,5 +0,0 @@
-const ACTION_PUSH_TO_HEROKU = 'pushToHeroku';
-
-export {
-    ACTION_PUSH_TO_HEROKU
-}

backend/src/variables/index.ts

@@ -32,9 +32,9 @@ import {
   GRANTED
 } from './organization';
 import { SECRET_SHARED, SECRET_PERSONAL } from './secret';
-import { PLAN_STARTER, PLAN_PRO } from './stripe';
 import { EVENT_PUSH_SECRETS, EVENT_PULL_SECRETS } from './event';
-import { ACTION_PUSH_TO_HEROKU } from './action';
+import { SMTP_HOST_SENDGRID, SMTP_HOST_MAILGUN } from './smtp';
+import { PLAN_STARTER, PLAN_PRO } from './stripe';
 
 export {
   OWNER,
@@ -44,8 +44,6 @@ export {
   ACCEPTED,
   COMPLETED,
   GRANTED,
-  PLAN_STARTER,
-  PLAN_PRO,
   SECRET_SHARED,
   SECRET_PERSONAL,
   ENV_DEV,
@@ -69,6 +67,9 @@ export {
   INTEGRATION_GITHUB_API_URL,
   EVENT_PUSH_SECRETS,
   EVENT_PULL_SECRETS,
-  ACTION_PUSH_TO_HEROKU,
-  INTEGRATION_OPTIONS
+  INTEGRATION_OPTIONS,
+  SMTP_HOST_SENDGRID,
+  SMTP_HOST_MAILGUN,
+  PLAN_STARTER,
+  PLAN_PRO,
 };

backend/src/variables/smtp.ts

@@ -0,0 +1,7 @@
+const SMTP_HOST_SENDGRID = 'smtp.sendgrid.net';
+const SMTP_HOST_MAILGUN = 'smtp.mailgun.org';
+
+export {
+    SMTP_HOST_SENDGRID,
+    SMTP_HOST_MAILGUN
+}