Skip to content

Commit 103ed78

Browse files
aldy505BYK
authored andcommitted
docs(self-hosted): detailed email docs regarding best practices (#13356)
* docs(self-hosted): detailed email docs regarding best practices * Update email.mdx Co-authored-by: Burak Yigit Kaya <[email protected]> --------- Co-authored-by: Burak Yigit Kaya <[email protected]>
1 parent 07cac2a commit 103ed78

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

develop-docs/backend/application-domains/email.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Defaults to `(empty)`.
7878
<dd><markdown>
7979
Declared in `config.yml`.
8080

81-
Should Sentry use SSL when connecting to the SMTP server?
81+
Should Sentry use SSL when connecting to the SMTP server? Mutually exclusive with `mail.use-tls`.
8282

8383
Defaults to `false`.
8484

@@ -88,7 +88,7 @@ Defaults to `false`.
8888
<dd><markdown>
8989
Declared in `config.yml`.
9090

91-
Should Sentry use TLS when connecting to the SMTP server?
91+
Should Sentry use STARTTLS when connecting to the SMTP server? Mutually exclusive with `mail.use-ssl`.
9292

9393
Defaults to `false`.
9494

develop-docs/self-hosted/email.mdx

+6-2
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,18 @@ description: Set up and configure email notifications for your self-hosted Sentr
1111

1212
## Outbound Email
1313

14-
Self-hosted Sentry ships with a built-in outgoing SMTP server powered by [exim4](https://hub.docker.com/r/tianon/exim4). The default configuration is set to use this server. All you need to do is to set a valid address for `mail.from` setting in `config.yml` and the [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) of your Sentry instance for `SENTRY_MAIL_HOST` in `.env`. Keep in mind that if you start sending too many emails to public addresses, your new server may get marked as a spammer and banned.
14+
It is recommended to use an external SMTP server due to various sender requirements implemented by major email providers, but if you are testing or running a self-hosted Sentry instance on a local network, you can use the built-in SMTP server, powered by [exim4](https://hub.docker.com/r/tianon/exim4). The default configuration is set to use this server. All you need to do is to set a valid address for `mail.from` setting in `config.yml` and the [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) of your Sentry instance for `SENTRY_MAIL_HOST` in `.env`.
1515

16-
If you want to use an external SMTP server you can set the relevant `mail.*` settings in `config.yml` file and ignore the built-in SMTP server. Refer to our [email service documentation](/backend/email/) for all the details on what each setting means and does. If your MX records usually resolve to internal private network mail handlers, see [this ticket](https://github.com/getsentry/self-hosted/issues/1202) for some pointers.
16+
If you want to use an external SMTP server you can set the relevant `mail.*` settings in `config.yml` file and ignore the built-in SMTP server. If you don't have an external SMTP server, yet you need to see sent emails, you can set `mail.backend` to `console` on your `config.yml` file. Refer to our [email service documentation](/backend/email/) for all the details on what each setting means and does.
17+
18+
If your MX records usually resolve to internal private network mail handlers, see [this ticket](https://github.com/getsentry/self-hosted/issues/1202) for some pointers.
1719

1820
<Alert title="Warning" level="warning">
1921
Because of the way configuration is layered, if you update <code>mail</code> settings through the web interface, you will need to also comment out the <code>mail.host: 'smtp'</code> default in your <code>config.yml</code> in order for your desired settings to be picked up.
2022
</Alert>
2123

24+
Sentry does not support sending outbound email with any other protocol than SMTP (examples: Sendgrid's API, AWS SES API, Mailgun API). Usually, those services provide SMTP relay that you can use.
25+
2226
## Inbound Email
2327

2428
Sentry has very limited inbound mail support through [Mailgun](https://documentation.mailgun.com/en/latest/quickstart-receiving.html). You can find all the information regarding how to set this up over at our [inbound email service documentation](/backend/email/#inbound-email).

0 commit comments

Comments
 (0)