The Mailman Suite

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

Mailman Core 3.3.1 was released on April 19, 2020. The Mailman Suite consists of 5 individual projects. Below are links to documentation for each of the projects.

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.

• Mailman Core - the mailing list manager core (required)
• Postorius - the adminstrative web user interface
• MailmanClient - the official REST API Python bindings
• HyperKitty - the web archiver
• HyperKitty Mailman plugin - archiver plugin for Core

The Pre-Installation Guide

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

• Pre-Installation Guide
  • What is the current state of Mailman 3?
  • How Can I upgrade from Mailman 2.1.x?
  • What do I need to know before deploying Mailman 3?

Upgrading to Mailman Suite 3.2

Upgrading from Mailman Suite 3.1 to 3.2

• Upgrading to Mailman 3
  • Python 3
  • Migration Steps
  • Configuration
  • Extra Migration Steps

The Installation Guide

• Installation Instructions

Migrating to Mailman 3 from Mailman 2.1

Migrating from Mailman 2.1 to Mailman 3.x

• Migrating from Mailman 2.1 to Mailman 3
  • Why Upgrade?
  • Other considerations
  • Before you upgrade
  • Upgrade strategy

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.

• Configuring Mailman Core
  • Configuring Filesystem Paths
  • Configuring MTA
  • Configuring REST API
  • Configure Templates
  • Configuring Databases
  • Configuring Cron Jobs
• Configure Web Frontend
  • Setting up Admin Account
  • Setting up Email (required)
  • Running the task queue (required)
  • Enable full text search (required)
  • Scheduled Tasks (required)
  • Setting up Database (required)
  • Configure Login to Django
  • Configure Social Login
  • Configure Postorius & Hyperkitty

The User Guide

User Guide

• GNU Mailman 3.1 - List Member Manual
  • Introduction to Mailman Suite
  • I need to talk to a human!
  • Making a Mailman account
  • Subscribing and Unsubscribing
  • Changing your list settings

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

The Contributor Guide

Contributor Guide

• Internationalization(i18n)
  • Offline translations
  • Integration with Weblate
• The Contributor Guide
  • Getting prerequisites
  • Gitlab Setup
  • Set up a directory
  • Set up virtual environments
  • Set up and run Mailman Core
  • Testing Mailman Core
  • Set up Mailman Client
  • Set up Django-mailman3
  • Set up and run Postorius
  • Set up a Fake mail server
  • Set up and run HyperKitty
  • Set up mailman-hyperkitty
  • Link Mailman to HyperKitty
  • Run the Mailman Suite (combined hyperkitty+postorius)