mirror of https://github.com/YunoHost-Apps/mailman3_ynh.git synced 2024-09-03 19:36:17 +02:00

Mailman - The GNU Mailing List Management System packaged for YunoHost.

Find a file

Luke Murphy 2f7c4cebf1 Don't use HTTPS internally This can avoid any mismatching issue with SSL packages.		2019-09-22 18:31:51 +02:00
conf	Don't use HTTPS internally	2019-09-22 18:31:51 +02:00
scripts	Ensure mandatory path is available in settings	2019-09-22 17:53:08 +02:00
.gitignore	Bootstrapping mailman3 package	2019-09-22 17:17:28 +02:00
check_process.default	Bootstrapping mailman3 package	2019-09-22 17:17:28 +02:00
LICENSE	Bootstrapping mailman3 package	2019-09-22 17:17:28 +02:00
manifest.json	Bootstrapping mailman3 package	2019-09-22 17:17:28 +02:00
pull_request_template.md	Bootstrapping mailman3 package	2019-09-22 17:17:28 +02:00
README.md	Add note about the django admin	2019-09-22 18:25:46 +02:00
README_fr.md	Bootstrapping mailman3 package	2019-09-22 17:17:28 +02:00

README.md

Mailman3 for YunoHost

Lire ce readme en français.

This package allow you to install Mailman3 quickly and simply on a YunoHost server.

If you don't have YunoHost, please see here to know how to install and enjoy it.

Overview

This is GNU Mailman, a mailing list management system distributed under the terms of the GNU General Public License (GPL) version 3 or later. Mailman is written in Python which is available for all platforms that Mailman is supported on, including GNU/Linux and most other Unix-like operating systems (e.g. Solaris, *BSD, MacOSX, etc.).

http://docs.mailman3.org/en/latest/userguide.html

Shipped version: 3.2.0

Screenshots

Demo

Official demo

No user/password is provided, so you must sign up.

Post-installation steps

Setup Admin User

You must configure the admin user:

$ cd /usr/share/mailman3-web
$ python3 manage.py createsuperuser

You should then attempt to log in with this user account in the web UI. Once you've logged in, a confirmation mail will be sent to your email address that you specified. Therefore, you should have something like Rainloop installed to view mail on your YunoHost installation.

Setup your main domain

You'll need to log in as administrator and visit the /admin/site/site.

If you're Mailman3 is setup on myyunohost.org then that would be the following:

myyunohost.org/admin/site/site

Configuration

Mailman3 is made up of 3 moving parts:

Mailman3 Core: https://mailman.readthedocs.io
Postorious: https://postorius.readthedocs.io
Hyperkitty: https://hyperkitty.readthedocs.io

There is also documentation for "the suite" which is all the parts together:

https://docs.mailman3.org

On your YunoHost, all the configuration files you need to worry about are in:

/etc/mailman3/

It is important to note that this package makes use of the mailman3-full Debian package contained in the Debian Stretch backports repository.

Finally, you also configure things through the Django web admin available at /admin/.

Documentation

Official documentation

YunoHost specific features

Multi-users support

No LDAP support
HTTP Auth is supported
Only one installation per YunoHost

Supported architectures

x86-64b -
ARMv8-A -

Limitations

Migrating from Mailman 2.X is not supported. This is a manual and experimental process. Please see the documentation.
Mailman3 must be configured to use a root domain (myyunohost.org and not myyunohost.org/mailman3).
You must have a HTTPS certificate installed on the root domain.

Mirroring

Developers info

Only if you want to use a testing branch for coding, instead of merging directly into master.

Please make your pull request against the testing branch.

To try the testing branch:

$ yunohost app install https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug

Or to upgrade from the testing branch:

$ yunohost app upgrade mailman3 -u https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug