Differences between revisions 7 and 9 (spanning 2 versions)
Revision 7 as of 2016-10-24 16:21:55
Size: 3541
Editor: msapiro
Comment: Added django-mailman3.
Revision 9 as of 2018-04-20 07:02:13
Size: 2060
Editor: maxking
Comment:
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:
 * '''Mailman !HyperKitty''' is a plugin for Mailman Core to communicate with HyperKitty.
Line 13: Line 14:
 * '''Mailman Bundler''' is a tool to help you install all of Mailman Suite via PyPI
Line 20: Line 20:
Right now, the easiest way is probably to use the [[https://gitlab.com/mailman/mailman-bundler/|Mailman 3 bundler]].

The [[http://mailman-bundler.readthedocs.org|Mailman bundler documentation]] is reasonably comprehensive. It guides you through an initial setup and then gives tips on how to switch it to a production setup. The production documentation hasn't been tested by a huge number of people yet: if you have any suggestions on how it could be improved, please [[https://gitlab.com/mailman/mailman-bundler/issues|file documentation bugs on GitLab]] or let us know via the [[http://list.org/contact.html|mailman mailing lists]].
See [[ http://docs.mailman3.org/en/latest/prodsetup.html| here ]] for more details about various options for production installation.
Line 26: Line 24:
Everything you need to know on how to setup Mailman 3 for development can be found in the getting started section of the [[DEV/Home|development homepage]]. Everything you need to know on how to setup Mailman 3 for development can be found in [[http://docs.mailman3.org/en/latest/devsetup.html|The Contributing Guide]].
Line 30: Line 28:
== How do I backup my Mailman 3 installation? ==

If you installed using mailman-bundler, all the data files for your running lists are stored in {{{$mailman-bundler/var}}} (where {{{$mailman-bundler}}} is the directory where you installed the bundler).

To back up those files, you probably want to stop mailman so that none of the files change while you're backing them up. Don't worry, email will generally queue up if messages can't be delivered, so unless you have a highly unusual mail setup there's no harm in taking mailman offline for a few minutes. Then make a copy of all the files in {{{var/}}}

On Linux, you'll be doing something like:
{{{
bin/mailman stop
cp -r var/ $backup_directory/
bin/mailman start
}}}

where $backup_directory is the name of your backup directory (e.g. {{{~/backup/2015-12-05/}}})

You probably also made changes to config in
{{{
mailman_web/development.py
mailman_web/production.py
}}}
which may also need to be saved.

Mailman 3 documentation

Mailman 3 is still pretty new, and most of the docs are built with the packages: Links to all the docs

Unlike Mailman 2, Mailman 3 has been divided into a number of parts:

  • Mailman Suite refers to the collection of related Mailman projects that provide all the pieces of a typical mailing list management setup.

  • Mailman Core is the part that delivers the emails and handles the mailing list and user data

  • Postorius is the web interface that allows users (list members, list admins, moderators) to change their user settings and the settings for their lists.

  • HyperKitty is the archiver which provides a web interface to access GNU Mailman v3 archives as well as ways interact with the lists. It can behave a little like a web forum, for those who prefer not to use email.

  • Mailman HyperKitty is a plugin for Mailman Core to communicate with HyperKitty.

  • Django Mailman3 is a set of Django libraries and templates common to Postorius and HyperKitty. It is new with Mailman 3.1.

  • MailmanClient is the library that provides official Python bindings for the GNU Mailman 3 REST API. This allows you to write your own front end or scripts for interacting with Mailman. (It's also what Postorius uses to interact with Mailman Core.)

A typical install would use all of these pieces together, but they're intended to be modular so you could replace a single piece if you had specific needs.

How do I install Mailman 3 for production?

See here for more details about various options for production installation.

How do I install Mailman 3 for development?

Everything you need to know on how to setup Mailman 3 for development can be found in The Contributing Guide.

How do I upgrade from Mailman 2 to Mailman 3?

Where can I find my Mailman 3 configuration files?

MailmanWiki: DOC/Mailman3 (last edited 2018-04-20 07:02:13 by maxking)