From 7a137ae073b6756b69ad95270f26463762849fc1 Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Jul 28 2015 12:47:53 +0000
Subject: Add a documentation on how to install the milter


---

diff --git a/doc/Install_milter.rst b/doc/Install_milter.rst
new file mode 100644
index 0000000..9340c4d
--- /dev/null
+++ b/doc/Install_milter.rst
@@ -0,0 +1,43 @@
+Installing pagure's milter
+==========================
+
+A milter is a script that is ran by a MTA upon receiving an email via either
+a network or an unix socket.
+
+If you want more information feel free to check out the corresponding page
+on wikipedia `https://en.wikipedia.org/wiki/Milter <https://en.wikipedia.org/wiki/Milter>`_.
+
+Configure your system
+---------------------
+
+* Create an alias ``reply``
+
+This can be done in ``/etc/aliases``, for example:
+::
+
+    reply:      /dev/null
+
+
+* Activate the ability of you MTA, to split users based on the character ``+``.
+  This way all the emails sent to ``reply+...@example.com`` will be forwarded
+  to your alias for ``reply``.
+
+
+In postfix this is done via:
+::
+
+    recipient_delimiter = +
+
+* Hook the milter in the MTA
+
+In postfix this is done via:
+::
+
+    non_smtpd_milters = unix:/var/run/pagure/paguresock
+    smtpd_milters = unix:/var/run/pagure/paguresock
+
+* Activate the service and ensure it's started upon boot:
+::
+
+    systemctl enable pagure_milter
+    systemctl start pagure_milter