1 ================================================
2 Mailman - The GNU Mailing List Management System
3 ================================================
5 .. image:: https://gitlab.com/mailman/mailman/badges/master/build.svg
6 :target: https://gitlab.com/mailman/mailman/commits/master
8 .. image:: https://readthedocs.org/projects/mailman/badge
9 :target: https://mailman.readthedocs.io
11 .. image:: http://img.shields.io/pypi/v/mailman.svg
12 :target: https://pypi.python.org/pypi/mailman
14 .. image:: http://img.shields.io/pypi/dm/mailman.svg
15 :target: https://pypi.python.org/pypi/mailman
17 Copyright (C) 1998-2017 by the Free Software Foundation, Inc.
19 This is GNU Mailman, a mailing list management system distributed under the
20 terms of the GNU General Public License (GPL) version 3 or later. The name of
21 this software is spelled "Mailman" with a leading capital 'M' but with a lower
22 case second 'm'. Any other spelling is incorrect.
24 Technically speaking, you are reading the documentation for Mailman Core. The
25 full `Mailman 3 suite <http://docs.mailman3.org>`_ includes a web user
26 interface called Postorius, a web archiver called HyperKitty, and a few other
27 components. If you're looking for instructions on installing the full suite,
28 read that documentation.
30 Mailman is written in Python which is available for all platforms that Mailman
31 is supported on, including GNU/Linux and most other Unix-like operating
32 systems (e.g. Solaris, \*BSD, MacOSX, etc.). Mailman is not supported on
33 Windows, although web and mail clients on any platform should be able to
34 interact with Mailman just fine.
36 The Mailman home page is:
40 and there is a community driven wiki at
44 For more information on Mailman, see the above web sites, or the
45 :ref:`documentation provided with this software <start-here>`.
55 src/mailman/docs/introduction
56 src/mailman/docs/release-notes
57 src/mailman/docs/install
58 src/mailman/config/docs/config
59 src/mailman/docs/database
61 src/mailman/docs/postorius
62 src/mailman/docs/hyperkitty
63 src/mailman/docs/contribute
64 src/mailman/docs/STYLEGUIDE
65 src/mailman/docs/architecture
66 src/mailman/docs/8-miles-high
68 src/mailman/docs/ACKNOWLEDGMENTS
74 These documents are generated from the internal module documentation.
79 src/mailman/model/docs/model
80 src/mailman/runners/docs/runners
81 src/mailman/chains/docs/chains
82 src/mailman/rules/docs/rules
83 src/mailman/handlers/docs/handlers
84 src/mailman/rest/docs/rest
85 src/mailman/core/docs/core
86 src/mailman/app/docs/app
87 src/mailman/styles/docs/styles
88 src/mailman/archiving/docs/common
89 src/mailman/mta/docs/mta
90 src/mailman/bin/docs/master
91 src/mailman/commands/docs/commands