-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support and docs for SocketLabs email SMTP
- Loading branch information
1 parent
40250b7
commit 6ad70f2
Showing
7 changed files
with
67 additions
and
10 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
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
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 |
---|---|---|
@@ -1,7 +1,9 @@ | ||
const SMTP_HOST_SENDGRID = 'smtp.sendgrid.net'; | ||
const SMTP_HOST_MAILGUN = 'smtp.mailgun.org'; | ||
const SMTP_HOST_SOCKETLABS = 'smtp.socketlabs.com'; | ||
|
||
export { | ||
SMTP_HOST_SENDGRID, | ||
SMTP_HOST_MAILGUN | ||
SMTP_HOST_MAILGUN, | ||
SMTP_HOST_SOCKETLABS | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,7 +25,8 @@ By default, you need to configure the following SMTP [environment variables](htt | |
|
||
Below you will find details on how to configure common email providers (not in any particular order). | ||
|
||
## Twilio SendGrid | ||
<AccordionGroup> | ||
<Accordion title="Twilio SendGrid"> | ||
|
||
1. Create an account and configure [SendGrid](https://sendgrid.com) to send emails. | ||
2. Create a SendGrid API Key under Settings > [API Keys](https://app.sendgrid.com/settings/api_keys) | ||
|
@@ -47,11 +48,12 @@ [email protected] # your email address being used to send out em | |
SMTP_FROM_NAME=Infisical | ||
``` | ||
|
||
<Info> | ||
Remember that you will need to restart Infisical for this to work properly. | ||
</Info> | ||
<Info> | ||
Remember that you will need to restart Infisical for this to work properly. | ||
</Info> | ||
</Accordion> | ||
|
||
## Mailgun | ||
<Accordion title="Mailgun"> | ||
|
||
1. Create an account and configure [Mailgun](https://www.mailgun.com) to send emails. | ||
2. Obtain your Mailgun credentials in Sending > Overview > SMTP | ||
|
@@ -70,7 +72,9 @@ [email protected] # your email address being used to send out em | |
SMTP_FROM_NAME=Infisical | ||
``` | ||
|
||
## AWS SES | ||
</Accordion> | ||
|
||
<Accordion title="AWS SES"> | ||
|
||
1. Create an account and [configure AWS SES](https://aws.amazon.com/premiumsupport/knowledge-center/ses-set-up-connect-smtp/) to send emails in the Amazon SES console. | ||
2. Create an IAM user for SMTP authentication and obtain SMTP credentials in SMTP settings > Create SMTP credentials | ||
|
@@ -82,7 +86,6 @@ SMTP_FROM_NAME=Infisical | |
3. With your AWS SES SMTP credentials, you can now set up your SMTP environment variables: | ||
|
||
``` | ||
SMTP_HOST=smtp.mailgun.org # obtained from credentials page | ||
SMTP_HOST=email-smtp.ap-northeast-1.amazonaws.com # SMTP endpoint obtained from SMTP settings | ||
SMTP_USERNAME=xxx # your SMTP username | ||
SMTP_PASSWORD=xxx # your SMTP password | ||
|
@@ -95,3 +98,40 @@ SMTP_FROM_NAME=Infisical | |
<Info> | ||
Remember that you will need to restart Infisical for this to work properly. | ||
</Info> | ||
</Accordion> | ||
|
||
<Accordion title="SocketLabs"> | ||
|
||
1. Create an account and configure [SocketLabs](https://www.socketlabs.com/) to send emails. | ||
2. From the dashboard, navigate to SMTP Credentials > SMTP & APIs > SMTP Credentials to obtain your SocketLabs SMTP credentials. | ||
|
||
![opening SocketLabs dashboard](../../images/email-socketlabs-dashboard.png) | ||
|
||
![obtaining SocketLabs credentials](../../images/email-socketlabs-credentials.png) | ||
|
||
3. With your SocketLabs SMTP credentials, you can now set up your SMTP environment variables: | ||
|
||
``` | ||
SMTP_HOST=smtp.socketlabs.com | ||
SMTP_USERNAME=username # obtained from your credentials | ||
SMTP_PASSWORD=password # obtained from your credentials | ||
SMTP_PORT=587 | ||
SMTP_SECURE=true | ||
[email protected] # your email address being used to send out emails | ||
SMTP_FROM_NAME=Infisical | ||
``` | ||
|
||
<Note> | ||
The `SMTP_FROM_ADDRESS` environment variable should be an email for an | ||
authenticated domain under Configuration > Domain Management in SocketLabs. | ||
For example, if you're using SocketLabs in sandbox mode, then you may use an | ||
email like `[email protected]`. | ||
</Note> | ||
|
||
![SocketLabs domain management](../../images/email-socketlabs-domains.png) | ||
|
||
<Info> | ||
Remember that you will need to restart Infisical for this to work properly. | ||
</Info> | ||
</Accordion> | ||
</AccordionGroup> |