Bring back upgrade tutorials for iRedAPD-1.3.x and earlier releases.

This commit is contained in:
Zhang Huangbin 2015-05-02 22:24:42 +08:00
parent f3e06e74ad
commit e300e7cda1
8 changed files with 277 additions and 10 deletions

View File

@ -63,6 +63,8 @@ and it may not be working as expected.</p>
prompt you to choose different versions of binary packages, please choose
the one described below:</p>
<ul>
<li><code>php-5.6.x</code> is recommended, but it's ok if you want to use another version</li>
<li>choose <code>postfix-2.11.x</code></li>
<li>choose <code>p5-Mail-SPF</code>, NOT <code>p5-Mail-SPF-Query</code></li>
</ul>
</li>

View File

@ -14,6 +14,9 @@
<blockquote>
<p>iRedAPD source code is hosted on <a href="https://bitbucket.org/zhb/iredapd/">BitBucket</a>.</p>
<p>Release Notes are available here: <a href="./iredapd.releases.html">iRedAPD Release Notes</a>.</p>
<p>If you're trying to upgrade iRedAPD-1.3.x or earlier releases to the latest
iRedAPD, please check this tutorial instead:
<a href="./upgrade.old.iredapd.html">Upgrade iRedAPD from v1.3.x or earlier versions to latest release</a>.</p>
</blockquote>
<p>This tutorial describes how to upgrade iRedAPD from <code>1.4.0</code> or later releases
to the latest stable release. It's applicable on all Linux/BSD distributions

View File

@ -114,16 +114,17 @@
# /etc/rc.d/php_fpm restart
</code></pre>
<p>It's recommended to download the <code>Complete</code> edition (e.g.
<code>roundcubemail-1.1.0-complete.tar.gz</code> instead of <code>Dependent</code> edition (e.g.
<code>roundcubemail-1.1.0.tar.gz</code>).</p>
<p>Please download the <code>Complete</code> edition (e.g. <code>roundcubemail-1.1.1-complete.tar.gz</code>)
instead of <code>Dependent</code> edition (e.g. <code>roundcubemail-1.1.1.tar.gz</code>).</p>
<p>After you have additional packages installed, please follow Roundcube official
tutorial to upgrade Roundcube webmail to the latest stable release:
<a href="http://trac.roundcube.net/wiki/Howto_Upgrade">How to upgrade Roundcube</a></p>
<p>Notes:</p>
<ul>
<li>If you're going to update PHP to 5.6, you should add below settings in
Roundcube config file (<code>config/config.inc.php</code>) to avoid ssl certificate issue:</li>
Roundcube config file (<code>config/config.inc.php</code>) to avoid ssl certificate issue.
If you don't know the location of this config file, check our tutorial here:
<a href="./file.locations.html#roundcube-webmail">Locations of configuration and log files of mojor components</a>.</li>
</ul>
<pre><code>// Required if you're running PHP 5.6
$config['imap_conn_options'] = array(

View File

@ -0,0 +1,140 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Upgrade iRedAPD from v1.3.x or earlier versions to latest release</title>
<link href="./css/markdown.css" rel="stylesheet"></head>
</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="upgrade-iredapd-from-v13x-or-earlier-versions-to-latest-release">Upgrade iRedAPD from v1.3.x or earlier versions to latest release</h1>
<blockquote>
<p>iRedAPD source code is hosted on <a href="https://bitbucket.org/zhb/iredapd/">BitBucket</a>.</p>
<p>Release Notes are available here: <a href="./iredapd.releases.html">iRedAPD Release Notes</a>.</p>
<p>If you're trying to upgrade iRedAPD-1.4.0 or later releases to the latest
iRedAPD, please check this tutorial instead: <a href="./upgrade.iredapd.html">Upgrade iRedAPD</a></p>
</blockquote>
<p>This tutorial describes how to upgrade iRedAPD from v1.3.x or earlier versions
to the later releases, it's applicable on all Linux/BSD distributions supported
by iRedMail.</p>
<p>Important notes:</p>
<ul>
<li>Since iRedAPD-<code>1.4.0</code>, we use Python source file as config file, not <code>.ini</code>
format anymore.</li>
<li>We don't need second instance <code>iredapd-rr</code> anymore (it listens on port <code>7778</code>),
just one instance, one listen port <code>7777</code> is required.</li>
</ul>
<p>Steps to upgrade iRedAPD-1.3.x or earlier versions:</p>
<ul>
<li>Download the latest stable release here: <a href="http://iredmail.org/yum/misc/">http://iredmail.org/yum/misc/</a>
For example, iRedAPD-1.4.4.tar.bz2.</li>
<li>Upload it to your iRedMail server. Assume it's <code>/root/iRedAPD-1.4.4.tar.bz2</code>
on the server.</li>
<li>Extract downloaded package and move to <code>/opt/</code>, set correct owner and permission:</li>
</ul>
<pre><code># tar xjf /root/iRedAPD-1.4.4.tar.bz2 -C /opt/
# cd /opt
# chown -R iredapd:iredapd iRedAPD-1.4.4
# chmod -R 0700 iRedAPD-1.4.4
</code></pre>
<ul>
<li>Generate new config file from sample file, and set correct file owner and permission.</li>
</ul>
<pre><code># cd /opt/iRedAPD-1.4.4/
# cp settings.py.sample settings.py
# chown -R iredapd:iredapd settings.py
# chmod -R 0400 settings.py
</code></pre>
<p><strong>WARNING</strong>: Config file <code>/opt/iredapd/settings.py</code> contains sensitive infomation
(username, password), please don't make it world-readable. Permission 0400 is
the best.</p>
<ul>
<li>
<p>Open iRedAPD config file <code>/opt/iredapd/settings.py</code>, and sync settings with
old iRedAPD config file <code>/opt/iRedAPD-[OLD-VERSION]/etc/iredapd.ini</code>.</p>
<ul>
<li>In old version, parameters under <code>[ldap]</code> section are now new parameters
start with <code>ldap_</code>.</li>
<li>In old version, all parameters under <code>[sql]</code> (or <code>[mysql]</code>) section are
now new parameters start with <code>sql_</code>.</li>
</ul>
</li>
<li>
<p>Remove symbol link of old release:</p>
</li>
</ul>
<pre><code># rm -i /opt/iredapd # &lt;- Don't not end with '/'.
</code></pre>
<ul>
<li>
<p>Copy new RC script. We have scripts for different Linux/BSD distributions,
please copy the correct one for your distribution:</p>
<ul>
<li><code>/opt/iredapd/rc_scripts/iredapd.rhel</code>: For Red Hat, CentOS, Scientific Linux.</li>
<li><code>/opt/iredapd/rc_scripts/iredapd.debian</code>: For Debian and Ubuntu.</li>
<li><code>/opt/iredapd/rc_scripts/iredapd.freebsd</code>: For FreeBSD. Please copy to <code>/usr/local/etc/rc.d/</code>.</li>
<li><code>/opt/iredapd/rc_scripts/iredapd.openbsd</code>: For OpenBSD. Please copy to <code>/etc/rc.d/</code>.</li>
</ul>
</li>
</ul>
<pre><code># cp /opt/iredapd/rc_scripts/iredapd.rhel /etc/init.d/iredapd
# chmod +x /etc/init.d/iredapd
</code></pre>
<ul>
<li>Create symbol link to the latest release:</li>
</ul>
<pre><code># cd /opt/
# ln -s iRedAPD-1.4.4 iredapd
</code></pre>
<ul>
<li>Restart iRedAPD service:</li>
</ul>
<pre><code>#
# ---- On Linux ----
#
# /etc/init.d/iredapd restart
#
# ---- On FreeBSD ----
#
# /usr/local/etc/rc.d/iredapd restart
#
# ---- On OpenBSD ----
#
# /etc/rc.d/iredapd restart
</code></pre>
<ul>
<li>If you don't have file <code>/etc/init.d/iredapd-rr</code> (on Linux), or
<code>/etc/rc.d/iredapd-rr</code> (on OpenBSD), or <code>/usr/local/etc/rc.d/iredapd-rr</code>
(on FreeBSD), it's safe to ignore below steps. But if you have it, please
stop service <code>iredapd-rr</code>, then move all enabled plugin names listed in
<code>/opt/iRedAPD-[OLD_VERSION]/etc/iredapd-rr.ini</code> to new config file
<code>/opt/iredapd/settings.py</code>, in parameter <code>plugins =</code>.</li>
</ul>
<pre><code># /etc/init.d/iredapd-rr stop
# rm /etc/init.d/iredapd-rr
</code></pre>
<p>Check whether you have <code>check_policy_service inet:127.0.0.1:__7778__</code> in Postfix
config file <code>/etc/postfix/main.cf</code> (Linux/OpenBSD) or
<code>/usr/local/etc/postfix/main.cf</code> (FreeBSD), if you have it, please remove it,
then restart Postfix service.</p><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

@ -32,8 +32,7 @@ Notes:
prompt you to choose different versions of binary packages, please choose
the one described below:
* choose `php-5.6.x`, `php-fpm-5.6.x`. Version number `5.6.x` is hard-coded
in iRedMail, so if you choose other version, iRedMail will fail.
* `php-5.6.x` is recommended, but it's ok if you want to use another version
* choose `postfix-2.11.x`
* choose `p5-Mail-SPF`, NOT `p5-Mail-SPF-Query`

View File

@ -4,6 +4,10 @@
> Release Notes are available here: [iRedAPD Release Notes](./iredapd.releases.html).
> If you're trying to upgrade iRedAPD-1.3.x or earlier releases to the latest
> iRedAPD, please check this tutorial instead:
> [Upgrade iRedAPD from v1.3.x or earlier versions to latest release](./upgrade.old.iredapd.html).
This tutorial describes how to upgrade iRedAPD from `1.4.0` or later releases
to the latest stable release. It's applicable on all Linux/BSD distributions
supported by iRedMail.

View File

@ -63,9 +63,8 @@ Additional notes before upgrading Roundcube webmail 1.1.0 (or later releases):
# /etc/rc.d/php_fpm restart
```
It's recommended to download the `Complete` edition (e.g.
`roundcubemail-1.1.0-complete.tar.gz` instead of `Dependent` edition (e.g.
`roundcubemail-1.1.0.tar.gz`).
Please download the `Complete` edition (e.g. `roundcubemail-1.1.1-complete.tar.gz`)
instead of `Dependent` edition (e.g. `roundcubemail-1.1.1.tar.gz`).
After you have additional packages installed, please follow Roundcube official
tutorial to upgrade Roundcube webmail to the latest stable release:
@ -74,7 +73,9 @@ tutorial to upgrade Roundcube webmail to the latest stable release:
Notes:
* If you're going to update PHP to 5.6, you should add below settings in
Roundcube config file (`config/config.inc.php`) to avoid ssl certificate issue:
Roundcube config file (`config/config.inc.php`) to avoid ssl certificate issue.
If you don't know the location of this config file, check our tutorial here:
[Locations of configuration and log files of mojor components](./file.locations.html#roundcube-webmail).
```
// Required if you're running PHP 5.6

View File

@ -0,0 +1,117 @@
# Upgrade iRedAPD from v1.3.x or earlier versions to latest release
> iRedAPD source code is hosted on [BitBucket](https://bitbucket.org/zhb/iredapd/).
> Release Notes are available here: [iRedAPD Release Notes](./iredapd.releases.html).
> If you're trying to upgrade iRedAPD-1.4.0 or later releases to the latest
> iRedAPD, please check this tutorial instead: [Upgrade iRedAPD](./upgrade.iredapd.html)
This tutorial describes how to upgrade iRedAPD from v1.3.x or earlier versions
to the later releases, it's applicable on all Linux/BSD distributions supported
by iRedMail.
Important notes:
* Since iRedAPD-`1.4.0`, we use Python source file as config file, not `.ini`
format anymore.
* We don't need second instance `iredapd-rr` anymore (it listens on port `7778`),
just one instance, one listen port `7777` is required.
Steps to upgrade iRedAPD-1.3.x or earlier versions:
* Download the latest stable release here: [http://iredmail.org/yum/misc/](http://iredmail.org/yum/misc/)
For example, iRedAPD-1.4.4.tar.bz2.
* Upload it to your iRedMail server. Assume it's `/root/iRedAPD-1.4.4.tar.bz2`
on the server.
* Extract downloaded package and move to `/opt/`, set correct owner and permission:
```
# tar xjf /root/iRedAPD-1.4.4.tar.bz2 -C /opt/
# cd /opt
# chown -R iredapd:iredapd iRedAPD-1.4.4
# chmod -R 0700 iRedAPD-1.4.4
```
* Generate new config file from sample file, and set correct file owner and permission.
```
# cd /opt/iRedAPD-1.4.4/
# cp settings.py.sample settings.py
# chown -R iredapd:iredapd settings.py
# chmod -R 0400 settings.py
```
__WARNING__: Config file `/opt/iredapd/settings.py` contains sensitive infomation
(username, password), please don't make it world-readable. Permission 0400 is
the best.
* Open iRedAPD config file `/opt/iredapd/settings.py`, and sync settings with
old iRedAPD config file `/opt/iRedAPD-[OLD-VERSION]/etc/iredapd.ini`.
* In old version, parameters under `[ldap]` section are now new parameters
start with `ldap_`.
* In old version, all parameters under `[sql]` (or `[mysql]`) section are
now new parameters start with `sql_`.
* Remove symbol link of old release:
```
# rm -i /opt/iredapd # <- Don't not end with '/'.
```
* Copy new RC script. We have scripts for different Linux/BSD distributions,
please copy the correct one for your distribution:
* `/opt/iredapd/rc_scripts/iredapd.rhel`: For Red Hat, CentOS, Scientific Linux.
* `/opt/iredapd/rc_scripts/iredapd.debian`: For Debian and Ubuntu.
* `/opt/iredapd/rc_scripts/iredapd.freebsd`: For FreeBSD. Please copy to `/usr/local/etc/rc.d/`.
* `/opt/iredapd/rc_scripts/iredapd.openbsd`: For OpenBSD. Please copy to `/etc/rc.d/`.
```
# cp /opt/iredapd/rc_scripts/iredapd.rhel /etc/init.d/iredapd
# chmod +x /etc/init.d/iredapd
```
* Create symbol link to the latest release:
```
# cd /opt/
# ln -s iRedAPD-1.4.4 iredapd
```
* Restart iRedAPD service:
```
#
# ---- On Linux ----
#
# /etc/init.d/iredapd restart
#
# ---- On FreeBSD ----
#
# /usr/local/etc/rc.d/iredapd restart
#
# ---- On OpenBSD ----
#
# /etc/rc.d/iredapd restart
```
* If you don't have file `/etc/init.d/iredapd-rr` (on Linux), or
`/etc/rc.d/iredapd-rr` (on OpenBSD), or `/usr/local/etc/rc.d/iredapd-rr`
(on FreeBSD), it's safe to ignore below steps. But if you have it, please
stop service `iredapd-rr`, then move all enabled plugin names listed in
`/opt/iRedAPD-[OLD_VERSION]/etc/iredapd-rr.ini` to new config file
`/opt/iredapd/settings.py`, in parameter `plugins = `.
```
# /etc/init.d/iredapd-rr stop
# rm /etc/init.d/iredapd-rr
```
Check whether you have `check_policy_service inet:127.0.0.1:__7778__` in Postfix
config file `/etc/postfix/main.cf` (Linux/OpenBSD) or
`/usr/local/etc/postfix/main.cf` (FreeBSD), if you have it, please remove it,
then restart Postfix service.