Install/iRedAdmin-Pro/MySQL/Gentoo

From iRedMail
(Difference between revisions)
Jump to: navigation, search
(Summary)
 
 
Line 84: Line 84:
 
= Configure iRedAdmin =
 
= Configure iRedAdmin =
  
The major config file of iRedAdmin is file '''/var/www/iredadmin/settings.ini'''.
+
The major config file of iRedAdmin is file '''/var/www/iredadmin/settings.py'''.
  
 
* Copy example config file, and set correct file permission.
 
* Copy example config file, and set correct file permission.
 
{{cmd|<pre>
 
{{cmd|<pre>
 
# cd /var/www/iredadmin/
 
# cd /var/www/iredadmin/
# cp settings.ini.mysql.sample settings.ini
+
# cp settings.py.mysql.sample settings.py
# chown iredadmin:iredadmin settings.ini
+
# chown iredadmin:iredadmin settings.py
# chmod 0400 settings.ini
+
# chmod 0400 settings.py
 
</pre>}}
 
</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.
+
'''NOTE''': If you are installing iRedAdmin-Pro, and have iRedAdmin open source edition installed, you can simply copy '''settings.py''' from open source edition. Don't forget to set correct file owner and permission after copied.
  
  
* Edit '''settings.ini'''.
+
* Edit '''settings.py''' to use correct SQL username/passwords.
  
 
'''NOTE''':
 
'''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.
 
** 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.
+
** For more inforamtion, please open '''settings.py''', 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.
 
* Restart apache web server.
Line 129: Line 113:
  
 
= 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.
+
If iRedAdmin doesn't work as expected, you can set '''debug = True''' in settings.py 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>
+
{{cfg|settings.py|<pre>
 
[general]
 
[general]
 
debug = True
 
debug = True
 
</pre>}}
 
</pre>}}

Latest revision as of 18:13, 14 May 2014

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:

[edit] Summary

  • This installation guide is used to install iRedAdmin-Pro-MySQL on Gentoo Linux.
  • 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.

[edit] System requirements

  • iRedMail-0.8.0 or later releases.
  • 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.

[edit] 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 /var/www/, set correct file permissions, and create symbol link.
Terminal:
# tar xjf iRedAdmin-x.y.z.tar.bz2 -C /var/www/
# cd /var/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: /etc/apache2/modules.d/iredadmin.conf.
File: /etc/apache2/modules.d/iredadmin.conf
WSGISocketPrefix /var/run/wsgi
WSGIDaemonProcess iredadmin user=iredadmin threads=15
WSGIProcessGroup iredadmin

AddType text/html .py

<Directory /var/www/iredadmin/>
    Order deny,allow
    Allow from all
</Directory>
  • Edit /etc/apache2/vhosts.d/00_default_ssl_vhost.conf, make iredadmin accessible via HTTPS. Add below lines before </VirtualHost>:
File: /etc/apache2/vhosts.d/00_default_ssl_vhost.conf
WSGIScriptAlias /iredadmin /var/www/iredadmin/iredadmin.py/
Alias /iredadmin/static /var/www/iredadmin/static/
  • Restart apache to enable mod_wsgi:
Terminal:
# /etc/init.d/apache2 restart

[edit] Create necessary MySQL database and grant privileges

  • Create MySQL database: iredadmin. Used to store sessions, admin operation logs, etc.
Terminal:
# mysql -uroot -p
mysql> CREATE DATABASE iredadmin DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
mysql> USE iredadmin;
mysql> SOURCE /var/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;

[edit] Configure iRedAdmin

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

  • Copy example config file, and set correct file permission.
Terminal:
# cd /var/www/iredadmin/
# cp settings.py.mysql.sample settings.py
# chown iredadmin:iredadmin settings.py
# chmod 0400 settings.py


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


  • Edit settings.py to use correct SQL username/passwords.

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.py, it's self-documented.
  • Restart apache web server.
Terminal:
# /etc/init.d/apache2 restart

[edit] Troubleshooting

If iRedAdmin doesn't work as expected, you can set debug = True in settings.py 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.py
[general]
debug = True
Personal tools