The Mailman Suite

The Mailman home page is http://www.list.org, and there is a community driven wiki at http://wiki.list.org.

The Mailman Suite consists of 5 individual projects. Below are links to documentation for each of the projects, their issue trackers and latest releases.

Those packages are copyrighted by the Free Software Foundation and distributed under the terms of the GNU General Public License (GPL) version 3 or later.

Project Description Issues Docs Release CI Status
Mailman Core The mailing list manager core Issues Docs
Postorius The web user interface Issues Docs
Hyperkitty The web archiver Issues Docs
Mailmanclient The official REST API python bindings Issues Docs
Hyperkitty Mailman plugin Archiver plugin for Core Issues Docs
Django-mailman3 Django utilities for Web UI Issues Docs
mailman-web Singular package for Mailman's Web UI (includes Postorius & Hyperkitty) Issues Docs

Note

There are inconsistencies throughout this documentation in examples which invoke the Django management commands. The actual invocation depends on how Django and Mailman 3 are installed. It may be

  • mailman-web …

  • python manage.py …

  • django-admin …

or something else. When reading these docs, you may need to translate one of the above into what works in your installation.

The Pre-Installation Guide

What do I need to know before trying to install Mailman3?

The Installation Guide

Installation

Configuring Mailman 3

Mailman 3 can be configured in a wide variety of ways. After you have installed Mailman 3, you can now proceed to configure it for production use.

Configuration

Migrating to Mailman 3 from Mailman 2.1

Migrating from Mailman 2.1 to Mailman 3.x

Migrating from 2.1

The User Guide

User Guide

Documentation for Mailman 3 List Owners and Site Administrators is not yet complete.

The Contributor Guide

Contributor Guide