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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
================================
Getting started with GNU Mailman
================================
Copyright (C) 2008-2012 by the Free Software Foundation, Inc.
Beta Release
============
This is a beta release. The developers believe it has sufficient
functionality to provide full mailing list services, but it is not yet ready
for production use.
The Mailman 3 beta releases are being provided to give developers and other
interested people an early look at the next major version, and site
administrators a chance to prepare for an eventual upgrade. The core list
management and post distribution functionality is now complete. However,
unlike Mailman 2 whose web interface and archives were tightly integrated with
the core, Mailman 3 exposes a REST administrative interface to the web,
communicates with archivers via decoupled interfaces, and leaves summary,
search, and retrieval of archived messages to a separate application (a simple
implementation is provided). As of beta 1 the web interface and archiver are
still at an early stage of development. As such, some things may not work.
Contributions are welcome. Please submit bug reports on the Mailman bug
tracker at https://bugs.launchpad.net/mailman though you will currently need
to have a login on Launchpad to do so. You can also send email to the
mailman-developers@python.org mailing list.
Requirements
============
Python 2.6 or 2.7 is required. It can either be the default 'python' on your
$PATH or it can be accessible via the ``python2.6`` or ``python2.7`` binary.
If your operating system does not include Python, see http://www.python.org
downloading and installing it from source. Python 3 is not yet supported.
In this documentation, a bare ``python`` refers to the Python executable used
to invoke ``bootstrap.py``, which might be ``python2.6`` or ``python2.7``, as
well as the system ``python`` or an absolute path.
Mailman 3 is now based on the `zc.buildout`_ infrastructure, which greatly
simplifies building and testing Mailman.
During the beta program, you may need some additional dependencies, such as a
C compiler and the Python development headers and libraries. You will need an
internet connection. Also `Postorius`_ (the web UI) and the `archive UI`_ are
distributed and installed separately.
Building Mailman 3
==================
Here are the commands to build everything in core Mailman::
% python bootstrap.py
% bin/buildout
Sit back and have some Kombucha while you wait for everything to download and
install.
Now you can run the test suite via::
% bin/test -vv
You should see no failures.
Build the online docs by running::
% python setup.py build_sphinx
(You might get warnings which you can safely ignore.) Then visit::
build/sphinx/html/README.html
in your browser to start reading the documentation. Or you can just read the
doctests by looking in all the 'doc' directories under the 'mailman' package.
Doctests are documentation first, so they should give you a pretty good idea
how various components of Mailman 3 work.
Running Mailman 3
=================
What, you actually want to *run* Mailman 3? Oh well, if you insist. You
will need to set up a configuration file to override the defaults and set
things up for your environment. Mailman is configured via the `lazr.config`_
package which is really just a fancy ini-style configuration system.
``src/mailman/config/schema.cfg`` defines the ini-file schema and contains
documentation for every section and configuration variable. Sections that end
in `.template` or `.master` are templates that must be overridden in actual
configuration files. There is a default configuration file that defines these
basic overrides in ``src/mailman/config/mailman.cfg``. Your own configuration
file will override those.
By default, all runtime files are put under a `var` directory in the current
working directory.
Mailman searches for its configuration file using the following search path.
The first existing file found wins.
* ``-C config`` command line option
* ``$MAILMAN_CONFIG_FILE`` environment variable
* ``./mailman.cfg``
* ``~/.mailman.cfg``
* ``/etc/mailman.cfg``
* ``argv[0]/../../etc/mailman.cfg``
Run the ``bin/mailman info`` command to see which configuration file Mailman
will use, and where it will put its database file. The first time you run
this, Mailman will also create any necessary run-time directories and log
files.
Try ``bin/mailman --help`` for more details. You can use the commands
``bin/mailman start`` to start the runner subprocess daemons, and of course
``bin/mailman stop`` to stop them.
Postorius is being developed as a separate, Django-based project. For now,
all configuration happens via the command line and REST API.
Mailman Web UI
--------------
The Mailman 3 web UI, called *Postorius*, interfaces to core Mailman engine
via the REST client API. It is expected that this architecture will make it
possible for users with other needs to adapt the web UI, or even replace it
entirely, with a reasonable amount of effort. However, as a core feature of
Mailman, the web UI will emphasize usability over modularity at first, so most
users should use the web UI described here.
Postorius was prototyped at the `Pycon 2012 sprint`_, so it is "very alpha" as
of Mailman 3 beta 1, and comes in several components. In particular, it
requires a `Django`_ installation, and Bazaar checkouts of the `REST client
module`_ and `Postorius`_ itself. Building it is fairly straightforward,
however, given Florian Fuchs' `Five Minute Guide` from his `blog post`_ on the
Mailman wiki. (Check the `blog post`_ for the most recent version!)
The List Archiver
-----------------
In Mailman 3, the archivers are decoupled from the core engine. It is useful
to provide a simple, standard interface for third-party archiving tools and
services. For this reason, Mailman 3 defines a formal interface to insert
messages into any of a number of configured archivers, using whatever protocol
is appropriate for that archiver. Summary, search, and retrieval of archived
posts are handled by a separate application.
A new `archive UI`_ called Hyperkitty, based on the `notmuch mail indexer`_
and `Django`_, was prototyped at the PyCon 2012 sprint by Toshio Kuratomi, and
like the web UI it is also in early alpha as of Mailman 3 beta 1. The
"hyperkitty" archiver is very loosely coupled to Mailman 3 core. In fact, any
email application that speaks LMTP or SMTP will be able to use hyperkitty.
A `five minute guide to hyperkitty`_ is based on Toshio Kuratomi's README.
.. _`zc.buildout`: http://pypi.python.org/pypi/zc.buildout
.. _`lazr.config`: http://pypi.python.org/pypi/lazr.config
.. _`Postorius`: https://launchpad.net/postorius
.. _`archive UI`: https://launchpad.net/hyperkitty
.. _`Django`: http://djangoproject.org/
.. _`REST client module`: https://launchpad.net/mailman.client
.. _`Five Minute Guide the Web UI`: WebUIin5.html
.. _`blog post`: http://wiki.list.org/display/DEV/A+5+minute+guide+to+get+the+Mailman+web+UI+running
.. _`notmuch mail indexer`: http://notmuchmail.org
.. _`five minute guide to hyperkitty`: ArchiveUIin5.html
.. _`Pycon 2012 sprint`: https://us.pycon.org/2012/community/sprints/projects/
|
