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

Merge branch 'upgrade' of https://github.com/YunoHost-Apps/mailman3_ynh into upgrade

Browse source
This commit is contained in:
yalh76 2021-08-22 13:21:35 +02:00
commit a781ae53ed
2 changed files with 177 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

96
README.md
View file

@ -1,39 +1,43 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# Mailman3 for YunoHost # Mailman3 for YunoHost
[![Integration level](https://dash.yunohost.org/integration/mailman3.svg)](https://dash.yunohost.org/appci/app/mailman3) [![Integration level](https://dash.yunohost.org/integration/mailman3.svg)](https://dash.yunohost.org/appci/app/mailman3) ![](https://ci-apps.yunohost.org/ci/badges/mailman3.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mailman3.maintain.svg)
[![Install Mailman3 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=mailman3) [![Install Mailman3 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mailman3)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> This package allow you to install Mailman3 quickly and simply on a YunoHost server. > *This package allows you to install Mailman3 quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
*If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Status
**Experimental.**
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.
## Overview ## 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.). Electronic mailing lists manager
> http://docs.mailman3.org/en/latest/userguide.html **Shipped version:** 1.0~ynh1
**Shipped version:** 3.2.0 **Demo:** https://lists.mailman3.org/mailman3/lists/
## Screenshots ## Screenshots
![](https://image.slidesharecdn.com/hyperkitty-160201173833/95/hyperkitty-a-web-interface-for-gnu-mailman-3-8-638.jpg?cb=1454349750) ![](./doc/screenshots/screenshot1.webp)
## Demo ## Disclaimers / important information
* [Official demo](https://lists.mailman3.org/mailman3/lists/) * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
No user/password is provided, so you must sign up. * Other infos that people should be aware of, such as:
* No LDAP support yet (apparently under development)
* Users can also just sign up themselves to manage details
* Users can use mailing lists without signing up?
## Post-installation steps ## Post-installation steps
@ -108,19 +112,6 @@ It is important to note that this package makes use of the [mailman3-full](http:
Finally, you also configure things through the Django web admin available at `/admin/`. Finally, you also configure things through the Django web admin available at `/admin/`.
## YunoHost specific features
#### Multi-users support
* No LDAP support yet (apparently under development)
* Users can also just sign up themselves to manage details
* Users can use mailing lists without signing up
#### 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 ## Limitations
* Migrating from Mailman 2.X is not officially supported, sorry. However, there is a manual and * Migrating from Mailman 2.X is not officially supported, sorry. However, there is a manual and
@ -132,35 +123,24 @@ Finally, you also configure things through the Django web admin available at `/a
* There may be only one installation per YunoHost. * There may be only one installation per YunoHost.
## Mirroring ## Documentation and resources
* https://github.com/YunoHost-Apps/mailman3_ynh * Official app website: http://www.list.org/
* https://hack.decentral1.se/yunohost-packages/mailman3_ynh * Official user documentation: http://docs.mailman3.org/en/latest/userguide.html
* Official admin documentation: https://docs.mailman3.org/en/latest/
* Upstream app code repository: https://gitlab.com/mailman/mailman-suite
* YunoHost documentation for this app: https://yunohost.org/app_mailman3
* Report a bug: https://github.com/YunoHost-Apps/mailman3_ynh/issues
## Links ## Developer info
* Report a bug: https://github.com/YunoHost-Apps/mailman3_ynh/issues Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing).
* 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:
To try the testing branch, please proceed like that.
``` ```
$ yunohost app install https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug
or
sudo yunohost app upgrade mailman3 -u https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug
``` ```
Or to upgrade from the testing branch: **More info regarding app packaging:** https://yunohost.org/packaging_apps
```bash
$ yunohost app upgrade mailman3 -u https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug
```

141
README_fr.md
View file

@ -1,5 +1,142 @@
# Mailman3 pour YunoHost # Mailman3 pour YunoHost
Please help me maintain this with translations! [![Niveau d'intégration](https://dash.yunohost.org/integration/mailman3.svg)](https://dash.yunohost.org/appci/app/mailman3) ![](https://ci-apps.yunohost.org/ci/badges/mailman3.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mailman3.maintain.svg)
[![Installer Mailman3 avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mailman3)
Sorry! *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Mailman3 rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble
Un gestionnaire de liste de discussion par email
**Version incluse :** 1.0~ynh1
**Démo :** https://lists.mailman3.org/mailman3/lists/
## Captures d'écran
![](./doc/screenshots/screenshot1.webp)
## Avertissements / informations importantes
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as:
* No LDAP support yet (apparently under development)
* Users can also just sign up themselves to manage details
* Users can use mailing lists without signing up?
## 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.
### 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 `https://myyunohost.org` then that would be the following:
> https://myyunohost.org/admin/site/site
### Configure incoming mail
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
$ sudo -su list mailman aliases
```
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.
### Configure outgoing mail
Postfix relies on using SMTP which should be configured in your `/etc/postfix/main.cf`.
You should make sure that you have outgoing mail working before getting started with Mailman 3.
## General Configuration
Mailman 3 or "The Mailman Suite" is made up of 5 moving parts. See the following documentation for more:
> http://docs.mailman3.org/en/latest/index.html#the-mailman-suite
On your YunoHost, all the configuration files you need to worry about are in:
* `/etc/mailman3/`
* `/usr/share/mailman3-web/`
The services you need to manage can be checked with:
* `systemctl status mailman3`
* `systemctl status mailman3-web`
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.
Finally, you also configure things through the Django web admin available at `/admin/`.
## Limitations
* 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).
* Mailman3 must be configured to use a root domain (https://myyunohost.org and not https://myyunohost.org/mailman3).
* You must have a HTTPS certificate installed on the root domain.
* There may be only one installation per YunoHost.
## Documentations et ressources
* Site officiel de l'app : http://www.list.org/
* Documentation officielle utilisateur : http://docs.mailman3.org/en/latest/userguide.html
* Documentation officielle de l'admin : https://docs.mailman3.org/en/latest/
* Dépôt de code officiel de l'app : https://gitlab.com/mailman/mailman-suite
* Documentation YunoHost pour cette app : https://yunohost.org/app_mailman3
* Signaler un bug : https://github.com/YunoHost-Apps/mailman3_ynh/issues
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
```
sudo yunohost app install https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug
ou
sudo yunohost app upgrade mailman3 -u https://github.com/YunoHost-Apps/mailman3_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps