Skip to content

Commit

Permalink
feat(self-hosted): Add docs around mail setup (getsentry#129)
Browse files Browse the repository at this point in the history
  • Loading branch information
BYK authored Sep 4, 2020
1 parent b69f1cb commit e5b8b36
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/components/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ const Sidebar = () => (
<ul className="list-unstyled" data-sidebar-tree>
<NavLink to="/self-hosted/">Overview</NavLink>
<NavLink to="/self-hosted/releases/">Versioning & Releases</NavLink>
<NavLink to="/self-hosted/mail/">Mail</NavLink>
<NavLink to="/self-hosted/support/">Support</NavLink>
</ul>
</li>
Expand Down
17 changes: 17 additions & 0 deletions src/docs/self-hosted/mail.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Self-Hosted Mail'
---

<Alert title="Note" level="info">
Remember that you'd need to restart all Sentry services once you change your settings. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
</Alert>

## Outbound Mail

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` . 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.

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](/services/email/) for all the details on what each setting means and does.

## Inbound Mail

Sentry has a very limited inboud 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](/services/email/#inbound-email).

0 comments on commit e5b8b36

Please sign in to comment.