X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=examples%2FREADME.unsubscribe;fp=examples%2FREADME.unsubscribe;h=7c41067cdd50a2641b82715eb2f03138b49aa9e4;hb=1f29b33d3f71b8a40f5ae76bf20b95618b518654;hp=0000000000000000000000000000000000000000;hpb=d6cdb106f27abed5d05da035c95e106939fbe3b2;p=public-inbox.git
diff --git a/examples/README.unsubscribe b/examples/README.unsubscribe
new file mode 100644
index 00000000..7c41067c
--- /dev/null
+++ b/examples/README.unsubscribe
@@ -0,0 +1,40 @@
+Unsubscribe endpoints for mlmmj users (and possibly Mailman, too)
+
+* examples/unsubscribe.milter filters outgoing messages
+ and appends an HTTPS URL to the List-Unsubscribe header.
+ This List-Unsubscribe header should point to the PSGI
+ described below.
+ Currently, this is only active for a whitelist of test
+ addresses in /etc/unsubscribe-milter.whitelist
+ with one email address per line.
+
+* examples/unsubscribe.psgi is a PSGI which needs to run
+ as the mlmmj user with permission to run mlmmj-unsub.
+ This depends on the PublicInbox::Unsubscribe module
+ which may be extracted from the rest of public-inbox.
+ It is strongly recommended to NOT run the rest of the
+ public-inbox WWW code in the same process as this PSGI.
+ (The public-inbox WWW code will never need write
+ permissions to anything besides stderr).
+
+* Both the .milter and .psgi examples are bundled with
+ systemd service and socket activation examples.
+ AFAIK no other PSGI server besides public-inbox-httpd
+ supports systemd socket activation.
+
+To wire up the milter for postfix, I use the following
+in /etc/postfix/main.cf:
+
+ # Milter configuration
+ milter_default_action = accept
+ milter_protocol = 2
+
+ # other milters may be chained here (e.g. opendkim)
+ # chroot users will need to adjust this path
+ smtpd_milters = local:/var/spool/postfix/unsubscribe/unsubscribe.sock
+
+ # This is not needed for mlmmj since mlmmj uses SMTP:
+ # non_smtpd_milters = local:/var/spool/postfix/unsubscribe/unsubscribe.sock
+
+Copyright (C) 2016 all contributors
+License: AGPL-3.0+