Retidy
[grml-infrastructure.git] / ml
1 Cookbook for the grml mailinglistsetup
2 ======================================
3
4 Preface
5 -------
6
7 This is a short documentation for common tasks with the grml mailing list
8 setup (mailman). 
9
10 Upstream docs
11 -------------
12
13 http://www.gnu.org/software/mailman/index.html/[Mailman Homepage]
14
15 Introduction
16 ------------
17
18 We use mailman in a non-vhost configuration with `ml.grml.org` as the
19 default host. Mailman is configured with postfix support so that new lists
20 willappear in `/var/lib/mailman/data/aliases` which is configured as an
21 alias database in `/etc/postfix/main.cf`. 
22
23 After creation of a mailinglist it can be configure via the administrative
24 interface at http://ml.grml.org/mailman/admin/`listname`. 
25
26 Mailman is configured to use spamassassin see
27 http://www.jamesh.id.au/articles/mailman-spamassassin for more information. 
28
29 List Archives
30 -------------
31
32 List archives are created automatically and are available via
33 http://ml.grml.org/pipermail/`listname` if enabled via Webfrontend
34 (Archiving Options->Archive messages->Yes and Archiving Options->Is archive
35 file source for public or private archival->public). 
36
37 Common Tasks 
38 ------------
39
40 Add a new mailinglist
41 ~~~~~~~~~~~~~~~~~~~~~~~
42
43 ----------------------
44 newlist [listname [listadmin-addr [admin-password]]]
45 ----------------------
46
47 Where `listname` is the localpart of the mailinglist address and
48 `listadmin-addr` the e-mail address of the list administrator. The new
49 admin will get an e-mail that the new list has been created with all
50 relevant informations included. 
51
52 Subscribe somebody to a mailinglist
53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54
55 You can either use the webfrontend (Membership Management->Mass
56 Subscription) or the commandline.
57
58 ----------------------------
59 add_members `listname`
60 ----------------------------
61
62 Remove somebody from a mailinglist
63 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64
65 You can either use the webfrontend (Membership Management->Mass Removal) or the commandline.
66
67 ----------------------------
68 remove_members `listname`
69 ----------------------------
70
71 Remove list
72 ~~~~~~~~~~~
73
74 ----------------------------
75 rmlist `listname`
76 ----------------------------
77
78 List all members of a list
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~
80
81 ----------------------------
82 list_members [listname]
83 ----------------------------
84
85 Moderation Management
86 ---------------------
87
88 You can manage the moderation queue via webfrontend (Tend to pending
89 moderator requests) or you can use listadmin (`apt-get install listadmin`). 
90 Here is an example config: 
91
92 ----------------------------
93 password <siteadmin or listadminpassword>
94 <listaddress>
95 <listaddress>
96 ..
97 default <approve|discard|reject|skip|none>
98 log <logfilename|none>
99 -----------------------------
100
101 If you call `listadmin` every configured list is checked for pending
102 moderation tasks and you will be prefaced with every mail and will be asked
103 what should happen with the mail.
104
105 About this document
106 -------------------
107
108 (c) Alexander Wirt <formorer@grml.org>; HTML version powered by link:http://www.methods.co.nz/asciidoc/[asciidoc].
109
110 // vim: ft=asciidoc autoindent textwidth=75 formatoptions=tcqn