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

167 lines
6.8 KiB
Markdown
Raw Normal View History

2019-09-20 12:55:12 +02:00
# Mailman3 for YunoHost
[![Integration level](https://dash.yunohost.org/integration/mailman3.svg)](https://dash.yunohost.org/appci/app/mailman3)
[![Install Mailman3 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=mailman3)
*[Lire ce readme en français.](./README_fr.md)*
2019-09-22 17:56:54 +02:00
> This package allow you to install Mailman3 quickly and simply on a YunoHost server.
2019-09-20 12:55:12 +02:00
2019-09-22 17:56:54 +02:00
*If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
2019-09-20 12:55:12 +02:00
2019-09-22 18:32:29 +02:00
## Status
**Experimental.**
2019-09-30 15:50:17 +02:00
Please review the [issues list](https://github.com/YunoHost-Apps/mailman3_ynh/issues) before choosing to install this application.
There is also a [community forum thread](https://forum.yunohost.org/t/community-app-mailman3-free-software-for-managing-electronic-mail-discussion-and-e-newsletter-lists/9077/2) for this application.
2019-09-20 12:55:12 +02:00
## 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.).
2019-09-22 17:50:24 +02:00
> http://docs.mailman3.org/en/latest/userguide.html
2019-09-20 12:55:12 +02:00
2019-09-22 17:30:44 +02:00
**Shipped version:** 3.2.0
2019-09-20 12:55:12 +02:00
## Screenshots
![](https://image.slidesharecdn.com/hyperkitty-160201173833/95/hyperkitty-a-web-interface-for-gnu-mailman-3-8-638.jpg?cb=1454349750)
## Demo
* [Official demo](https://lists.mailman3.org/mailman3/lists/)
2019-09-22 17:30:51 +02:00
No user/password is provided, so you must sign up.
2019-09-20 12:55:12 +02:00
## Post-installation steps
### Setup Admin User
You must [configure the admin user](http://docs.mailman3.org/en/latest/config-web.html#setting-up-admin-account):
```bash
$ 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](https://github.com/YunoHost-Apps/rainloop_ynh) installed to view mail on your YunoHost installation.
2019-09-22 18:24:01 +02:00
### Setup your main domain
You'll need to log in as administrator and visit the `/admin/site/site`.
2019-09-30 15:50:17 +02:00
If you're Mailman3 is setup on `https://myyunohost.org` then that would be the following:
2019-09-22 18:24:01 +02:00
2019-09-24 20:55:11 +02:00
> https://myyunohost.org/admin/site/site
2019-09-22 18:24:01 +02:00
2019-09-23 18:25:43 +02:00
### Configure incoming mail
2019-09-23 17:41:48 +02:00
Mailman3 implements an LMTP server for receiving mail from Postfix. This means that Mailman3 doesn't need anything from Dovecot. This is important to understand because Dovecot is the default YunoHost local delivery agent. Therefore, the default YunoHost Postfix configuration uses Dovecot. So, in order to deliver incoming mail, we need to override which delivery agent handles which mails based on the addresses. In other words, if you create a mailing list "mylist@myyunohost.org" you want Mailman3's LMTP server to receive this, *not* Dovecot, becaues Dovecot only delivers to LDAP created user accounts.
You'll need to add this to your Postfix configuration:
```bash
owner_request_special = no
transport_maps =
hash:/var/lib/mailman3/data/postfix_lmtp
local_recipient_maps =
hash:/var/lib/mailman3/data/postfix_lmtp
virtual_mailbox_maps = ldap:/etc/postfix/ldap-accounts.cf, hash:/var/lib/mailman3/data/postfix_lmtp
```
And then run:
```bash
2019-09-24 20:55:18 +02:00
$ sudo -su list mailman aliases
2019-09-23 17:41:48 +02:00
```
This is unfortunately a manual step at this point because the package remains experimental. Once it matures, this will be integrated into a hook or the default Postfix configuration. For now, remember that when you run `yunohost tools regen-conf postfix` or if any installation invokes `regen-conf`, your Postfix configuration will not be changed because it has diverged from the default configuration. This may cause you problems if YunoHost core expects that there is some new value in your Postfix configuration.
2019-09-23 18:25:43 +02:00
### Configure outgoing mail
Postfix relies on using SMTP which should be configured in your `/etc/postfix/main.cf`.
2019-09-30 15:50:17 +02:00
You should make sure that you have outgoing mail working before getting started with Mailman 3.
2019-09-20 12:55:12 +02:00
2019-09-30 15:50:17 +02:00
## General Configuration
2019-09-20 12:55:12 +02:00
2019-09-30 15:50:17 +02:00
Mailman 3 or "The Mailman Suite" is made up of 5 moving parts. See the following documentation for more:
2019-09-20 12:55:12 +02:00
2019-09-30 15:50:17 +02:00
> http://docs.mailman3.org/en/latest/index.html#the-mailman-suite
2019-09-20 12:55:12 +02:00
On your YunoHost, all the configuration files you need to worry about are in:
* `/etc/mailman3/`
2019-09-30 15:50:17 +02:00
* `/usr/share/mailman3-web/`
The services you need to manage can be checked with:
* `systemctl status mailman3`
* `systemctl status mailman3-web`
2019-09-20 12:55:12 +02:00
2019-09-30 15:50:17 +02:00
It is important to note that this package makes use of the [mailman3-full](http://docs.mailman3.org/en/latest/prodsetup.html#distribution-packages) Debian package contained in the Debian Stretch backports repository. The default installation assumes the use of a SQLite3 database but the installation script overrides this and uses a PostgreSQL database instead.
2019-09-20 12:55:12 +02:00
2019-09-22 18:25:46 +02:00
Finally, you also configure things through the Django web admin available at `/admin/`.
2019-09-20 12:55:12 +02:00
## YunoHost specific features
#### Multi-users support
2019-09-30 15:50:17 +02:00
* No LDAP support yet (apparently under development)
2019-09-24 21:11:36 +02:00
* Users can also just sign up themselves to manage details
* Users can use mailing lists without signing up
2019-09-20 12:55:12 +02:00
#### Supported architectures
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mailman3%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mailman3/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mailman3%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mailman3/)
## Limitations
2019-09-30 15:50:17 +02:00
* Migrating from Mailman 2.X is not officially supported, sorry. However, there is a manual and
which details an experimental process. Please see [the documentation](https://docs.mailman3.org/en/latest/migration.html).
2019-09-20 12:55:12 +02:00
2019-09-30 15:50:17 +02:00
* Mailman3 must be configured to use a root domain (https://myyunohost.org and not https://myyunohost.org/mailman3).
2019-09-20 12:55:12 +02:00
* You must have a HTTPS certificate installed on the root domain.
2019-09-23 17:41:48 +02:00
* There may be only one installation per YunoHost.
2019-09-20 12:55:12 +02:00
## Mirroring
* https://github.com/YunoHost-Apps/mailman3_ynh
* https://hack.decentral1.se/yunohost-packages/mailman3_ynh
## Links
* Report a bug: https://github.com/YunoHost-Apps/mailman3_ynh/issues
* App website: http://docs.mailman3.org/en/latest/index.html
* Upstream app repository: https://gitlab.com/mailman/mailman-suite
* YunoHost website: https://yunohost.org/
---
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](https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing).
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:
```bash
$ yunohost app upgrade mailman3 -u https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug
```