commit b61a99d869b6b23e6616eaafa9b261e624f0bb3e
from: Omar Polo <op@omarpolo.com>
date: Sun Jun 06 09:10:22 2021 UTC

add a readme

commit - 990faa37a29c3cde5e0f48336e712c6ad71c5fa4
commit + b61a99d869b6b23e6616eaafa9b261e624f0bb3e
blob - /dev/null
blob + c0a8e64c45e2644281731f6d8782c974c24a9118 (mode 644)
--- /dev/null
+++ README.md
@@ -0,0 +1,13 @@
+# vuserctl
+
+This is a simple virtual user management system for OpenSMTPD and
+Dovecot, as explained on my blog [post][0] (or [over gemini][1])
+
+It won't work out-of-the-box.  Before starting using it, you need to
+provide a valid `userdb` file (as explained in the blog post, a sample
+is included in the repo), and possibly fix `userctl.awk` to define
+your `vmail` user (the UNIX user that will accept the mail for your
+users) and the path for the maildir on the disk.
+
+[0]: https://www.omarpolo.com/post/opensmtd-dovecot-virtual-users.html
+[1]: gemini://gemini.omarpolo.com/post/opensmtd-dovecot-virtual-users.gmi