System Requirements.

  • 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.
  • Webpy 0.32+. A python-powered web framework.
  • MySQL-python. A thread-compatible interface to the popular MySQL database server that provides the Python database API.
  • Python-LDAP 2.37+. An object-oriented API to access LDAP directory servers from Python programs.

Add new system account: iredadmin.

We will make iRedAdmin run with Apache web server, but as non-apache, low privilege user: iredadmin.
# ---- Add new user: iredadmin ----
# useradd -s /sbin/nologin -d /home/iredadadmin iredadmin 

Configure OpenLDAP.

Make sure OpenLDAP includes amavisd schema file.
# ---- Add below line in /etc/ldap/slapd.conf before line ----
# ---- 'include /etc/ldap/schema/iredmail.schema' if not present ----

include /etc/ldap/schema/amavis.schema
Restart OpenLDAP service.
# /etc/init.d/slapd restart

Install required python modules and dependences

Install binary packages as dependences, used for building python modules.
$ sudo apt-get install gcc python-setuptools python-dev \
                        libldap2-dev libmysqlclient15-dev \
                        libsasl2-dev libssl-dev \
                        libapache2-mod-wsgi \
                        python-mysqldb python-ldap

Install required python modules.

$ sudo easy_install web.py Jinja2 netifaces

Download iRedAdmin and configure Apache web server.

  • Download iRedAdmin from download page.
  • Copy iRedAdmin to /usr/share/apache2/, set correct file permissions, and create symbol link.
  • $ 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
    
  • Add apache configure file: /etc/apache2/conf.d/iredadmin.conf.
  • #
    # 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>
  • Edit /etc/apache2/sites-enabled/default-ssl, make iredadmin accessable via HTTPS. Add below lines before </VirtualHost>:
  • WSGIScriptAlias /iredadmin /usr/share/apache2/iredadmin/iredadmin.py/
    Alias /iredadmin/static /usr/share/apache2/iredadmin/static/
    
  • Enable mod_wsgi module and restart apache to make it work:
  • $ sudo a2enmod *wsgi
    $ sudo /etc/init.d/apache2 restart
    

Create necessary MySQL database and grant privileges.

  • Create MySQL database: iredadmin.
  • $ 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;
    
  • 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.
    $ mysql -uroot -p
    mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON iredadmin.* TO iredadmin@localhost IDENTIFIED BY 'secret_passwd';
    mysql> FLUSH PRIVILEGES;
    

Configure iRedAdmin.

  • Copy example config file.
  • $ cd /usr/share/apache2/iredadmin/
    $ cp settings.ini.sample settings.ini
    
  • Edit settings.ini and set several variables.
  • NOTE: For more inforamtion, please read settings.ini, it's self-documented.
    NOTE: You should ensure both bind dn and bind_pw are correct with below command, you can find bind dn and password in your iRedMail installation directory, e.g. /root/iRedMail-0.5.1/iRedMail.tips, usually, it's cn=vmailadmin,dc=xxx,dc=xxx.
    $ ldapsearch -x -D 'YOUR_BIND_DN' -W
    WARNING: Bind password is plain text here, not encryped/hashed one.
    [general]
    admin = user@domain.ltd
    debug = False
    lang = en_US
    backend = ldap
    storage_base_directory = /var/vmail/vmail01
    
    [iredadmin]
    dbn = mysql
    host = localhost
    port = 3306
    db = iredadmin
    user = iredadmin
    passwd = secret_passwd
    
    [ldap]
    uri = ldap://127.0.0.1:389
    suffix = dc=iredmail,dc=org
    basedn = o=domains,dc=iredmail,dc=org
    domainadmin_dn = o=domainAdmins,dc=iredmail,dc=org
    bind_dn = cn=vmailadmin,dc=iredmail,dc=org
    bind_pw = passwd
    
  • Make settings.ini not world-writeable and restart apache web server.
  • # chmod 0600 settings.ini
    # /etc/init.d/apache2 restart
    

Open your web browser to access iRedAdmin.

httpS://your_server_ip_address/iredadmin/ Make sure you use HTTPS:// instead of HTTP://.

Troubleshooting & Debug

If iRedAdmin doesn't work as expected, you can simplily set 'debug = True' in settings.ini, 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.