The Mailman Suite¶
The Mailman Suite consists of 5 individual projects. Below are links to documentation for each of the projects, their issue trackers and latest releases.
|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|
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¶
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
- Configure Web Frontend
Migrating to Mailman 3 from Mailman 2.1¶
Migrating from Mailman 2.1 to Mailman 3.x
The User Guide¶
Documentation for Mailman 3 List Owners and Site Administrators is not yet complete.
The Contributor Guide¶
- 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)
- Contributing to Mailman Documentation