From f7972d3f70840d2a86b7ce42284dad3774c35a35 Mon Sep 17 00:00:00 2001
From: David Beniamine <david.beniamine@tetras-libre.fr>
Date: Sun, 28 Nov 2021 11:07:04 +0100
Subject: [PATCH] Readme with illustration

---
 Readme.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/Readme.md b/Readme.md
index 953406d..bdaf4cf 100644
--- a/Readme.md
+++ b/Readme.md
@@ -8,6 +8,29 @@ For now only the web interface and SOAP API have been tested.
 
 This image should be combined with a postfix container to actually send mail, this part and the list_configuration have not been tested / documented yet
 
+# What is this repository
+
+This repository provides two docker images that works together to receive and send email to mailing lists : postfix and sympa.
+
+There is an illustration of how they work together:
+
+```mermaid
+graph LR
+    subgraph Sympa
+      sympa
+      nullmailer
+    end
+    subgraph internet
+        relayin
+        relayout
+    end
+    relayin -->|smtp entrant| postfix
+    postfix -->|ssh| sympa
+    sympa --> nullmailer
+    nullmailer -->|smtp| postfix
+    postfix -->|smtp| relayout
+```
+
 # Installation
 
 1. Copy `.env.sample` to `.env` and adapt
-- 
GitLab