Mercurial > hg > mlmmj
annotate README @ 790:e05f92db6857 BRANCH_1_2_17
Added tag RELEASE_1_2_17_1 for changeset dc0f9614c839
| author | Ben Schmidt |
|---|---|
| date | Sun, 21 Nov 2010 01:00:59 +1100 |
| parents | dc0f9614c839 |
| children |
| rev | line source |
|---|---|
| 789 | 1 README mlmmj-1.2.17.1 Aug 24th 2010 |
| 0 | 2 |
| 71 | 3 This is an attempt at implementing a mailing list manager with the same |
| 0 | 4 functionality as the brilliant ezmlm, but with a decent license and mail server |
| 5 independency. | |
| 6 | |
| 304 | 7 The functionality: |
| 0 | 8 |
| 9 · Archive | |
| 10 · Custom headers / footer | |
| 209 | 11 · Fully automated bouncehandling (similar to ezmlm) |
| 12 · Complete requeueing functionality | |
| 71 | 13 · Moderation functionality |
| 92 | 14 · Subject prefix |
| 222 | 15 · Subscribers only posting |
| 261 | 16 · Regular expression access control |
| 304 | 17 · Functionality to retrieve old posts |
| 18 · Web-interface | |
| 338 | 19 · Digests |
| 387 | 20 · No mail delivery subscription |
| 430 | 21 · VERP support |
|
456
160dab909572
Add .filename.lock file to lock against. Only allow addresses with a @ in them. 1.2.3
mmj
parents:
451
diff
changeset
|
22 · Delivery Status Notification (RFC1891) support |
| 0 | 23 |
| 24 To use mlmmj, do the following: | |
| 25 | |
| 451 | 26 0) Compile it if you're not using a binary package such as dpkg, rpm or |
| 27 a ports collection from a BSD or Gentoo. To compile, untar the tar-ball | |
| 28 and do: | |
| 29 | |
| 30 $ ./configure && make && make install | |
| 31 | |
|
655
d0eac1a38a8b
Added --enable-recieve-strip configure option (Ansgar Burchardt)
mortenp
parents:
639
diff
changeset
|
32 If you want to filter multipart/mime messages, pass the option |
|
d0eac1a38a8b
Added --enable-recieve-strip configure option (Ansgar Burchardt)
mortenp
parents:
639
diff
changeset
|
33 --enable-recieve-strip to configure, and take a look at |
|
d0eac1a38a8b
Added --enable-recieve-strip configure option (Ansgar Burchardt)
mortenp
parents:
639
diff
changeset
|
34 contrib/recievestrip/README. |
|
d0eac1a38a8b
Added --enable-recieve-strip configure option (Ansgar Burchardt)
mortenp
parents:
639
diff
changeset
|
35 |
| 533 | 36 1) Configure a recipient delimiter. The default is to use '+', and in |
| 37 Postfix it's done by adding | |
| 0 | 38 |
| 210 | 39 recipient_delimiter = + |
| 0 | 40 |
| 280 | 41 to /etc/postfix/main.cf. In Exim it can be done by adding |
| 271 | 42 |
| 43 local_part_suffix = +* | |
| 44 local_part_suffix_optional | |
| 45 | |
| 315 | 46 to the "userforward:" and the "localuser:" router in /etc/exim/exim.conf, |
| 323 | 47 and also add "local_part_suffix = +*" to the system_aliases function. Also |
| 48 make sure that exim will add the envelope from in the Return-Path: header. | |
| 0 | 49 |
| 323 | 50 There is a nice FAQ explaining recipient delimiter configuration here: |
| 51 | |
| 52 http://faqs.org/faqs/mail/addressing/ | |
| 0 | 53 |
| 533 | 54 The mmj TUNABLE "delimiter" configures this on a per list basis |
| 55 | |
| 210 | 56 2) Create the mailinglist. There's a script, mlmmj-make-ml.sh, that will make |
| 57 a mailinglist for mlmmj. It is highly recommended to use this script to make | |
| 58 the lists! What is does is described here: | |
| 0 | 59 |
| 210 | 60 In the case of a list called mlmmj-test below /var/spool/mlmmj it makes the |
| 61 following directories: | |
| 0 | 62 |
| 210 | 63 /var/spool/mlmmj/mlmmj-test/incoming |
| 64 /var/spool/mlmmj/mlmmj-test/queue | |
| 65 /var/spool/mlmmj/mlmmj-test/queue/discarded | |
| 66 /var/spool/mlmmj/mlmmj-test/archive | |
| 67 /var/spool/mlmmj/mlmmj-test/text | |
| 68 /var/spool/mlmmj/mlmmj-test/subconf | |
| 69 /var/spool/mlmmj/mlmmj-test/unsubconf | |
| 70 /var/spool/mlmmj/mlmmj-test/bounce | |
| 71 /var/spool/mlmmj/mlmmj-test/control | |
| 72 /var/spool/mlmmj/mlmmj-test/moderation | |
| 73 /var/spool/mlmmj/mlmmj-test/subscribers.d | |
| 366 | 74 /var/spool/mlmmj/mlmmj-test/digesters.d |
| 75 /var/spool/mlmmj/mlmmj-test/nomailsubs.d | |
| 210 | 76 /var/spool/mlmmj/mlmmj-test/requeue |
| 0 | 77 |
| 286 | 78 NOTE: The mailinglist directory (/var/spool/mlmmj/mlmmj-test in our |
| 79 example) have to be owned by the user the mailserver writes as. On some | |
| 80 Postfix installations Postfix is run by the user postfix, but still writes | |
| 81 files as nobody:nogroup or nobody:nobody | |
| 0 | 82 |
| 210 | 83 3) Make the changes to your mailserver aliases that came as output from |
| 84 mlmmj-make-ml.sh. Following the example above they will look like this: | |
| 0 | 85 |
| 323 | 86 mlmmj-test: "|/usr/bin/mlmmj-recieve -L /var/spool/mlmmj/mlmmj-test" |
| 0 | 87 |
| 210 | 88 NOTE: Don't forget newaliases. |
| 0 | 89 |
| 210 | 90 4) Start mlmmj-maintd (remember full path when starting it!) or add it to |
| 216 | 91 crontab with -F switch. The recommended way for now is to run it via cron: |
| 209 | 92 |
| 210 | 93 "0 */2 * * * /usr/bin/mlmmj-maintd -F -L /var/spool/mlmmj/mlmmj-test" |
| 209 | 94 |
| 286 | 95 It should be started as root, as mlmmj-maintd will become the user owning |
| 96 the listdir (/var/spool/mlmmj/mlmmj-test), and log it's last maintenance | |
| 97 run to listdir/mlmmj-maintd.lastrun.log. | |
| 98 | |
| 366 | 99 If you have several lists below /var/spool/mlmmj you can use -d: |
| 100 /usr/bin/mlmmj-maintd -F -d /var/spool/mlmmj | |
| 185 | 101 |
| 323 | 102 That's it! You probably want to go through the next steps too. |
| 0 | 103 |
| 210 | 104 5) Subscribe some people |
| 0 | 105 |
| 210 | 106 /usr/bin/mlmmj-sub -L /var/spool/mlmmj/mlmmj-test/ -a joe@domain.tld |
| 107 | |
| 108 etc. | |
| 0 | 109 |
| 210 | 110 6) If you want custom headers like X-Mailinglist, Reply-To: etc. just add a |
| 111 file called 'customheaders' in the list control/ directory like this: | |
| 112 $ cat /var/spool/mlmmj/mlmmj-test/control/customheaders | |
| 113 X-Mailinglist: mlmmj-test | |
| 114 Reply-To: mlmmj-test@domain.tld | |
| 0 | 115 |
| 210 | 116 7) If you want every mail to have something like: |
| 117 -- | |
| 118 To unsubscribe send a mail to coollist+unsubscribe@lists.domain.net | |
| 119 | |
| 120 Just add what you want to a file named "footer" in the same dir as | |
| 121 "customheader" (listdir/control/). | |
| 0 | 122 |
| 210 | 123 8) If you want a prefix on the subject, to make it look like this: |
| 124 Subject: [mlmmj-test] how are we doing? | |
| 125 Simply do 'echo "[mlmmj-test]" > control/prefix | |
| 0 | 126 |
| 210 | 127 9) For having a moderated list, simply create a file called 'moderated' in the |
| 128 control/ directory. Moderators are added to a file called 'moderators' in | |
| 129 the control/ dir as well. | |
| 0 | 130 |
| 210 | 131 10) Have a look at the file TUNABLES for runtime configurable things. |
| 92 | 132 |
|
81
f435923b65e4
mlmmj-{,un}sub have been brought up to speed in a coordinated effort
mortenp
parents:
71
diff
changeset
|
133 Tunables in include/mlmmj.h: |
| 185 | 134 · There's some time intervals for how mlmmj-maintd operates. I've choosen |
| 135 non-strict defaults, so depending on your BOFH rate you might want to tweak. | |
| 210 | 136 The defaults should be good for most people though. |
| 0 | 137 |
| 138 Have a fun! | |
| 139 | |
| 32 | 140 Mads Martin Joergensen <mmj at mmj dot dk> |
| 141 Morten K. Poulsen <morten at afdelingp dot dk> |