aboutsummaryrefslogtreecommitdiffstats
path: root/docs/HOWTO.md
diff options
context:
space:
mode:
authorMatěj Cepl <mcepl@cepl.eu>2023-05-25 10:15:47 +0200
committerMatěj Cepl <mcepl@cepl.eu>2023-05-25 11:01:18 +0200
commitec4b49d843e67b31b33ac81bef55346353f1d04c (patch)
tree5f60ffae4d6ebe180c5ee4d51d468bf154535251 /docs/HOWTO.md
parent8006d981ce26fe8c1140e33b9476c08470d59f30 (diff)
downloadpyg-ec4b49d843e67b31b33ac81bef55346353f1d04c.tar.gz
refactor: rearrange the project to the src/ layout.0.10.3
Fix also pyproject.toml to generate what seems right. Add the explicit dependency on nntplib for Python >= 3.12 (gh#python/cpython!104894). Fixes: https://todo.sr.ht/~mcepl/pygn/7
Diffstat (limited to 'docs/HOWTO.md')
-rw-r--r--docs/HOWTO.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/HOWTO.md b/docs/HOWTO.md
new file mode 100644
index 0000000..e39c123
--- /dev/null
+++ b/docs/HOWTO.md
@@ -0,0 +1,33 @@
+MUST BE FINISHED!
+
+
+It is a (very) small HOWTO to make pyg working properly.
+
+pygm2n:
+
+Pre: a fully working MTA (ie postfix) where you can run procmail or any other MDA.
+A news server (local or remote) where you can create groups (admin
+privileges).
+
+Create a user, ie mailgate, set its procmail as:
+
+:0 bhc:
+| pygm2n -n local.test
+
+or its maildrop (thanks to Joy):
+
+dotlock pygm2n.`echo $$`.lock {
+ `pygm2n -n local.test`
+}
+
+you can use -a your@address and -s nntphost if local.test is moderated,
+or nntphost isn't localhost
+
+[NOTE: if you've configuration for any other MDA, please file a wishlist
+bug against pyg]
+
+Create local.test (if it doen't exist).
+
+Now any mail you will write to mailgate user, will be sent to the
+server. Read local.test on localhost (or nntphost), you will see
+message.