mirror of
https://github.com/YunoHost-Apps/mailman3_ynh.git
synced 2024-09-03 19:36:17 +02:00
117 lines
4.1 KiB
Markdown
117 lines
4.1 KiB
Markdown
|
# Mailman3 for YunoHost
|
||
|
|
|
||
|
|
[](https://dash.yunohost.org/appci/app/mailman3)
|
||
|
|
[](https://install-app.yunohost.org/?app=mailman3)
|
||
|
|
|
||
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
||
|
|
|
||
|
|
> *This package allow you to install Mailman3 quickly and simply on a YunoHost server.
|
||
|
|
|
||
|
|
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) 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/
|
||
|
|
|
||
|
|
**Shipped version:** 3.2.1
|
||
|
|
|
||
|
|
## Screenshots
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Demo
|
||
|
|
|
||
|
|
* [Official demo](https://lists.mailman3.org/mailman3/lists/)
|
||
|
|
|
||
|
|
## 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.
|
||
|
|
|
||
|
|
## 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](http://docs.mailman3.org/en/latest/prodsetup.html#distribution-packages) Debian package contained in the Debian Stretch backports repository.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
* [Official documentation](http://docs.mailman3.org/en/latest/index.html)
|
||
|
|
|
||
|
|
## YunoHost specific features
|
||
|
|
|
||
|
|
#### Multi-users support
|
||
|
|
|
||
|
|
* No LDAP support
|
||
|
|
* HTTP Auth is supported
|
||
|
|
* Only one installation per YunoHost
|
||
|
|
|
||
|
|
#### Supported architectures
|
||
|
|
|
||
|
|
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/mailman3/)
|
||
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/mailman3/)
|
||
|
|
|
||
|
|
## Limitations
|
||
|
|
|
||
|
|
* Migrating from Mailman 2.X is not supported. This is a manual and
|
||
|
|
experimental process. Please see [the documentation](https://docs.mailman3.org/en/latest/migration.html).
|
||
|
|
|
||
|
|
* 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
|
||
|
|
|
||
|
|
* 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
|
||
|
|
```
|