Simon Volpert remailer / master README.md
master

Tree @master (Download .tar.gz)

README.md @master — view rendered · raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# remailer
## A PGP-enforcing newsletter implementation

`remailer` is a newsletter implementation that relies on PGP signatures for authentication.

For the sender, posting to the newsletter is absolutely transparent: compose an email, sign it, send it.

The subscriber gets the usual mailing list options: subscribe, verify subscription, unsubscribe, subscription details, as well as transparent sender verification via PGP/GPG.

To use it on your webserver, you need to do the following:

  1. Copy `remailer.cfg.sample` to `remailer.cfg` and edit it according to your needs;
  2. Copy the `sample` directory to the list's name and edit the contents to reflect your list's properties.
  3. Add the PGP keys of the persons allowed to post to the keyring you have referenced in `remailer.cfg`;
  4. Add the `From:` string of the person allowed to post to the `list_owner` key in the configuration file;
  5. Create a mail filter which pipes incoming messages for the newsletter to the `remailer.py` script. Examples for EXIM:

### On private hosting, with a dedicated `remailer` user

In `/etc/aliases`:

    list: remailer
    list-request: remailer

In `/home/remailer/.forward` (or equivalent):

    # Exim filter
    if not delivered then
        pipe "/path/to/remailer.py"
    endif

### On private hosting, without a dedicated `remailer` user

In `/etc/aliases`:

    list: |/path/to/remailer.py
    list-request: |/path/to/remailer.py

Since it's not immediately obvious which user ends up running that script, make sure to test your configuration to get your file permissions right.

### For a shared hosting environment

In your `.forward`:

    # Exim filter
    if $local_part is "list" or $local_part is "list-request" then
        pipe "/path/to/remailer.py"
    endif

### User management

To subscribe to the newsletter, have the user send an email with the subject "subscribe" to the list-request address. They will receive a verification email to which they will need to reply.

To unsubscribe, have the user send an email with the subject "unsubscribe" to the list-request address.

To see the details of their subscription, have the user send an email with the subject "details" to the list-request address.

Invalid emails (those with unrecognized commands or from unauthorized senders) are saved in the script's working directory for future examination.

### Other Notes

This program is free software, released under the Apache License, Version 2.0. See the LICENSE file for more information.

The program's canonical project page resides at https://simonvolpert.com/remailer/

I gratefully accept appreciation for my work in material form at __[bitcoincash:qr9mj4r9sq3urkjl6hhspeyjj62l3k3mzckaqq0kj8](bitcoincash:qr9mj4r9sq3urkjl6hhspeyjj62l3k3mzckaqq0kj8)__.