ZhangHuangbin: Created page with '= Summary = * This installation guide is used to install iRedAdmin-Pro-MySQL on Debian 5.x, Ubuntu 8.x, 9.x, 10.x. * iRedAdmin-Pro is official web-based admin panel for iRedMail.…'

ZhangHuangbin — Sun, 06 May 2012 00:25:45 GMT

Created page with '= Summary = * This installation guide is used to install iRedAdmin-Pro-MySQL on Debian 5.x, Ubuntu 8.x, 9.x, 10.x. * iRedAdmin-Pro is official web-based admin panel for iRedMail.…'

New page

= Summary =
* This installation guide is used to install iRedAdmin-Pro-MySQL on Debian 5.x, Ubuntu 8.x, 9.x, 10.x.
* iRedAdmin-Pro is official web-based admin panel for iRedMail. There're two editions:
** '''iRedAdmin-Pro-LDAP''': works with OpenLDAP backend.
** '''iRedAdmin-Pro-MySQL''': works with MySQL backend.
* [[Release.Notes/iRedAdmin-Pro/MySQL/1.0 |Release Notes of iRedAdmin-Pro-MySQL-1.0]]

= System requirements =
* iRedMail-0.6.0 and newer versions. '''Note''': addition update is required. We will cover it below.
* Packages:
** '''Apache''', 2.2+. Web server.
*** '''mod_wsgi''' 2.1+. Apache module used to host Python application which supports the Python WSGI interface.
** '''Python''' 2.4+, core programming language. Warning: Python 3.x is not supported yet.
** '''Web.py''', 0.32+. A python-powered web framework.
*** '''MySQLdb'''. A thread-compatible interface to the popular MySQL database server that provides the Python database API.

= Update iRedMail =
Addition update is required to use iRedAdmin-Pro-MySQL, please follow links to apply them.

* '''[This step is required for iRedMail-0.6.1 and earlier versions]''' Update MySQL database '''vmail'''. Required by iRedAdmin-Pro.
{{cmd|<pre>
$ mysql -u root -p
mysql> USE vmail;

mysql> ALTER TABLE mailbox ADD COLUMN enablesmtpsecured TINYINT(1) NOT NULL DEFAULT '1';
mysql> ALTER TABLE admin ADD COLUMN name VARCHAR(255) DEFAULT '' COLLATE utf8_general_ci;
mysql> ALTER TABLE alias ADD COLUMN name VARCHAR(255) DEFAULT '' COLLATE utf8_general_ci;
mysql> ALTER TABLE domain ADD COLUMN defaultuseraliases TEXT NOT NULL DEFAULT '';
mysql> ALTER TABLE domain ADD COLUMN defaultpasswordscheme VARCHAR(10) NOT NULL DEFAULT '';
</pre>}}

* Upgrade Dovecot from 1.1.x to 1.2, so that iRedAdmin-Pro can show real-time quota usage.
** '''[This step is required for iRedMail-0.6.1 and earlier versions]''' [[iRedMail/FAQ/Upgrade.Dovecot.1.1.to.1.2 |Upgrade Dovecot 1.1.x to 1.2.x]]
** [[iRedMail/FAQ/Store.Realtime.Quota.In.MySQL |Store Real-time Quota in MySQL with Dovecot 1.2]]

* If you want to quarnatine SPAM into MySQL, then manage (delete, release) them in iRedAdmin-Pro, below update is required.
** [[iRedMail/FAQ/Quarantining.Messages |Quarantining SPAM into MySQL with Amavisd]]

= Add new system account: iredadmin =

We will make iRedAdmin run with Apache web server, but as non-apache, low privilege user: '''iredadmin'''.
{{cmd|<pre>
# useradd -m -s /sbin/nologin -d /home/iredadmin iredadmin
</pre>}}

= Install necessary packages =

* Install binary packages as dependences, used for building python modules.
{{cmd|<pre>
$ sudo apt-get install gcc python-setuptools python-dev \
libldap2-dev libmysqlclient15-dev \
libsasl2-dev libssl-dev \
libapache2-mod-wsgi \
python-mysqldb
</pre>}}

* Install required python modules.
{{cmd|<pre>
$ sudo easy_install web.py Jinja2 netifaces DBUtils
</pre>}}

= Download iRedAdmin and configure Apache web server =

* Get iRedAdmin:
** If you purchased iRedAdmin-Pro-MySQL, you should already have it. If not, please mail to '''support@ iredmail.org''' to get a download link.
** If you didn't purchase iRedAdmin-Pro-MySQL, download iRedAdmin open source edition from [http://www.iredmail.org/download.html#iredadmin download page].

* Copy iRedAdmin to /usr/share/apache2/, set correct file permissions, and create symbol link.
{{cmd|<pre>
$ sudo tar xjf iRedAdmin-x.y.z.tar.bz2 -C /usr/share/apache2/
$ cd /usr/share/apache2/
$ sudo chown -R iredadmin:iredadmin iRedAdmin-x.y.z
$ sudo chmod -R 0755 iRedAdmin-x.y.z
$ sudo ln -s iRedAdmin-x.y.z iredadmin
</pre>}}

* Add apache configure file: /etc/apache2/conf.d/iredadmin.conf.
{{cfg|/etc/apache2/conf.d/iredadmin.conf|<pre>
#
# Note: Uncomment below two lines if you want to make iRedAdmin accessable via HTTP.
#
#WSGIScriptAlias /iredadmin /usr/share/apache2/iredadmin/iredadmin.py/
#Alias /iredadmin/static /usr/share/apache2/iredadmin/static/

WSGISocketPrefix /var/run/wsgi
WSGIDaemonProcess iredadmin user=iredadmin threads=15
WSGIProcessGroup iredadmin

AddType text/html .py

<Directory /usr/share/apache2/iredadmin/>
Order deny,allow
Allow from all
</Directory>
</pre>}}

* Edit /etc/apache2/sites-enabled/default-ssl, make iredadmin accessable via HTTPS. Add below lines before </VirtualHost>:
{{cfg|/etc/apache2/sites-enabled/default-ssl|<pre>
WSGIScriptAlias /iredadmin /usr/share/apache2/iredadmin/iredadmin.py/
Alias /iredadmin/static /usr/share/apache2/iredadmin/static/
</pre>}}

* Enable mod_wsgi module and restart apache to make it work:
{{cmd|<pre>
$ sudo a2enmod *wsgi
$ sudo /etc/init.d/apache2 restart
</pre>}}

= Create necessary MySQL database and grant privileges =
* Create MySQL database: iredadmin. Used to store sessions, admin operation logs, etc.
{{cmd|<pre>
$ mysql -uroot -p
mysql> CREATE DATABASE iredadmin DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
mysql> USE iredadmin;
mysql> SOURCE /usr/share/apache2/iredadmin/docs/samples/iredadmin.sql;
</pre>}}

* Grant privileges to iredadmin user and set password for it.

'''WARNING''': Here we use 'secret_passwd' as password of iredadmin user, please replace it with your own password.

{{cmd|<pre>
$ mysql -uroot -p
mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON iredadmin.* TO iredadmin@localhost IDENTIFIED BY 'secret_passwd';
mysql> FLUSH PRIVILEGES;
</pre>}}

= Configure iRedAdmin =

* Copy example config file, and make it not world-writeable.
{{cmd|<pre>
$ cd /usr/share/apache2/iredadmin/
$ cp settings.ini.mysql.sample settings.ini
# chown iredadmin:iredadmin settings.ini
# chmod 0600 settings.ini
</pre>}}

* Edit settings.ini and set correct values.
** '''NOTE''': For more inforamtion, please open '''settings.ini''', it's self-documented.
{{cfg|settings.ini|<pre>
[general]
# General settings ...

[iredadmin]
# Database "iredadmin". required by iRedAdmin.

[vmaildb]
# Database "vmail", stored all mail accounts.

[policyd]
# Database "policyd". Required for policyd integration.

[amavisd]
# Database "amavisd". Required for Amavisd-New integration. includes spam quarantining/releasing.
</pre>}}

* Restart apache web server.
{{cmd|<pre>
# /etc/init.d/apache2 restart
</pre>}}

* Open your web browser to access iRedAdmin: https://your_server_ip_address/iredadmin/
** '''NOTE''': Make sure you use HTTPS:// instead of HTTP://.

= Troubleshooting =
If iRedAdmin doesn't work as expected, you can set '''debug = True''' in settings.ini to turn on debug mode, restart apache web server, use your favourite web browser to access it again, create a new forum topic and paste error message in forum topic.
{{cfg|settings.ini|<pre>
[general]
debug = True
</pre>}}

Install/iRedAdmin-Pro/MySQL/Debian/OLD - Revision history

ZhangHuangbin: Created page with '= Summary = * This installation guide is used to install iRedAdmin-Pro-MySQL on Debian 5.x, Ubuntu 8.x, 9.x, 10.x. * iRedAdmin-Pro is official web-based admin panel for iRedMail.…'