elmau
/
iredmail-doc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update mlmmj integration tutorials.

This commit is contained in:
Zhang Huangbin 2020-09-24 10:35:08 +08:00
parent c9587456e1
commit 4d3cbfd7e6
6 changed files with 170 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
en_US/integrations/0-integration.mlmmj.ldap.md
View File

@ -41,23 +41,33 @@ a good idea to backup it now before you adding any new mailing lists.
* For OpenLDAP, please run command `bash /var/vmail/backup/backup_openldap.sh` to backup.
* For OpenBSD ldapd, please run command `bash /var/vmail/backup/backup_ldapd.sh` to backup.
## Install mlmmj package
## Install mlmmj and other required package
!!! attention
Package `uwsgi` is required by the RESTful API server `mlmmjadmin`.
- `uwsgi` and other Python modules are required by the RESTful API server `mlmmjadmin`.
- `mlmmjadmin-3.x` and later releases work with only Python 3.
* On RHEL/CentOS, `mlmmj` is available in `EPEL` repo, and it's enabled in
iRedMail by default. So we can install it directly:
```
yum install mlmmj uwsgi uwsgi-plugin-python2 uwsgi-logger-syslog python-requests
# RHEL/CentOS 7
yum install mlmmj uwsgi uwsgi-plugin-python36 uwsgi-logger-syslog python3-requests python3-ldap
# RHEL/CentOS 8
yum install mlmmj python3-pip3 python3-requests python3-ldap
pip3 install uwsgi
```
* On Debian/Ubuntu:
```
apt-get install mlmmj uwsgi uwsgi-plugin-python python-requests
# Debian 9
apt-get install mlmmj uwsgi uwsgi-plugin-python3 python3-requests python3-pyldap
# Other Debian/Ubuntu releases
apt-get install mlmmj uwsgi uwsgi-plugin-python3 python3-requests python3-ldap
```
* On FreeBSD:
@ -75,7 +85,7 @@ make install clean
to install it here):
```
pkg_add mlmmj altermime
pkg_add mlmmj altermime py3-ldap
```
## Create required system account
@ -230,14 +240,17 @@ We will setup `mlmmjadmin` program to make managing mailing lists easier.
!!! attention
We use version `2.1` for example below.
We use version `3.0.4` for example below.
- `mlmmjadmin-3.x` and later releases requires Python 3.
- `mlmmjadmin-2.x` and older releases requires Python 2.
```
cd /root/
wget https://github.com/iredmail/mlmmjadmin/archive/2.1.tar.gz
tar zxf 2.1.tar.gz -C /opt
rm -f 2.1.tar.gz
ln -s /opt/mlmmjadmin-2.1 /opt/mlmmjadmin
wget https://github.com/iredmail/mlmmjadmin/archive/3.0.4.tar.gz
tar zxf 3.0.4.tar.gz -C /opt
rm -f 3.0.4.tar.gz
ln -s /opt/mlmmjadmin-3.0.4 /opt/mlmmjadmin
```
* Generate config file by copying sample file, `settings.py.sample`:
@ -253,7 +266,12 @@ chmod 0400 settings.py
API client. For example:
```
$ echo $RANDOM | md5sum
# On Linux/FreBSD
$ eval </dev/urandom tr -dc A-Za-z0-9 | (head -c $1 &>/dev/null || head -c 32)
43a89b7aa34354089e629ed9f9be0b3b
# On OpenBSD
$ eval </dev/random tr -cd [:alnum:] | fold -w 32 | head -1
43a89b7aa34354089e629ed9f9be0b3b
```

36
en_US/integrations/0-integration.mlmmj.mysql.md
View File

@ -41,23 +41,29 @@ 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.
## Install mlmmj package
## Install mlmmj and other required package
!!! attention
Package `uwsgi` is required by the RESTful API server `mlmmjadmin`.
- `uwsgi` and other Python modules are required by the RESTful API server `mlmmjadmin`.
- `mlmmjadmin-3.x` and later releases work with only Python 3.
* On RHEL/CentOS, `mlmmj` is available in `EPEL` repo, and it's enabled in
iRedMail by default. So we can install it directly:
```
yum install mlmmj uwsgi uwsgi-plugin-python2 uwsgi-logger-syslog python-requests
# RHEL/CentOS 7
yum install mlmmj uwsgi uwsgi-plugin-python36 uwsgi-logger-syslog python3-requests python3-PyMySQL
# RHEL/CentOS 8
yum install mlmmj python3-pip3 python3-requests python3-PyMySQL
pip3 install uwsgi
```
* On Debian/Ubuntu:
```
apt-get install mlmmj uwsgi uwsgi-plugin-python python-requests
apt-get install mlmmj uwsgi uwsgi-plugin-python3 python3-requests
```
* On FreeBSD:
@ -74,7 +80,7 @@ make install clean
* On OpenBSD:
```
pkg_add mlmmj altermime
pkg_add mlmmj altermime py3-requests
```
## Create required system account
@ -249,14 +255,17 @@ We will setup `mlmmjadmin` program to make managing mailing lists easier.
!!! attention
We use version `2.1` for example below.
We use version `3.0.4` for example below.
- `mlmmjadmin-3.x` and later releases requires Python 3.
- `mlmmjadmin-2.x` and older releases requires Python 2.
```
cd /root/
wget https://github.com/iredmail/mlmmjadmin/archive/2.1.tar.gz
tar zxf 2.1.tar.gz -C /opt
rm -f 2.1.tar.gz
ln -s /opt/mlmmjadmin-2.1 /opt/mlmmjadmin
wget https://github.com/iredmail/mlmmjadmin/archive/3.0.4.tar.gz
tar zxf 3.0.4.tar.gz -C /opt
rm -f 3.0.4.tar.gz
ln -s /opt/mlmmjadmin-3.0.4 /opt/mlmmjadmin
```
* Generate config file by copying sample file, `settings.py.sample`:
@ -272,7 +281,12 @@ chmod 0400 settings.py
API client. For example:
```
$ echo $RANDOM | md5sum
# On Linux/FreBSD
$ eval </dev/urandom tr -dc A-Za-z0-9 | (head -c $1 &>/dev/null || head -c 32)
43a89b7aa34354089e629ed9f9be0b3b
# On OpenBSD
$ eval </dev/random tr -cd [:alnum:] | fold -w 32 | head -1
43a89b7aa34354089e629ed9f9be0b3b
```

36
en_US/integrations/0-integration.mlmmj.pgsql.md
View File

@ -41,23 +41,29 @@ a good idea to backup it now before you adding any new mailing lists.
Please run command `bash /var/vmail/backup/backup_pgsql.sh` to backup SQL
databases.
## Install mlmmj package
## Install mlmmj and other required package
!!! attention
Package `uwsgi` is required by the RESTful API server `mlmmjadmin`.
- `uwsgi` and other Python modules are required by the RESTful API server `mlmmjadmin`.
- `mlmmjadmin-3.x` and later releases work with only Python 3.
* On RHEL/CentOS, `mlmmj` is available in `EPEL` repo, and it's enabled in
iRedMail by default. So we can install it directly:
```
yum install mlmmj uwsgi uwsgi-plugin-python2 uwsgi-logger-syslog python-requests
# RHEL/CentOS 7
yum install mlmmj uwsgi uwsgi-plugin-python36 uwsgi-logger-syslog python3-requests python3-psycopg2
# RHEL/CentOS 8
yum install mlmmj python3-pip3 python3-requests python3-PyMySQL
pip3 install uwsgi
```
* On Debian/Ubuntu:
```
apt-get install mlmmj uwsgi uwsgi-plugin-python python-requests
apt-get install mlmmj uwsgi uwsgi-plugin-python3 python3-requests
```
* On FreeBSD:
@ -75,7 +81,7 @@ make install clean
to install it here):
```
pkg_add mlmmj altermime
pkg_add mlmmj altermime py3-requests
```
## Create required system account
@ -250,14 +256,17 @@ We will setup `mlmmjadmin` program to make managing mailing lists easier.
!!! attention
We use version `2.1` for example below.
We use version `3.0.4` for example below.
- `mlmmjadmin-3.x` and later releases requires Python 3.
- `mlmmjadmin-2.x` and older releases requires Python 2.
```
cd /root/
wget https://github.com/iredmail/mlmmjadmin/archive/2.1.tar.gz
tar zxf 2.1.tar.gz -C /opt
rm -f 2.1.tar.gz
ln -s /opt/mlmmjadmin-2.1 /opt/mlmmjadmin
wget https://github.com/iredmail/mlmmjadmin/archive/3.0.4.tar.gz
tar zxf 3.0.4.tar.gz -C /opt
rm -f 3.0.4.tar.gz
ln -s /opt/mlmmjadmin-3.0.4 /opt/mlmmjadmin
```
* Generate config file by copying sample file, `settings.py.sample`:
@ -273,7 +282,12 @@ chmod 0400 settings.py
API client. For example:
```
$ echo $RANDOM | md5sum
# On Linux/FreBSD
$ eval </dev/urandom tr -dc A-Za-z0-9 | (head -c $1 &>/dev/null || head -c 32)
43a89b7aa34354089e629ed9f9be0b3b
# On OpenBSD
$ eval </dev/random tr -cd [:alnum:] | fold -w 32 | head -1
43a89b7aa34354089e629ed9f9be0b3b
```

45
html/integration.mlmmj.ldap.html
View File

@ -21,7 +21,7 @@
<li><a href="#integrate-mlmmj-mailing-list-manager-in-iredmail-ldap-backends">Integrate mlmmj mailing list manager in iRedMail (LDAP backends)</a><ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#backup-ldap-data-first">Backup LDAP data first</a></li>
<li><a href="#install-mlmmj-package">Install mlmmj package</a></li>
<li><a href="#install-mlmmj-and-other-required-package">Install mlmmj and other required package</a></li>
<li><a href="#create-required-system-account">Create required system account</a></li>
<li><a href="#postfix-integration">Postfix integration</a></li>
<li><a href="#amavisd-integration">Amavisd Integration</a></li>
@ -67,22 +67,34 @@ a good idea to backup it now before you adding any new mailing lists.</p>
<li>For OpenLDAP, please run command <code>bash /var/vmail/backup/backup_openldap.sh</code> to backup.</li>
<li>For OpenBSD ldapd, please run command <code>bash /var/vmail/backup/backup_ldapd.sh</code> to backup.</li>
</ul>
<h2 id="install-mlmmj-package">Install mlmmj package</h2>
<h2 id="install-mlmmj-and-other-required-package">Install mlmmj and other required package</h2>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>Package <code>uwsgi</code> is required by the RESTful API server <code>mlmmjadmin</code>.</p>
<ul>
<li><code>uwsgi</code> and other Python modules are required by the RESTful API server <code>mlmmjadmin</code>.</li>
<li><code>mlmmjadmin-3.x</code> and later releases work with only Python 3.</li>
</ul>
</div>
<ul>
<li>On RHEL/CentOS, <code>mlmmj</code> is available in <code>EPEL</code> repo, and it's enabled in
iRedMail by default. So we can install it directly:</li>
</ul>
<pre><code>yum install mlmmj uwsgi uwsgi-plugin-python2 uwsgi-logger-syslog python-requests
<pre><code># RHEL/CentOS 7
yum install mlmmj uwsgi uwsgi-plugin-python36 uwsgi-logger-syslog python3-requests python3-ldap
# RHEL/CentOS 8
yum install mlmmj python3-pip3 python3-requests python3-ldap
pip3 install uwsgi
</code></pre>
<ul>
<li>On Debian/Ubuntu:</li>
</ul>
<pre><code>apt-get install mlmmj uwsgi uwsgi-plugin-python python-requests
<pre><code># Debian 9
apt-get install mlmmj uwsgi uwsgi-plugin-python3 python3-requests python3-pyldap
# Other Debian/Ubuntu releases
apt-get install mlmmj uwsgi uwsgi-plugin-python3 python3-requests python3-ldap
</code></pre>
<ul>
@ -100,7 +112,7 @@ make install clean
<li>On OpenBSD (iRedMail always installs <code>uwsgi</code> during installation, so no need
to install it here):</li>
</ul>
<pre><code>pkg_add mlmmj altermime
<pre><code>pkg_add mlmmj altermime py3-ldap
</code></pre>
<h2 id="create-required-system-account">Create required system account</h2>
@ -245,15 +257,19 @@ fully integrated.</p>
extract downloaded package to <code>/opt/</code> directory, and create a symbol link:</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>We use version <code>2.1</code> for example below.</p>
<p>We use version <code>3.0.4</code> for example below.</p>
<ul>
<li><code>mlmmjadmin-3.x</code> and later releases requires Python 3.</li>
<li><code>mlmmjadmin-2.x</code> and older releases requires Python 2.</li>
</ul>
</div>
</li>
</ul>
<pre><code>cd /root/
wget https://github.com/iredmail/mlmmjadmin/archive/2.1.tar.gz
tar zxf 2.1.tar.gz -C /opt
rm -f 2.1.tar.gz
ln -s /opt/mlmmjadmin-2.1 /opt/mlmmjadmin
wget https://github.com/iredmail/mlmmjadmin/archive/3.0.4.tar.gz
tar zxf 3.0.4.tar.gz -C /opt
rm -f 3.0.4.tar.gz
ln -s /opt/mlmmjadmin-3.0.4 /opt/mlmmjadmin
</code></pre>
<ul>
@ -269,7 +285,12 @@ chmod 0400 settings.py
<li>Generate a random, long string as API auth token, it will be used by your
API client. For example:</li>
</ul>
<pre><code>$ echo $RANDOM | md5sum
<pre><code># On Linux/FreBSD
$ eval &lt;/dev/urandom tr -dc A-Za-z0-9 | (head -c $1 &amp;&gt;/dev/null || head -c 32)
43a89b7aa34354089e629ed9f9be0b3b
# On OpenBSD
$ eval &lt;/dev/random tr -cd [:alnum:] | fold -w 32 | head -1
43a89b7aa34354089e629ed9f9be0b3b
</code></pre>

41
html/integration.mlmmj.mysql.html
View File

@ -21,7 +21,7 @@
<li><a href="#integrate-mlmmj-mailing-list-manager-in-iredmail-mysqlmariadb-backends">Integrate mlmmj mailing list manager in iRedMail (MySQL/MariaDB backends)</a><ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#backup-sql-database-first">Backup SQL database first</a></li>
<li><a href="#install-mlmmj-package">Install mlmmj package</a></li>
<li><a href="#install-mlmmj-and-other-required-package">Install mlmmj and other required package</a></li>
<li><a href="#create-required-system-account">Create required system account</a></li>
<li><a href="#update-sql-tables-in-vmail-database">Update SQL tables in vmail database</a></li>
<li><a href="#postfix-integration">Postfix integration</a></li>
@ -66,22 +66,30 @@ lists from command line.</p>
a good idea to backup it now before you adding any new mailing lists.</p>
<p>Please run command <code>bash /var/vmail/backup/backup_mysql.sh</code> to backup SQL
databases.</p>
<h2 id="install-mlmmj-package">Install mlmmj package</h2>
<h2 id="install-mlmmj-and-other-required-package">Install mlmmj and other required package</h2>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>Package <code>uwsgi</code> is required by the RESTful API server <code>mlmmjadmin</code>.</p>
<ul>
<li><code>uwsgi</code> and other Python modules are required by the RESTful API server <code>mlmmjadmin</code>.</li>
<li><code>mlmmjadmin-3.x</code> and later releases work with only Python 3.</li>
</ul>
</div>
<ul>
<li>On RHEL/CentOS, <code>mlmmj</code> is available in <code>EPEL</code> repo, and it's enabled in
iRedMail by default. So we can install it directly:</li>
</ul>
<pre><code>yum install mlmmj uwsgi uwsgi-plugin-python2 uwsgi-logger-syslog python-requests
<pre><code># RHEL/CentOS 7
yum install mlmmj uwsgi uwsgi-plugin-python36 uwsgi-logger-syslog python3-requests python3-PyMySQL
# RHEL/CentOS 8
yum install mlmmj python3-pip3 python3-requests python3-PyMySQL
pip3 install uwsgi
</code></pre>
<ul>
<li>On Debian/Ubuntu:</li>
</ul>
<pre><code>apt-get install mlmmj uwsgi uwsgi-plugin-python python-requests
<pre><code>apt-get install mlmmj uwsgi uwsgi-plugin-python3 python3-requests
</code></pre>
<ul>
@ -98,7 +106,7 @@ make install clean
<ul>
<li>On OpenBSD:</li>
</ul>
<pre><code>pkg_add mlmmj altermime
<pre><code>pkg_add mlmmj altermime py3-requests
</code></pre>
<h2 id="create-required-system-account">Create required system account</h2>
@ -264,15 +272,19 @@ fully integrated.</p>
extract downloaded package to <code>/opt/</code> directory, and create a symbol link:</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>We use version <code>2.1</code> for example below.</p>
<p>We use version <code>3.0.4</code> for example below.</p>
<ul>
<li><code>mlmmjadmin-3.x</code> and later releases requires Python 3.</li>
<li><code>mlmmjadmin-2.x</code> and older releases requires Python 2.</li>
</ul>
</div>
</li>
</ul>
<pre><code>cd /root/
wget https://github.com/iredmail/mlmmjadmin/archive/2.1.tar.gz
tar zxf 2.1.tar.gz -C /opt
rm -f 2.1.tar.gz
ln -s /opt/mlmmjadmin-2.1 /opt/mlmmjadmin
wget https://github.com/iredmail/mlmmjadmin/archive/3.0.4.tar.gz
tar zxf 3.0.4.tar.gz -C /opt
rm -f 3.0.4.tar.gz
ln -s /opt/mlmmjadmin-3.0.4 /opt/mlmmjadmin
</code></pre>
<ul>
@ -288,7 +300,12 @@ chmod 0400 settings.py
<li>Generate a random, long string as API auth token, it will be used by your
API client. For example:</li>
</ul>
<pre><code>$ echo $RANDOM | md5sum
<pre><code># On Linux/FreBSD
$ eval &lt;/dev/urandom tr -dc A-Za-z0-9 | (head -c $1 &amp;&gt;/dev/null || head -c 32)
43a89b7aa34354089e629ed9f9be0b3b
# On OpenBSD
$ eval &lt;/dev/random tr -cd [:alnum:] | fold -w 32 | head -1
43a89b7aa34354089e629ed9f9be0b3b
</code></pre>

41
html/integration.mlmmj.pgsql.html
View File

@ -21,7 +21,7 @@
<li><a href="#integrate-mlmmj-mailing-list-manager-in-iredmail-postgresql-backend">Integrate mlmmj mailing list manager in iRedMail (PostgreSQL backend)</a><ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#backup-sql-database-first">Backup SQL database first</a></li>
<li><a href="#install-mlmmj-package">Install mlmmj package</a></li>
<li><a href="#install-mlmmj-and-other-required-package">Install mlmmj and other required package</a></li>
<li><a href="#create-required-system-account">Create required system account</a></li>
<li><a href="#update-sql-tables-in-vmail-database">Update SQL tables in vmail database</a></li>
<li><a href="#postfix-integration">Postfix integration</a></li>
@ -66,22 +66,30 @@ lists from command line.</p>
a good idea to backup it now before you adding any new mailing lists.</p>
<p>Please run command <code>bash /var/vmail/backup/backup_pgsql.sh</code> to backup SQL
databases.</p>
<h2 id="install-mlmmj-package">Install mlmmj package</h2>
<h2 id="install-mlmmj-and-other-required-package">Install mlmmj and other required package</h2>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>Package <code>uwsgi</code> is required by the RESTful API server <code>mlmmjadmin</code>.</p>
<ul>
<li><code>uwsgi</code> and other Python modules are required by the RESTful API server <code>mlmmjadmin</code>.</li>
<li><code>mlmmjadmin-3.x</code> and later releases work with only Python 3.</li>
</ul>
</div>
<ul>
<li>On RHEL/CentOS, <code>mlmmj</code> is available in <code>EPEL</code> repo, and it's enabled in
iRedMail by default. So we can install it directly:</li>
</ul>
<pre><code>yum install mlmmj uwsgi uwsgi-plugin-python2 uwsgi-logger-syslog python-requests
<pre><code># RHEL/CentOS 7
yum install mlmmj uwsgi uwsgi-plugin-python36 uwsgi-logger-syslog python3-requests python3-psycopg2
# RHEL/CentOS 8
yum install mlmmj python3-pip3 python3-requests python3-PyMySQL
pip3 install uwsgi
</code></pre>
<ul>
<li>On Debian/Ubuntu:</li>
</ul>
<pre><code>apt-get install mlmmj uwsgi uwsgi-plugin-python python-requests
<pre><code>apt-get install mlmmj uwsgi uwsgi-plugin-python3 python3-requests
</code></pre>
<ul>
@ -99,7 +107,7 @@ make install clean
<li>On OpenBSD (iRedMail always installs <code>uwsgi</code> during installation, so no need
to install it here):</li>
</ul>
<pre><code>pkg_add mlmmj altermime
<pre><code>pkg_add mlmmj altermime py3-requests
</code></pre>
<h2 id="create-required-system-account">Create required system account</h2>
@ -265,15 +273,19 @@ fully integrated.</p>
extract downloaded package to <code>/opt/</code> directory, and create a symbol link:</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>We use version <code>2.1</code> for example below.</p>
<p>We use version <code>3.0.4</code> for example below.</p>
<ul>
<li><code>mlmmjadmin-3.x</code> and later releases requires Python 3.</li>
<li><code>mlmmjadmin-2.x</code> and older releases requires Python 2.</li>
</ul>
</div>
</li>
</ul>
<pre><code>cd /root/
wget https://github.com/iredmail/mlmmjadmin/archive/2.1.tar.gz
tar zxf 2.1.tar.gz -C /opt
rm -f 2.1.tar.gz
ln -s /opt/mlmmjadmin-2.1 /opt/mlmmjadmin
wget https://github.com/iredmail/mlmmjadmin/archive/3.0.4.tar.gz
tar zxf 3.0.4.tar.gz -C /opt
rm -f 3.0.4.tar.gz
ln -s /opt/mlmmjadmin-3.0.4 /opt/mlmmjadmin
</code></pre>
<ul>
@ -289,7 +301,12 @@ chmod 0400 settings.py
<li>Generate a random, long string as API auth token, it will be used by your
API client. For example:</li>
</ul>
<pre><code>$ echo $RANDOM | md5sum
<pre><code># On Linux/FreBSD
$ eval &lt;/dev/urandom tr -dc A-Za-z0-9 | (head -c $1 &amp;&gt;/dev/null || head -c 32)
43a89b7aa34354089e629ed9f9be0b3b
# On OpenBSD
$ eval &lt;/dev/random tr -cd [:alnum:] | fold -w 32 | head -1
43a89b7aa34354089e629ed9f9be0b3b
</code></pre>