Commits

Zhang Huangbin committed e636c94

Doc cleanup.

  • Participants
  • Parent commits a6e58dd

Comments (0)

Files changed (7)

 Authors:
     * Zhang Huangbin <michaelbibby@gmail.com>
-
-Contributors:
-    * no.0023@gmail.com
+Please visit iredmail web site to read installation guide:
+
+- Install iRedAdmin on Red Hat Enterprise Linux & CentOS:
+  http://www.iredmail.org/admin_installation_rhel.html
+
+- Install iRedAdmin on Debian:
+  http://www.iredmail.org/admin_installation_debian.html
+
+- Install iRedAdmin on Ubuntu
+  http://www.iredmail.org/admin_installation_ubuntu.html
+
+Please report bugs in our forum:
+  http://www.iredmail.org/forum/forum5.html

README

Empty file removed.

TODO

-* Per-user i18n.
-* Add, delete, modify user.
-* Add, delete, modify admin.
-* Ability to change user/admin password.

docs/INSTALL.debian

-*) Overview
-
-Required components:
-    - Apache (2.2+)
-    - mod_wsgi (2.1+)
-    - Python (2.4+)
-    - webpy (0.32)
-    - MySQL-python
-    - python-ldap
-
-*) Installation
-
-    - Install python related modules and packages: 
-
-        # ---- Install development files ---
-        $ sudo apt-get install gcc python-setuptools python-dev libldap2-dev libmysqlclient15-dev libsasl2-dev libssl-dev libapache2-mod-wsgi
-
-        # ---- Install python packages ----
-        $ sudo easy_install web.py Jinja2 python-ldap MySQL-python
-
-        # ---- Enable wsgi module in apache.
-        $ sudo a2enmod mod-wsgi
-
-*) Setup
-
-    - Copy iRedAdmin to apache document root /usr/share/apache2/:
-
-        $ tar xjf iRedAdmin-x.y.z.tar.bz2
-        $ sudo mv iRedAdmin-x.y.z /usr/share/apache2/
-        $ cd /usr/share/apache2/
-        $ sudo chown -R root:root 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.
-
-        # ----
-        WSGIScriptAlias /iredadmin /usr/share/apache2/iRedAdmin/iredadmin.py/
-
-        Alias /iredadmin/static /usr/share/apache2/iRedAdmin/static/
-        AddType text/html .py
-
-        <Directory /usr/share/apache2/iRedAdmin/>
-            Order deny,allow
-            Allow from all
-        </Directory>
-        # ----
-
-      Restart apache to enable it:
-
-        $ sudo /etc/init.d/apache2 restart
-
-    - Create MySQL database:
-
-        $ 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;
-
-      Add MySQL user and grant privileges:
-
-        mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON iredadmin.* TO iredadmin@localhost IDENTIFIED BY 'secret_passwd';
-        mysql> FLUSH PRIVILEGES;
-
-*) Configuration:
-
-    - Copy example config file:
-
-        $ cd /usr/share/apache2/iRedAdmin-x.y.z/config/
-        $ cp settings.ini.sample settings.ini
-
-    - Edit settings.ini and set several variables:
-
-        [general]
-        admin = michaelbibby@gmail.com
-        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
-        db_table_session = sessions
-
-        [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
-
-*) Visit below url in your web browser for test:
-
-    http://your_server_ip_address/iredadmin/

docs/INSTALL.rhel

-*) Overview
-
-Required components:
-    - Apache (2.2+), shipped within RHEL/CentOS 5.x.
-    - mod_wsgi (2.1+)
-    - Python (2.4+), shipped within RHEL/CentOS 5.x.
-    - webpy (0.32)
-    - MySQL-python
-    - python-ldap
-
-*) Installation
-
-    - Download and install webpy-0.32:
-
-        $ wget http://webpy.org/static/web.py-0.32.tar.gz
-        $ tar xzf web.py-0.32.tar.gz
-        $ cd webpy
-        $ sudo python setup.py install
-
-      Test:
-
-        $ python
-        >>> import web
-        >>>                     # <- No error here.
-
-    - Install python related modules and packages: 
-
-        # ---- For i386 ----
-        $ sudo yum install python-setuptools gcc.i386 gcc-c++.i386 openssl-devel.i386 python-devel.i386 openldap-devel.i386 mysql-devel.i386
-
-        # ---- For x86_64 ----
-        $ sudo yum install python-setuptools gcc.x86_64 gcc-c++.x86_64 openssl-devel.x86_64 python-devel.x86_64 openldap-devel.x86_64 mysql-devel.x86_64
-
-        # ---- Install python packages ----
-        $ sudo easy_install Jinja2 python-ldap MySQL-python netifaces
-
-    - Install mod_wsgi from EPEL repository:
-
-        # ---- For i386 ----
-        $ sudo rpm -ivh http://download.fedora.redhat.com/pub/epel/5/i386/mod_wsgi-2.1-2.el5.i386.rpm
-
-        # ---- For x86_64 ----
-        $ sudo rpm -ivh http://download.fedora.redhat.com/pub/epel/5/x86_64/mod_wsgi-2.1-2.el5.x86_64.rpm
-
-*) Setup
-
-    - Copy iRedAdmin to /var/www/:
-
-        $ tar xjf iRedAdmin-x.y.z.tar.bz2
-        $ sudo mv iRedAdmin-x.y.z /var/www/
-        $ cd /var/www/
-        $ sudo chown -R root:root iRedAdmin-x.y.z
-        $ sudo chmod -R 0755 iRedAdmin-x.y.z
-
-    - Add apache configure file: /etc/httpd/conf.d/iredadmin.conf.
-
-        # ----
-        WSGIScriptAlias /iredadmin /var/www/iRedAdmin/iredadmin.py/
-
-        Alias /iredadmin/static /var/www/iRedAdmin/static/
-        AddType text/html .py
-
-        <Directory /var/www/iRedAdmin/>
-            Order deny,allow
-            Allow from all
-        </Directory>
-        # ----
-
-      Restart apache to enable it:
-
-        $ sudo /etc/init.d/httpd restart
-
-    - Create MySQL database:
-
-        $ 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;
-
-      Add MySQL user and grant privileges:
-
-        mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON iredadmin.* TO iredadmin@localhost IDENTIFIED BY 'secret_passwd';
-        mysql> FLUSH PRIVILEGES;
-
-*) Configuration:
-
-    - Copy example config file:
-
-        $ cd /var/www/iRedAdmin-x.y.z/
-        $ cp settings.ini.sample settings.ini
-
-    - Edit settings.ini and set several variables:
-
-        [general]
-        admin = michaelbibby@gmail.com
-        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
-        db_table_session = sessions
-
-        [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-readable:
-
-        # chmod -w settings.ini
-
-*) Visit below url in your web browser for test:
-
-    http://your_server_ip_address/iredadmin/

docs/samples/iredadmin.sql

-# CREATE DATABASE iredadmin DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
-# GRANT INSERT,UPDATE,DELETE,SELECT on iredadmin.* to iredadmin@localhost identified by 'secret_passwd';
-#USE iredadmin;
-
 #
 # Session table required by webpy session module.
 #
     data TEXT,
     INDEX session_id_index (session_id)
 ) TYPE=MyISAM;
-
-#
-# Store all operations.
-#
-CREATE TABLE log (
-    timestamp DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
-    admin VARCHAR(255) NOT NULL DEFAULT '',
-    domain VARCHAR(255) NOT NULL DEFAULT '',
-    action VARCHAR(255) NOT NULL DEFAULT '',
-    data VARCHAR(255) NOT NULL DEFAULT '',
-    KEY TIMESTAMP (TIMESTAMP),
-    INDEX timestamp_index (timestamp),
-    INDEX admin_index (admin),
-    INDEX domain_index (domain),
-    INDEX action_index (action)
-) TYPE=MyISAM;
-
-#
-# author: Who public this announcement.
-# admins: Who will see this announcement. Default is ALL admins.
-#         Multiple admins should be seperated by comma.
-# starttime: When this ann msg will be displayed. Default is NOW.
-# endtime:   When it should not be displayed.
-# subject: message subject.
-# message: content of ann msg.
-#
-CREATE TABLE announcements (
-    id INT(11) UNSIGNED NOT NULL AUTO_INCREMENT,
-    author VARCHAR(250) NOT NULL,
-    admins VARCHAR(250) NOT NULL DEFAULT 'ALL',
-    starttime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, 
-    endtime TIMESTAMP,
-    subject VARCHAR(250) NOT NULL,
-    message text NOT NULL,
-    PRIMARY KEY (id),
-    INDEX id_index (id),
-    INDEX author_index (author),
-    INDEX admins_index (admins),
-    INDEX starttime_index (starttime),
-    INDEX endtime_index (endtime)
-) TYPE=MyISAM;