Skip to content

Commit 7764d9b

Browse files
adjust intro in README
1 parent ec7c4b2 commit 7764d9b

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,15 @@
99

1010
`django-email-relay` enables Django projects without direct access to a preferred SMTP server to use that server for email dispatch.
1111

12-
It consists of two parts: a Django app with a custom email backend that stores emails in a central database queue, and a relay service that reads from this queue to orchestrate email sending, available as either a standalone Docker image or a management command to be used within a Django project that does have access to the preferred SMTP server.
12+
It consists of two parts:
1313

14-
Why opt for this setup?
14+
1. A Django app with a custom email backend that stores emails in a central database queue. This is what you will use on all the distributed Django projects that you would like to give access to the preferred SMTP server.
15+
16+
2. A relay service that reads from this queue to orchestrate email sending. It is available as either a standalone Docker image or a management command to be used within a Django project that does have access to the preferred SMTP server.
17+
18+
## Why?
19+
20+
Okay, so why opt for this setup? A few reasons:
1521

1622
- The potential for emails sent through an external Email Service Provider (ESP) to be marked as spam or filtered, a common issue when routing transactional emails from internal applications to internal users via an ESP.
1723
- It eliminates the necessity to open firewall ports or the need to utilize services like Tailscale for SMTP server access.

0 commit comments

Comments
 (0)