2018-02-05 21:53:46 -06:00
# Integrate mlmmj mailing list manager in iRedMail (MySQL/MariaDB backends)
[TOC]
## Summary
2018-02-05 23:27:49 -06:00
In iRedMail-0.9.8, we integrate mlmmj (< http: / / mlmmj . org > ) - a simple and slim
2018-02-05 21:53:46 -06:00
mailing list manager. It uses very few resources, and requires no daemons, easy
to install, configure and manage. if offers a great set of features, including:
* Archive
* Subject prefix
* Subscribers only posting
* Moderators only posting
* Moderation functionality
* Custom headers / footer
* Fully automated bounce handling
* Complete requeueing functionality
* Regular expression access control
* Delivery Status Notification (RFC1891) support
* Rich, customisable texts for automated operations
* and more
2018-02-05 23:27:49 -06:00
With mlmmj integration, you can create as many mailing lists as you want. End
user can subscribe to mailing list `listname@domain.dom` by sending email to
`listname+subscribe@domain.com` , unsubscribe from the list by sending email to
`listname+unsubscribe@domain.com` . Of course you can disable the subscription
and unsubscription with a setting.
2018-02-05 21:53:46 -06:00
iRedMail team also developes a simple RESTful API server called `mlmmjadmin`
to help manage mailing lists, it also offers script tool to manage mailing
lists from command line.
We will show you how to integrate both mlmmj and mlmmjadmin in this tutorial.
## Backup SQL database first
Although we don't modify any existing SQL data in this tutorial, but it's
a good idea to backup it now before you adding any new mailing lists.
Please run command `bash /var/vmail/backup/backup_mysql.sh` to backup SQL
databases.
2018-02-06 01:14:34 -06:00
## Install mlmmj package
2018-02-28 22:28:16 -06:00
!!! attention
Package `uwsgi` is required by the RESTful API server `mlmmjadmin` .
2018-02-06 01:14:34 -06:00
* On RHEL/CentOS, `mlmmj` is available in `EPEL` repo, and it's enabled in
iRedMail by default. So we can install it directly:
```
2018-04-11 04:35:47 -05:00
yum install mlmmj uwsgi uwsgi-plugin-python uwsgi-logger-syslog python-requests
2018-02-06 01:14:34 -06:00
```
* On Debian/Ubuntu:
```
2018-05-01 03:49:31 -05:00
apt-get install mlmmj uwsgi uwsgi-plugin-python python-requests
2018-02-06 01:14:34 -06:00
```
* On FreeBSD:
```
cd /usr/ports/mail/mlmmj
make install clean
2018-02-28 22:28:16 -06:00
cd /usr/ports/www/uwsgi
make install clean
2018-04-11 04:35:47 -05:00
cd /usr/ports/www/py-requests
make install clean
2018-02-06 01:14:34 -06:00
```
* On OpenBSD:
```
pkg_add mlmmj
```
2018-02-05 21:53:46 -06:00
## Create required system account
mlmmj will be ran as user `mlmmj` and group `mlmmj` , all mailing list data will
be stored under its home directory `/var/vmail/mlmmj` :
On Linux or OpenBSD:
```
groupadd mlmmj
2018-02-28 22:28:16 -06:00
useradd -m -g mlmmj -d /var/vmail/mlmmj -s /sbin/nologin mlmmj
2018-04-04 00:47:18 -05:00
mkdir /var/vmail/mlmmj-archive
chown -R mlmmj:mlmmj /var/vmail/mlmmj /var/vmail/mlmmj-archive
chmod -R 0700 /var/vmail/mlmmj /var/vmail/mlmmj-archive
2018-03-08 08:43:14 -06:00
chmod 0755 /var/vmail # Make sure this directory is accessible by other users
2018-02-05 21:53:46 -06:00
```
On FreeBSD:
```
pw groupadd mlmmj
2018-05-01 04:03:55 -05:00
pw useradd mlmmj -m -g mlmmj -s /sbin/nologin -d /var/vmail/mlmmj
2018-04-04 00:47:18 -05:00
mkdir /var/vmail/mlmmj-archive
chown -R mlmmj:mlmmj /var/vmail/mlmmj /var/vmail/mlmmj-archive
chmod -R 0700 /var/vmail/mlmmj /var/vmail/mlmmj-archive
2018-03-08 08:43:14 -06:00
chmod 0755 /var/vmail # Make sure this directory is accessible by other users
2018-02-05 21:53:46 -06:00
```
## Update SQL tables in `vmail` database
We need some updates in `vmail` SQL database:
* new SQL table `maillists` : used to store profile of mailing list.
* new SQL column `forwardings.is_maillist`
* new SQL column `domain.maillists` : used to set per-domain limit of mailing
list accounts. This column is mostly used by iRedAdmin-Pro.
2018-04-06 12:58:04 -05:00
This SQL structure was introduced in iRedMail-0.9.8, if you're running
an old iRedMail release, please upgrade iRedMail to the latest stable release
by following our tutorials first:
2018-02-05 21:53:46 -06:00
2018-04-06 12:58:04 -05:00
* [iRedMail Upgrade Tutorials ](./iredmail.releases.html )
2018-02-05 21:53:46 -06:00
## Postfix integration
* Please add lines below in Postfix config file `/etc/postfix/master.cf` :
!!! attention
* Command `/usr/bin/mlmmj-amime-receive` doesn't exist yet, we will
create it later.
* On FreeBSD and OpenBSD, it should be
`/usr/local/usr/bin/mlmmj-amime-receive` instead.
```
# ${nexthop} is '%d/%u' in transport ('mlmmj:%d/%u')
mlmmj unix - n n - - pipe
flags=ORhu user=mlmmj argv=/usr/bin/mlmmj-amime-receive -L /var/vmail/mlmmj/${nexthop}
```
* Add line below in Postfix config file `/etc/postfix/main.cf` :
```
mlmmj_destination_recipient_limit = 1
```
* Open Postfix config file `/etc/postfix/main.cf` , update existing parameter
`transport_maps` , add new sql lookup like below. We will create required sql
lookup file later.
```
transport_maps =
proxy:mysql:/etc/postfix/mysql/transport_maps_user.cf
proxy:mysql:/etc/postfix/mysql/transport_maps_maillist.cf # < - Add this line
...
```
2018-02-06 00:06:25 -06:00
* Now create file `/etc/postfix/mysql/transport_maps_maillist.cf` :
2018-02-05 21:53:46 -06:00
!!! warning
Please update the `password =` line with the real password of SQL user
`vmail` , you can find it in files under `/etc/postfix/mysql/` .
```
user = vmail
password = qsescZvV03f6YUtTMN2bQTejmjatzz
hosts = 127.0.0.1
port = 3306
dbname = vmail
query = SELECT maillists.transport FROM maillists,domain WHERE maillists.address='%s' AND maillists.active=1 AND maillists.domain = domain.domain AND domain.active=1
```
* Run commands below to create file `/usr/bin/mlmmj-amime-receive` (Linux) or
`/usr/local/bin/mlmmj-amime-receive` (Linux/FreeBSD):
!!! attention
mlmmj doesn't support signature signing very well, so we follow mlmmj
official document and create this script to sign signature properly with
command `altermime` . All iRedMail installation should have command
`altermime` (package `AlterMIME` ) available, so you don't need to install
it manually
On Linux:
```
cd /usr/bin/
wget https://bitbucket.org/zhb/iredmail/raw/default/iRedMail/samples/mlmmj/mlmmj-amime-receive
2018-02-28 22:28:16 -06:00
chown mlmmj:mlmmj mlmmj-amime-receive
2018-02-05 21:53:46 -06:00
chmod 0550 mlmmj-amime-receive
perl -pi -e 's#PH_CMD_MLMMJ_RECEIVE#/usr/bin/mlmmj-receive#g' mlmmj-amime-receive
perl -pi -e 's#PH_CMD_ALTERMIME#/usr/bin/altermime#g' mlmmj-amime-receive
```
On FreeBSD or OpenBSD:
```
cd /usr/local/bin/
wget https://bitbucket.org/zhb/iredmail/raw/default/iRedMail/samples/mlmmj/mlmmj-amime-receive
2018-02-28 22:28:16 -06:00
chown mlmmj:mlmmj mlmmj-amime-receive
2018-02-05 21:53:46 -06:00
chmod 0550 mlmmj-amime-receive
perl -pi -e 's#PH_CMD_MLMMJ_RECEIVE#/usr/local/bin/mlmmj-receive#g' mlmmj-amime-receive
perl -pi -e 's#PH_CMD_ALTERMIME#/usr/local/bin/altermime#g' mlmmj-amime-receive
```
## Amavisd Integration
We need Amavisd to listen on one more port `10027` , it will be used to scan
spam/virus for emails posted to mailing list.
* Please open Amavisd config file, find parameter `$inet_socket_port` , add new
port number `10027` in the list, like below:
- On RHEL/CentOS, it's `/etc/amavisd/amavisd.conf` .
- On Debian/Ubuntu, it's `/etc/amavis/conf.d/50-user` .
- On OpenBSD, it's `/etc/amavisd.conf` .
- On FreeBSD, it's `/usr/local/etc/amavisd.conf` .
```
$inet_socket_port = [10024, 10026, 10027, 9998];
```
* Add lines below in Amavisd config file. It creates a new policy bank called
`MLMMJ` for emails submitted by mlmmj from port 10027. The purpose is signing
DKIM key on outgoing emails sent by mailing list, but disable
spam/virus/banned/bad-header checks, because emails sent to mailing list will
be scanned either on port 10024 (incoming email from external senders) or
10026 (outgoing email sent by smtp authenticated users).
```
$interface_policy{'10027'} = 'MLMMJ';
$policy_bank{'MLMMJ'} = {
originating => 1, # declare that mail was submitted by our smtp client
allow_disclaimers => 0, # mailing list should use footer text instead.
enable_dkim_signing => 1, # sign DKIm signature
smtpd_discard_ehlo_keywords => ['8BITMIME'],
terminate_dsn_on_notify_success => 0, # don't remove NOTIFY=SUCCESS option
bypass_spam_checks_maps => [1], # don't check spam
bypass_virus_checks_maps => [1], # don't check virus
bypass_banned_checks_maps => [1], # don't check banned file names and types
bypass_header_checks_maps => [1], # don't check bad header
};
```
2018-02-28 22:28:16 -06:00
Now restart Amavisd and Postfix service, mlmmj mailing list manager is now
2018-02-05 21:53:46 -06:00
fully integrated.
We will setup `mlmmjadmin` program to make managing mailing lists easier.
## Setup mlmmjadmin: RESTful API server used to manage mlmmj mailing lists
* Download the latest mlmmjadmin release: < https: // github . com / iredmail / mlmmjadmin / releases > ,
2018-04-11 02:53:20 -05:00
extract downloaded package to `/opt/` directory, and create a symbol link:
2018-02-05 21:53:46 -06:00
!!! attention
2018-05-26 02:10:26 -05:00
We use version `1.4` for example below.
2018-02-05 21:53:46 -06:00
```
2018-04-11 02:53:20 -05:00
cd /root/
2018-05-26 02:10:26 -05:00
wget https://github.com/iredmail/mlmmjadmin/archive/1.4.tar.gz
tar zxf 1.4.tar.gz -C /opt
rm -f 1.4.tar.gz
ln -s /opt/mlmmjadmin-1.4 /opt/mlmmjadmin
2018-02-05 21:53:46 -06:00
```
* Generate config file by copying sample file, `settings.py.sample` :
```
cd /opt/mlmmjadmin
cp settings.py.sample settings.py
chown mlmmj:mlmmj settings.py
chmod 0400 settings.py
```
* Generate a random, long string as API auth token, it will be used by your
API client. For example:
```
$ echo $RANDOM | md5sum
43a89b7aa34354089e629ed9f9be0b3b
```
* Add this string in `/opt/mlmmjadmin/settings.py` , parameter `api_auth_tokens`
like below:
```
api_auth_tokens = ['43a89b7aa34354089e629ed9f9be0b3b']
```
You can add as many token as you want for different API clients. For example:
```
api_auth_tokens = ['43a89b7aa34354089e629ed9f9be0b3b', '703ed37b20243d7c51c56ce6cd90e94c']
```
* if you manage mail accounts __WITH__ iRedAdmin-Pro, please set values of
parameters `backend_api` and `backend_cli` in `/opt/mlmmjadmin/settings.py`
like below:
```
backend_api = 'bk_none'
backend_cli = 'bk_iredmail_sql'
```
* if you do __NOT__ manage mail accounts with iRedAdmin-Pro, please set values
of parameters `backend_api` and `backend_cli` in `/opt/mlmmjadmin/settings.py`
like below:
```
backend_api = 'bk_iredmail_sql'
backend_cli = 'bk_iredmail_sql'
```
* Add extra required parameters in `/opt/mlmmjadmin/settings.py` , so that
mlmmjadmin can connect to SQL server and manage mailing lists.
!!! attention
You can find SQL server address, port, database name, SQL username and
password in iRedAdmin config file, the SQL user must have both read and
write privileges to manage `vmail` database. iRedMail server usually
use SQL user `vmailadmin` for this purpose.
```
iredmail_sql_db_type = 'mysql'
iredmail_sql_db_server = '127.0.0.1'
iredmail_sql_db_port = 3306
iredmail_sql_db_name = 'vmail'
iredmail_sql_db_user = 'vmailadmin'
iredmail_sql_db_password = '< password > '
```
2018-02-10 10:43:51 -06:00
* Add extra required parameters in `/opt/mlmmjadmin/settings.py` to use the
directory used to store mailing lists:
```
MLMMJ_SPOOL_DIR = '/var/vmail/mlmmj'
2018-03-05 18:17:44 -06:00
MLMMJ_ARCHIVE_DIR = '/var/vmail/mlmmj-archive'
2018-02-10 10:43:51 -06:00
MLMMJ_DEFAULT_PROFILE_SETTINGS.update({'smtp_port': 10027})
```
* If you're running OpenBSD or FreeBSD, please add parameter `MLMMJ_SKEL_DIR`
in `/opt/mlmmjadmin/settings.py` to set the directory which stores mlmmj mail
templates:
```
MLMMJ_SKEL_DIR = '/usr/local/share/mlmmj/text.skel'
```
2018-02-05 21:53:46 -06:00
* Copy rc/systemd scripts for service control:
```
#
2018-02-06 01:14:34 -06:00
# For RHEL/CentOS 6
#
cp /opt/mlmmjadmin/rc_scripts/mlmmjadmin.rhel /etc/init.d/mlmmjadmin
2018-04-15 07:22:08 -05:00
chmod 0755 /etc/init.d/mlmmjadmin
2018-02-28 22:28:16 -06:00
chkconfig --level 345 mlmmjadmin on
2018-02-06 01:14:34 -06:00
#
# For RHEL/CentOS 7
2018-02-05 21:53:46 -06:00
#
cp /opt/mlmmjadmin/rc_scripts/systemd/rhel.service /lib/systemd/system/mlmmjadmin.service
chmod 0644 /lib/systemd/system/mlmmjadmin.service
systemctl daemon-reload
systemctl enable mlmmjadmin
2018-02-06 01:14:34 -06:00
#
# For Debian 8, Ubuntu 14.04 and earlier releases which does NOT use systemd
#
cp /opt/mlmmjadmin/rc_scripts/mlmmjadmin.debian /etc/init.d/mlmmjadmin
2018-05-11 09:03:26 -05:00
chmod 0755 /etc/init.d/mlmmjadmin
2018-02-06 01:14:34 -06:00
update-rc.d mlmmjadmin defaults
2018-02-05 21:53:46 -06:00
#
# For Debian 9 and Ubuntu 16.04 which uses systemd
#
cp /opt/mlmmjadmin/rc_scripts/systemd/debian.service /lib/systemd/system/mlmmjadmin.service
chmod 0644 /lib/systemd/system/mlmmjadmin.service
systemctl daemon-reload
systemctl enable mlmmjadmin
#
# For FreeBSD
#
cp /opt/mlmmjadmin/rc_scripts/mlmmjadmin.freebsd /usr/local/etc/rc.d/mlmmjadmin
chmod 0755 /usr/local/etc/rc.d/mlmmjadmin
echo 'mlmmjadmin_enable=YES' >> /etc/rc.conf.local
#
# For OpenBSD
#
cp /opt/mlmmjadmin/rc_scripts/mlmmjadmin.openbsd /etc/rc.d/mlmmjadmin
chmod 0755 /etc/rc.d/mlmmjadmin
rcctl enable mlmmjadmin
```
* Create directory used to store mlmmjadmin log file. mlmmjadmin is
configured to log to syslog directly.
```
#
# For RHEL/CentOS
#
mkdir /var/log/mlmmjadmin
chown root:root /var/log/mlmmjadmin
chmod 0755 /var/log/mlmmjadmin
#
2018-04-06 13:06:20 -05:00
# For Debian
#
mkdir /var/log/mlmmjadmin
chown root:adm /var/log/mlmmjadmin
chmod 0755 /var/log/mlmmjadmin
#
# For Ubuntu
2018-02-05 21:53:46 -06:00
#
mkdir /var/log/mlmmjadmin
chown syslog:adm /var/log/mlmmjadmin
chmod 0755 /var/log/mlmmjadmin
#
# For OpenBSD/FreeBSD
#
mkdir /var/log/mlmmjadmin
chown root:wheel /var/log/mlmmjadmin
chmod 0755 /var/log/mlmmjadmin
```
* Update syslog daemon config file to log mlmmjadmin to dedicated log file:
For Linux
```
cp /opt/mlmmjadmin/samples/rsyslog/mlmmjadmin.conf /etc/rsyslog.d/
service rsyslog restart
```
For OpenBSD, please append below lines in `/etc/syslog.conf` :
```
!!mlmmjadmin
local5.* /var/log/mlmmjadmin/mlmmjadmin.log
```
For FreeBSD, please append below lines in `/etc/syslog.conf` :
```
!mlmmjadmin
local5.* /var/log/mlmmjadmin/mlmmjadmin.log
```
2018-04-04 00:47:18 -05:00
* Now it's ok to start `mlmmjadmin` service, it listens on `127.0.0.1:7790`
by default:
2018-02-05 21:53:46 -06:00
```
#
# On Linux/FreeBSD:
#
service mlmmjadmin restart
#
# On OpenBSD
#
rcctl start mlmmjadmin
```
2018-04-04 00:47:18 -05:00
On Linux, you can check the port number with command:
```
netstat -ntlp | grep 7790
```
On FreeBSD/OpenBSD, run:
```
netdata -anl -p tcp | grep 7790
```
2018-02-05 23:27:49 -06:00
## Manage mailing lists with iRedAdmin-Pro
With [iRedAdmin-Pro ](https://www.iredmail.org/admin_panel.html ), you can easily
manage mailing list accounts with its web UI. Here's a screenshot of mailing
list profile page in iRedAdmin-Pro:
![](./images/iredadmin/mailinglist_profile.png){: width="900px" }
2018-02-05 22:57:34 -06:00
## Manage mailing lists with mlmmjadmin command line tool
mlmmjadmin ships script `tools/maillist_admin.py` to help you manage mailing
lists. You can find this script under directory `/opt/mlmmjadmin/tools/` .
!!! attention
All settings used to create or update mailing list profiles are listed on
[mlmmjadmin document ](https://github.com/iredmail/mlmmjadmin/blob/master/docs/API.md ).
* Create a new mailing list account with additional setting:
```python maillist_admin.py create list@domain.com only_subscriber_can_post=yes disable_archive=no```
* Get settings of an existing mailing list account
```python maillist_admin.py info list@domain.com```
* Update an existing mailing list account
```python maillist_admin.py update list@domain.com only_moderator_can_post=yes disable_subscription=yes```
* Delete an existing mailing list account
```python maillist_admin.py delete list@domain.com archive=yes```
* List all subscribers:
```python maillist_admin.py subscribers list@domain.com```
* Show subscribed lists of a given subscriber:
```python maillist_admin.py subscribed subscriber@domain.com```
* Check whether mailing list has given subscriber:
```python maillist_admin.py has_subscriber list@domain.com subscriber@gmail.com```
2018-02-05 21:53:46 -06:00
## References
* iRedMail: < http: // www . iredmail . org >
* Mlmmj: < http: // mlmmj . org />
* Tunable parameters: < http: // mlmmj . org / docs / tunables />
* Postfix integration: < http: // mlmmj . org / docs / readme-postfix />
* mlmmjadmin: RESTful API server used to manage mlmmj mailing lists. Developed
and maintained by iRedMail team. < https: / / github . com / iredmail / mlmmjadmin >