New: en_US/migrations/0-cluebringer.to.iredapd.md -> html/cluebringer.to.iredapd.html.

Fix incorrect file names in other documents.
This commit is contained in:
Zhang Huangbin 2015-12-04 10:13:59 +08:00
parent 9394bd17a4
commit dbc8e08b74
8 changed files with 295 additions and 16 deletions

View File

@ -159,7 +159,7 @@ Init script:
* RHEL/CentOS: `/etc/init.d/cbpolicyd`
* Debian/Ubuntu: `/etc/init.d/postfix-cluebringer`
* FreeBSD: `/usr/local/etc/rc.d/cluebringer`
* FreeBSD: `/usr/local/etc/rc.d/policyd2`
* OpenBSD: N/A. we don't have Cluebringer installed on OpenBSD.
## Fail2ban

View File

@ -100,13 +100,13 @@ installer with below command instead of the original one (`bash iRedMail.sh`):
> WARNING:
>
> * The variable names (`MYSQL_SERVER`, `MYSQL_ROOT_USER`, `MYSQL_GRANT_HOST`)
> are __CASE SENSITIVE__.
> * With iRedMail-0.9.3 and later releases, it's `MYSQL_SERVER_ADDRESS`, not
> `MYSQL_SERVER`.
> * The variable names (`MYSQL_SERVER_ADDRESS`, `MYSQL_SERVER_PORT`,
> `MYSQL_ROOT_USER`, `MYSQL_GRANT_HOST`) are __CASE SENSITIVE__.
> * With `iRedMail-0.9.2` and earlier releases, it's `MYSQL_SERVER`, not
> `MYSQL_SERVER_ADDRESS`.
```
# MYSQL_SERVER='192.168.1.100' MYSQL_ROOT_USER='admin_iredmail' MYSQL_GRANT_HOST='192.168.1.200' bash iRedMail.sh
# MYSQL_SERVER_ADDRESS='192.168.1.100' MYSQL_SERVER_PORT='3306' MYSQL_ROOT_USER='admin_iredmail' MYSQL_GRANT_HOST='192.168.1.200' bash iRedMail.sh
```
It will launch iRedMail installation wizard as usual. When it asks MySQL root
@ -115,7 +115,8 @@ on remote MySQL server.
Parameters we used in above command line:
* `MYSQL_SERVER`: Remote MySQL server address.
* `MYSQL_SERVER_ADDRESS`: Remote MySQL server address.
* `MYSQL_SERVER_PORT`: Remote MySQL server port. Default is `3306`.
* `MYSQL_ROOT_USER`: MySQL user name we created on remote MySQL server before installing iRedMail.
* `MYSQL_GRANT_HOST`: Hostname or IP address of iRedMail server.

View File

@ -0,0 +1,125 @@
# Migrate from Cluebringer to iRedAPD
[TOC]
## Summary
iRedMail-0.9.3 and later releases drop Cluebringer, and replace it by iRedAPD,
because:
* Cluebringer is not under active development anymore.
* No new Cluebringer release since 2013 (the latest stable release doesn't
support IPv6).
* Cluebringer is not available in Debian (jessie) official repositories
anymore, developers didn't bring it back.
Not all Cluebringer features are implemented in iRedAPD, but the most important
2 features have been implemented:
* throttling
* greylisting
If you need other Cluebringer features, please stay with Cluebringer and let
us know which features you need, so that we can implement it in future release
of iRedAPD.
## Migrate to iRedAPD
### Upgrade iRedAPD to 1.7.0 or later releases
Please Make sure you're running iRedAPD-1.7.0 or later release, you can check
the version number with command below:
```
grep '__version__' /opt/iredapd/libs/__init__.py
```
If you're not running iRedAPD-1.7.0 or later release, please follow our
tutorial to upgrade it: [Upgrade iRedAPD](./upgrade.iredapd.html).
### Migrate Cluebringer to iRedAPD
iRedAPD-1.7.0 and later release ship two scripts to migrate greylisting and
throttling settings from Cluebringer:
* `/opt/iredapd/tools/migrate_cluebringer_greylisting.py`: used to migrate
greylisting settings.
* `/opt/iredapd/tools/migrate_cluebringer_throttle.py`: used to migrate
throttling settings.
Please open above two files, update below parameters with correct SQL server
address, port, database name, username and password for your existing
Cluebringer database. You can find them in files below:
* On RHEL/CentOS, it's `/etc/policyd/cluebringer.conf`.
* Debian/Ubuntu: it's `/etc/cluebringer/cluebringer.conf`.
* FreeBSD: it's `/usr/local/etc/cluebringer.conf`.
* OpenBSD: Not applicable, cluebringer is not available on OpenBSD.
```
cluebringer_db_host = '127.0.0.1'
cluebringer_db_port = 3306
cluebringer_db_name = 'cluebringer'
cluebringer_db_user = 'root'
cluebringer_db_password = ''
```
Then run below commands to migrate greylisting and throttling settings:
```
# cd /opt/iredapd/tools/
# python migrate_cluebringer_greylisting.py
# python migrate_cluebringer_throttle.py
```
That's it.
### After migration
After migrated to iRedAPD, we need to update Postfix config file
`/etc/postfix/main.cf` (Linux) or `/usr/local/etc/postfix/main.cf` (FreeBSD)
to remove Cluebringer settings:
* Remove all `check_policy_service inet:127.0.0.1:10031` in `main.cf`, like below:
```
smtpd_recipient_restrictions =
reject_unknown_recipient_domain
reject_non_fqdn_recipient
reject_unlisted_recipient
check_policy_service inet:127.0.0.1:7777
check_policy_service inet:127.0.0.1:10031 # <- Remove this line
permit_mynetworks
permit_sasl_authenticated
reject_unauth_destination
smtpd_end_of_data_restrictions =
check_policy_service inet:127.0.0.1:7777
check_policy_service inet:127.0.0.1:10031 # <- Remove this line
```
* Restart Postfix service:
* On Linux/FreeBSD: ```# service postfix restart```
* On OpenBSD: ```# /etc/rc.d/postfix restart```
* Stop Cluebringer service, and optionally, remove cluebringer packages.
* On RHEL/CentOS:
```# service cbpolicyd stop && yum remove cluebringer```
* On Debian/Ubuntu:
```# service postfix-cluebringer stop && apt-get remove --purge postfix-cluebringer```
* On FreeBSD:
```# service policyd2 stop && cd /usr/ports/mail/policyd2/ && make deinstall```
* Edit root user's cron job, remove the one used to clean up Cluebringer SQL
database:
* Run command to edit root user's cron job: ```# crontab -e -u root```
* Find cron job like below, remove it or comment out it:
```
3 3 * * * /usr/sbin/cbpadmin --config=/etc/policyd/cluebringer.conf --cleanup >/dev/null
```
* Optionally, you can drop its SQL database `cluebringer` also.

View File

@ -67,7 +67,7 @@
<tr>
<td><a href="https://bitbucket.org/zhb/iredapd/" target="_blank">iRedAPD</a></td>
<td>A very simple postfix policy server developed by iRedMail team</td>
<td>grep 'version' /opt/iredapd/libs/__init__.py</td>
<td>grep '__version__' /opt/iredapd/libs/__init__.py</td>
</tr>
<tr>

View File

@ -0,0 +1,152 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Migrate from Cluebringer to iRedAPD</title>
<link rel="stylesheet" type="text/css" href="./css/markdown.css" />
</head>
<body>
<div id="navigation">
<a href="http://www.iredmail.org" target="_blank">iRedMail web site</a>
// <a href="./index.html">Document Index</a>
</div><h1 id="migrate-from-cluebringer-to-iredapd">Migrate from Cluebringer to iRedAPD</h1>
<div class="toc">
<ul>
<li><a href="#migrate-from-cluebringer-to-iredapd">Migrate from Cluebringer to iRedAPD</a><ul>
<li><a href="#summary">Summary</a></li>
<li><a href="#migrate-to-iredapd">Migrate to iRedAPD</a><ul>
<li><a href="#upgrade-iredapd-to-170-or-later-releases">Upgrade iRedAPD to 1.7.0 or later releases</a></li>
<li><a href="#migrate-cluebringer-to-iredapd">Migrate Cluebringer to iRedAPD</a></li>
<li><a href="#after-migration">After migration</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<h2 id="summary">Summary</h2>
<p>iRedMail-0.9.3 and later releases drop Cluebringer, and replace it by iRedAPD,
because:</p>
<ul>
<li>Cluebringer is not under active development anymore.</li>
<li>No new Cluebringer release since 2013 (the latest stable release doesn't
support IPv6).</li>
<li>Cluebringer is not available in Debian (jessie) official repositories
anymore, developers didn't bring it back.</li>
</ul>
<p>Not all Cluebringer features are implemented in iRedAPD, but the most important
2 features have been implemented:</p>
<ul>
<li>throttling</li>
<li>greylisting</li>
</ul>
<p>If you need other Cluebringer features, please stay with Cluebringer and let
us know which features you need, so that we can implement it in future release
of iRedAPD.</p>
<h2 id="migrate-to-iredapd">Migrate to iRedAPD</h2>
<h3 id="upgrade-iredapd-to-170-or-later-releases">Upgrade iRedAPD to 1.7.0 or later releases</h3>
<p>Please Make sure you're running iRedAPD-1.7.0 or later release, you can check
the version number with command below:</p>
<pre><code>grep '__version__' /opt/iredapd/libs/__init__.py
</code></pre>
<p>If you're not running iRedAPD-1.7.0 or later release, please follow our
tutorial to upgrade it: <a href="./upgrade.iredapd.html">Upgrade iRedAPD</a>.</p>
<h3 id="migrate-cluebringer-to-iredapd">Migrate Cluebringer to iRedAPD</h3>
<p>iRedAPD-1.7.0 and later release ship two scripts to migrate greylisting and
throttling settings from Cluebringer:</p>
<ul>
<li><code>/opt/iredapd/tools/migrate_cluebringer_greylisting.py</code>: used to migrate
greylisting settings.</li>
<li><code>/opt/iredapd/tools/migrate_cluebringer_throttle.py</code>: used to migrate
throttling settings.</li>
</ul>
<p>Please open above two files, update below parameters with correct SQL server
address, port, database name, username and password for your existing
Cluebringer database. You can find them in files below:</p>
<ul>
<li>On RHEL/CentOS, it's <code>/etc/policyd/cluebringer.conf</code>.</li>
<li>Debian/Ubuntu: it's <code>/etc/cluebringer/cluebringer.conf</code>.</li>
<li>FreeBSD: it's <code>/usr/local/etc/cluebringer.conf</code>.</li>
<li>OpenBSD: Not applicable, cluebringer is not available on OpenBSD.</li>
</ul>
<pre><code>cluebringer_db_host = '127.0.0.1'
cluebringer_db_port = 3306
cluebringer_db_name = 'cluebringer'
cluebringer_db_user = 'root'
cluebringer_db_password = ''
</code></pre>
<p>Then run below commands to migrate greylisting and throttling settings:</p>
<pre><code># cd /opt/iredapd/tools/
# python migrate_cluebringer_greylisting.py
# python migrate_cluebringer_throttle.py
</code></pre>
<p>That's it.</p>
<h3 id="after-migration">After migration</h3>
<p>After migrated to iRedAPD, we need to update Postfix config file
<code>/etc/postfix/main.cf</code> (Linux) or <code>/usr/local/etc/postfix/main.cf</code> (FreeBSD)
to remove Cluebringer settings:</p>
<ul>
<li>Remove all <code>check_policy_service inet:127.0.0.1:10031</code> in <code>main.cf</code>, like below:</li>
</ul>
<pre><code>smtpd_recipient_restrictions =
reject_unknown_recipient_domain
reject_non_fqdn_recipient
reject_unlisted_recipient
check_policy_service inet:127.0.0.1:7777
check_policy_service inet:127.0.0.1:10031 # &lt;- Remove this line
permit_mynetworks
permit_sasl_authenticated
reject_unauth_destination
smtpd_end_of_data_restrictions =
check_policy_service inet:127.0.0.1:7777
check_policy_service inet:127.0.0.1:10031 # &lt;- Remove this line
</code></pre>
<ul>
<li>
<p>Restart Postfix service:</p>
<ul>
<li>On Linux/FreeBSD: <code># service postfix restart</code></li>
<li>On OpenBSD: <code># /etc/rc.d/postfix restart</code></li>
</ul>
</li>
<li>
<p>Stop Cluebringer service, and optionally, remove cluebringer packages.</p>
<ul>
<li>On RHEL/CentOS:
<code># service cbpolicyd stop &amp;&amp; yum remove cluebringer</code></li>
<li>On Debian/Ubuntu:
<code># service postfix-cluebringer stop &amp;&amp; apt-get remove --purge postfix-cluebringer</code></li>
<li>On FreeBSD:
<code># service policyd2 stop &amp;&amp; cd /usr/ports/mail/policyd2/ &amp;&amp; make deinstall</code></li>
</ul>
</li>
<li>
<p>Edit root user's cron job, remove the one used to clean up Cluebringer SQL
database:</p>
<ul>
<li>Run command to edit root user's cron job: <code># crontab -e -u root</code></li>
<li>Find cron job like below, remove it or comment out it:</li>
</ul>
</li>
</ul>
<pre><code>3 3 * * * /usr/sbin/cbpadmin --config=/etc/policyd/cluebringer.conf --cleanup &gt;/dev/null
</code></pre>
<ul>
<li>Optionally, you can drop its SQL database <code>cluebringer</code> also.</li>
</ul><p style="text-align: center; color: grey;">Document published under a <a href="http://creativecommons.org/licenses/by-nd/3.0/us/" target="_blank">CC BY-ND 3.0</a> license. If you found something wrong, please do <a href="http://www.iredmail.org/contact.html">contact us</a> to fix it.<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-3293801-21', 'auto');
ga('send', 'pageview');
</script>
</body></html>

View File

@ -200,7 +200,7 @@ on Debian/Ubuntu.</p>
<ul>
<li>RHEL/CentOS: <code>/etc/init.d/cbpolicyd</code></li>
<li>Debian/Ubuntu: <code>/etc/init.d/postfix-cluebringer</code></li>
<li>FreeBSD: <code>/usr/local/etc/rc.d/cluebringer</code></li>
<li>FreeBSD: <code>/usr/local/etc/rc.d/policyd2</code></li>
<li>OpenBSD: N/A. we don't have Cluebringer installed on OpenBSD.</li>
</ul>
<h2 id="fail2ban">Fail2ban</h2>

View File

@ -113,13 +113,13 @@ installer with below command instead of the original one (<code>bash iRedMail.sh
<blockquote>
<p>WARNING:</p>
<ul>
<li>The variable names (<code>MYSQL_SERVER</code>, <code>MYSQL_ROOT_USER</code>, <code>MYSQL_GRANT_HOST</code>)
are <strong>CASE SENSITIVE</strong>.</li>
<li>With iRedMail-0.9.3 and later releases, it's <code>MYSQL_SERVER_ADDRESS</code>, not
<code>MYSQL_SERVER</code>.</li>
<li>The variable names (<code>MYSQL_SERVER_ADDRESS</code>, <code>MYSQL_SERVER_PORT</code>,
<code>MYSQL_ROOT_USER</code>, <code>MYSQL_GRANT_HOST</code>) are <strong>CASE SENSITIVE</strong>.</li>
<li>With <code>iRedMail-0.9.2</code> and earlier releases, it's <code>MYSQL_SERVER</code>, not
<code>MYSQL_SERVER_ADDRESS</code>.</li>
</ul>
</blockquote>
<pre><code># MYSQL_SERVER='192.168.1.100' MYSQL_ROOT_USER='admin_iredmail' MYSQL_GRANT_HOST='192.168.1.200' bash iRedMail.sh
<pre><code># MYSQL_SERVER_ADDRESS='192.168.1.100' MYSQL_SERVER_PORT='3306' MYSQL_ROOT_USER='admin_iredmail' MYSQL_GRANT_HOST='192.168.1.200' bash iRedMail.sh
</code></pre>
<p>It will launch iRedMail installation wizard as usual. When it asks MySQL root
@ -127,7 +127,8 @@ password, please input the password (<code>admin_password</code> in our case) we
on remote MySQL server.</p>
<p>Parameters we used in above command line:</p>
<ul>
<li><code>MYSQL_SERVER</code>: Remote MySQL server address.</li>
<li><code>MYSQL_SERVER_ADDRESS</code>: Remote MySQL server address.</li>
<li><code>MYSQL_SERVER_PORT</code>: Remote MySQL server port. Default is <code>3306</code>.</li>
<li><code>MYSQL_ROOT_USER</code>: MySQL user name we created on remote MySQL server before installing iRedMail.</li>
<li><code>MYSQL_GRANT_HOST</code>: Hostname or IP address of iRedMail server.</li>
</ul>

View File

@ -78,7 +78,7 @@
<tr>
<td><a href="https://bitbucket.org/zhb/iredapd/" target="_blank">iRedAPD</a></td>
<td>A very simple postfix policy server developed by iRedMail team</td>
<td>grep 'version' /opt/iredapd/libs/__init__.py</td>
<td>grep '__version__' /opt/iredapd/libs/__init__.py</td>
</tr>
<tr>