Install/iRedAdmin-Pro/MySQL/FreeBSD

From iRedMail

(Difference between revisions)
Jump to: navigation, search
(Download iRedAdmin and configure Apache web server)
 
(14 intermediate revisions not shown)
Line 1: Line 1:
-
= System requirements =
+
__TOC__
-
* '''Apache''', 2.2+. Web server. Already shipped within RHEL/CentOS 5.x.
+
-
** '''mod_wsgi''' 2.1+. Apache module used to host Python application which supports the Python WSGI interface.
+
-
* '''Python''' 2.4+, core programming language. Already shipped within RHEL/CentOS 5.x. 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.
+
-
= Add new system account: iredadmin =
+
If you already have iRedAdmin open source edition installed, you can migrate from iRedAdmin open source edition to iRedAdmin-Pro with just few steps:
 +
* [[Migrate/iRedAdmin-Pro/OSE-Pro |Migrate from iRedAdmin open source edition to iRedAdmin-Pro]]
-
We will make iRedAdmin run with Apache web server, but as non-apache, low privilege user: '''iredadmin'''.
+
= Summary =
-
{{cmd|<pre>
+
* This installation guide is used to install iRedAdmin-Pro-MySQL on FreeBSD. Release 7.x, 8.x and 9.x are supported.
-
# pw useradd -s /sbin/nologin -d /home/iredadmin -n iredadmin
+
* iRedAdmin-Pro is official web-based admin panel for iRedMail. There're three editions available:
-
</pre>}}
+
** '''iRedAdmin-Pro-LDAP''': works with OpenLDAP backend.
 +
** '''iRedAdmin-Pro-MySQL''': works with MySQL backend.
 +
** '''iRedAdmin-Pro-PGSQL''': works with PostgreSQL backend.
-
= Install necessary packages =
+
= System requirements =
 +
* iRedMail-0.8.0 or later releases. If you're looking for installation guide for iRedMail-0.7.4 or eailier releases, please go to [[Install/iRedAdmin-Pro/MySQL/FreeBSD/OLD |this tutorial]] instead.
 +
* iRedAdmin-Pro-MySQL-1.3.0 or later releases.
-
Install several devel binary packages, used for building python modules.
+
* Required Packages. They all are installed automatically during iRedMail installation.
-
{{cmd|<pre>
+
** '''Apache''', 2.2+. Web server.
-
# bash
+
*** '''mod_wsgi''' 2.1+. Apache module used to host Python application which supports the Python WSGI interface.
-
# for p in www/mod_wsgi www/webpy databases/py-dbutils devel/py-Jinja2 databases/py-MySQLdb net/py-netifaces; do cd /usr/ports/${i} && make install clean; done
+
** '''Python''' 2.4+, core programming language. Warning: Python 3.x is not supported yet.
-
</pre>}}
+
** '''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.
 +
 
 +
iRedAdmin will run with a low-privileged system user: iredadmin, which is created automatically during iRedMail installation, too.
= Download iRedAdmin and configure Apache web server =
= Download iRedAdmin and configure Apache web server =
-
 
* Get iRedAdmin:
* 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 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].
** 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/local/www/, set correct file permissions, and create symbol link.
* Copy iRedAdmin to /usr/local/www/, set correct file permissions, and create symbol link.
{{cmd|<pre>
{{cmd|<pre>
Line 38: Line 39:
* Add apache configure file: /usr/local/etc/apache22/Includes/iredadmin.conf.
* Add apache configure file: /usr/local/etc/apache22/Includes/iredadmin.conf.
{{cfg|/usr/local/etc/apache22/Includes/iredadmin.conf|<pre>
{{cfg|/usr/local/etc/apache22/Includes/iredadmin.conf|<pre>
-
#
 
-
# Note: Uncomment below two lines if you want to make iRedAdmin accessable via HTTP.
 
-
#
 
-
#WSGIScriptAlias /iredadmin /usr/local/www/iredadmin/iredadmin.py/
 
-
#Alias /iredadmin/static /usr/local/www/iredadmin/static/
 
-
 
WSGISocketPrefix /var/run/wsgi
WSGISocketPrefix /var/run/wsgi
WSGIDaemonProcess iredadmin user=iredadmin threads=15
WSGIDaemonProcess iredadmin user=iredadmin threads=15
Line 68: Line 63:
= Create necessary MySQL database and grant privileges =
= Create necessary MySQL database and grant privileges =
 +
Create MySQL database: iredadmin. Used to store sessions, admin operation log, etc.
 +
{{cmd|<pre>
 +
# mysql -uroot -p
 +
mysql> CREATE DATABASE iredadmin DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
 +
mysql> USE iredadmin;
 +
mysql> SOURCE /usr/local/www/iredadmin/docs/samples/iredadmin.sql;
 +
</pre>}}
 +
 +
* Grant privileges to iredadmin user and set password for it.
 +
 +
'''WARNING''': Here we use 'plain_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 'plain_passwd';
 +
mysql> FLUSH PRIVILEGES;
 +
</pre>}}
 +
= Configure iRedAdmin =
= Configure iRedAdmin =
 +
 +
The major config file of iRedAdmin is file '''/var/www/iredadmin/settings.ini'''.
 +
 +
* Copy example config file, and set correct file permission.
 +
{{cmd|<pre>
 +
# cd /usr/local/www/iredadmin/
 +
# cp settings.ini.mysql.sample settings.ini
 +
# chown iredadmin:iredadmin settings.ini
 +
# chmod 0600 settings.ini
 +
</pre>}}
 +
 +
 +
'''NOTE''': If you are installing iRedAdmin-Pro, and have iRedAdmin open source edition installed, you can simply copy '''settings.ini''' from open source edition. Don't forget to set correct file owner and permission after copied.
 +
 +
 +
* Edit '''settings.ini'''.
 +
 +
'''NOTE''':
 +
** All required usernames/passwords are stored in '''iRedMail.tips''' which generated during iRedMail installation, placed under iRedMail directory. e.g. /root/iRedMail-0.8.0/iRedMail.tips.
 +
** 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/httpd 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 =
= 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>}}

Current revision as of 00:45, 6 May 2012

Contents


If you already have iRedAdmin open source edition installed, you can migrate from iRedAdmin open source edition to iRedAdmin-Pro with just few steps:

Summary

  • This installation guide is used to install iRedAdmin-Pro-MySQL on FreeBSD. Release 7.x, 8.x and 9.x are supported.
  • iRedAdmin-Pro is official web-based admin panel for iRedMail. There're three editions available:
    • iRedAdmin-Pro-LDAP: works with OpenLDAP backend.
    • iRedAdmin-Pro-MySQL: works with MySQL backend.
    • iRedAdmin-Pro-PGSQL: works with PostgreSQL backend.

System requirements

  • iRedMail-0.8.0 or later releases. If you're looking for installation guide for iRedMail-0.7.4 or eailier releases, please go to this tutorial instead.
  • iRedAdmin-Pro-MySQL-1.3.0 or later releases.
  • Required Packages. They all are installed automatically during iRedMail installation.
    • 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.

iRedAdmin will run with a low-privileged system user: iredadmin, which is created automatically during iRedMail installation, too.

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 download page.
  • Copy iRedAdmin to /usr/local/www/, set correct file permissions, and create symbol link.
Terminal:
# tar xjf iRedAdmin-x.y.z.tar.bz2 -C /usr/local/www/
# cd /usr/local/www/
# chown -R iredadmin:iredadmin iRedAdmin-x.y.z
# chmod -R 0755 iRedAdmin-x.y.z
# ln -s iRedAdmin-x.y.z iredadmin
  • Add apache configure file: /usr/local/etc/apache22/Includes/iredadmin.conf.
File: /usr/local/etc/apache22/Includes/iredadmin.conf
WSGISocketPrefix /var/run/wsgi
WSGIDaemonProcess iredadmin user=iredadmin threads=15
WSGIProcessGroup iredadmin

AddType text/html .py

<Directory /usr/local/www/iredadmin/>
    Order deny,allow
    Allow from all
</Directory>
  • Edit /usr/local/etc/apache22/extra/httpd-ssl.conf, make iredadmin accessable via HTTPS. Add below lines before </VirtualHost>:
File: /usr/local/etc/apache22/extra/httpd-ssl.conf
WSGIScriptAlias /iredadmin /usr/local/www/iredadmin/iredadmin.py/
Alias /iredadmin/static /usr/local/www/iredadmin/static/
  • Restart apache to enable mod_wsgi:
Terminal:
# /usr/local/etc/rc.d/apache22 restart

Create necessary MySQL database and grant privileges

Create MySQL database: iredadmin. Used to store sessions, admin operation log, etc.

Terminal:
# mysql -uroot -p
mysql> CREATE DATABASE iredadmin DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
mysql> USE iredadmin;
mysql> SOURCE /usr/local/www/iredadmin/docs/samples/iredadmin.sql;
  • Grant privileges to iredadmin user and set password for it.

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

Terminal:
# mysql -uroot -p
mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON iredadmin.* TO iredadmin@localhost IDENTIFIED BY 'plain_passwd';
mysql> FLUSH PRIVILEGES;

Configure iRedAdmin

The major config file of iRedAdmin is file /var/www/iredadmin/settings.ini.

  • Copy example config file, and set correct file permission.
Terminal:
# cd /usr/local/www/iredadmin/
# cp settings.ini.mysql.sample settings.ini
# chown iredadmin:iredadmin settings.ini
# chmod 0600 settings.ini


NOTE: If you are installing iRedAdmin-Pro, and have iRedAdmin open source edition installed, you can simply copy settings.ini from open source edition. Don't forget to set correct file owner and permission after copied.


  • Edit settings.ini.

NOTE:

    • All required usernames/passwords are stored in iRedMail.tips which generated during iRedMail installation, placed under iRedMail directory. e.g. /root/iRedMail-0.8.0/iRedMail.tips.
    • For more inforamtion, please open settings.ini, it's self-documented.
File: settings.ini
[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.
  • Restart apache web server.
Terminal:
# /etc/init.d/httpd restart

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.

File: settings.ini
[general]
debug = True
Personal tools