Administration des Cyrus IMAP-Servers (WEB-GUI)
Alternativ zum Administration auf der Konsole mit Unterstützung von cyradm gibt es natürlich eine WEB-GUI auf die man bei Bedarf zurückgreifen kann. Mit diese möglichen Alternative zu cyradm möchten wir uns nun eingehender mit der Applikation Web-cyradm befassen.
vorbereitende Installation
PHP-Paketabhängigkeiten
Für den Einsatz von Web-cyradm gilt es nun als erstes, die notwendigen PHP-Erweiterungen zu installieren:
- php-mysql
- php-pear
- php-pear-db
Falls noch nicht bei der Installation unseres Web-Servers geschehen, installieren wir nun noch die oben genannten RPM-Pakete mit Hilfe von yum
# yum install php-mysql php-pear php-pear-db -y
Download
Von der Projektseite laden wir uns die aktuelle Version web-cyradm-svn-0.5.5.tar.gz herunter.
Für den Download legen wir uns erst einmal unser bereits bekanntes Zielverzeichnis /usr/local/src/packages an.
# mkdir /usr/local/src/packages
# cd /usr/local/src/packages/
Anschließend holen wir uns das tar.gz-Archiv mit Hilfe von wget auf unseren Server. ( # wget http://www.web-cyradm.org/web-cyradm-svn-0.5.5.tar.gz
# wget http://repository.nausch.org/public/web-cyradm-svn-0.5.5.tar.gz
Installation
Im nächsten Schritt machen wir uns nun an die Installation.
- Als erstes entpacken wir das zuvor heruntergeladene Programmarchiv.
# tar xvfz web-cyradm-svn-0.5.5.tar.gz
- Anschließend passen wir die User- und Gruppenberechtigungen an.
# chown apache:apache web-cyradm-svn-0.5.5 -R
- Abschließend verschieben wir noch das Archiv an Ort und Stelle, an dem es später unser Apache-Webserver abholen wird.
# mv /usr/local/src/packages/web-cyradm-svn-0.5.5 /var/www/web-cyradm/
Konfiguration
Apache vHOST
Damit unser Apache-Webserver die Web-GUI auch anzeigen kann, erweitern wir nun unsere vHost-Konfiguration des Web-Servers.
# vim /etc/httpd/conf.d/vhosts.conf
# # webcyradm.nausch.org # <VirtualHost *:80> ServerAdmin webmaster@nausch.org ServerName web-cyradm.nausch.org ServerAlias www.web-cyradm.nausch.org ServerPath / DocumentRoot "/var/www/web-cyradm" <Directory "/var/www/web-cyradm"> AllowOverride AuthConfig Order allow,deny Allow from all </Directory> DirectoryIndex index.php ErrorLog logs/web-cyradm_error.log CustomLog logs/web-cyradm_access.log combined </VirtualHost>
PHP-Konfigurationsdatei
Die im Installationsarchiv mitgelieferte Musterkonfigurationsdatei kopieren wir einmal.
# cp /var/www/web-cyradm/config/conf.php.dist /var/www/web-cyradm/config/conf.php -a
Anschließend passen wir diese Konfigurationsdatei /var/www/web-cyradm/config/conf.php unserer Systemumgebung an.
# vim /var/www/web-cyradm/config/conf.php
- /var/www/web-cyradm/config/conf.php
<?php ######################################################################################## # # This is web-cyradm Version 0.5.4 CVS # # ######################################################################################### // Set Default language # Django : 2012-02-21 # default : $DEFAULTLANG = "en_EN"; $DEFAULTLANG = "de_DE"; # The Cyrus login stuff $CYRUS = array( # Django : 2012-02-21 # default : 'HOST' => 'localhost', 'HOST' => 'imap.dmz.nausch.org', 'PORT' => 143, # Django : 2012-02-21 # default : 'ADMIN' => 'cyrus', 'ADMIN' => 'cyradm', # Django : 2012-02-21 # default : 'PASS' => 'secret' 'PASS' => 'Michi-is-a-Geek!' ); /* DB_TYPE Possible Values are: o mysql o pgsql To operate a mailsystem with postgreSQL you will need a patch for Postfix. Other Databases need to be supported by PAM and postfix */ $DB = array( 'TYPE' => 'mysql', # Django : 2012-02-21 # default : 'USER' => 'mail', 'USER' => 'web-cyradministrator', # Django : 2012-02-21 # default : 'PASS' => 'secret', 'PASS' => 'Klausi-is-a-Geek!', # Django : 2012-02.21 # default : 'PROTO' => 'unix', // set to "tcp" for TCP/IP 'PROTO' => 'tcp', # Django : 2012-02-21 # default : 'HOST' => 'localhost', 'HOST' => 'mysql.dmz.nausch.org', 'NAME' => 'mail' ); $DB['DSN'] = sprintf('%s://%s:%s@%s+%s/%s', $DB['TYPE'], $DB['USER'], $DB['PASS'], $DB['PROTO'], $DB['HOST'], $DB['NAME']); # Where should web-cyradm write its log to? $LOG_DIR = "/var/log/web-cyradm/"; /* Log level Possible values are (from quiet to verbose): ERR - only internal errors WARN - failed login, security violation INFO - all login and logout DEBUG - all possible information */ $LOG_LEVEL = "INFO"; # The default timeout in seconds for a session, after that you have to login again $SESS_TIMEOUT = 1000; # The default quota sets the default quota for new accounts $DEFAULT_QUOTA = 20000; # The default domain quota sets the quota for new domains # 0 = No quota $DEFAULT_DOMAIN_QUOTA = 0; # On what quota level mark accounts on accounts list (in %) $QUOTA_WARN_LEVEL = 90; # Defines if passwords are encrypted or not. # Valid Values: # - plain 0 No encription is used # - crypt 1 (shadow compatible encription) # - mysql 2 (MySQL PASSWORD function) # - md5 3 (MD5 digest) $CRYPT = "crypt"; # web-cyradm is compatible with cyrus-imapd-2.0.16 (and earlier?) # however, if you are using 2.1.x and wish to use email addresses # with .'s in them such as 'john.doe@mydomain.com' you can set this # option DOMAIN_AS_PREFIX to '1'. NOTE: you also have to add this # line to your imapd.conf file: #### imapd.conf: #### # unixhierarchysep: yes #### # Django : 2012-02-21 # default : $DOMAIN_AS_PREFIX = 0; $DOMAIN_AS_PREFIX = 1; # EXPERIMENTAL # If you are using cyrus imap 2.2.x and wish to use usernames like # email addresses you can set option DOMAIN_AS_PREFIX to '1' and # FQUN to '1'. NOTE: you also have to add this lines to your # imapd.conf file: #### imapd.conf: #### # unixhierarchysep: yes # virtdomains: yes #### $FQUN = 0; # At the moment, web-cyradm supports two methods of password change: # - through sql # - poppassd # sql is the default $PASSWORD_CHANGE_METHOD = "sql"; # Turn up error reporting level. This overrides settings in your php.ini # # E_ALL - All errors and warnings # E_ERROR - fatal run-time errors # E_WARNING - run-time warnings (non-fatal errors) # E_PARSE - compile-time parse errors # E_NOTICE - run-time notices (these are warnings which often result # from a bug in your code, but it's possible that it was # intentional (e.g., using an uninitialized variable and # relying on the fact it's automatically initialized to an # empty string) # E_CORE_ERROR - fatal errors that occur during PHP's initial startup # E_CORE_WARNING - warnings (non-fatal errors) that occur during PHP's # initial startup # E_COMPILE_ERROR - fatal compile-time errors # E_COMPILE_WARNING - compile-time warnings (non-fatal errors) # E_USER_ERROR - user-generated error message # E_USER_WARNING - user-generated warning message # E_USER_NOTICE - user-generated notice message error_reporting(E_ERROR); $VERSION="0.5.5-Beta1"; # Define reserved Emailadresses (Separated by comma): $RESERVED="postmaster,root"; $TEMPLATE[0]="default"; $TEMPLATE[1]="green";
Zum Schluß passen wir dann noch aus Sicherheitsgründen die Dateiberechtigung unserer Konfigurationsdatei an.
# chmod 640 /var/www/web-cyradm/config/conf.php
Logverzeichnis und -datei anlegen
Wie in der mitgelieferten Konfigurationsdokumentation /var/www/web-cyradm/doc/html/web-cyradm-config.html vermerkt legen wir nun noch das nötige Logverzeichnis und die Log-datei initial an.
# mkdir /var/log/web-cyradm
# touch /var/log/web-cyradm/web-cyradm-login.log
# chown apache:apache /var/log/web-cyradm/web-cyradm-login.log
Datenbankanbindung
Bei der zuvor durchgeführten Konfiguration der PHP-Anwendung hatten wir bereits Daten für unsere Datenbankanbindung definiert und eingegeben. Nun gilt es im nächsten Schritt den User wie auch die Datenbanken anzulegen, was uns auch dank der mitgelieferten Scripte im Verzeichnis /var/www/web-cyradm/scripts/ recht leicht fallen sollte.
Definition Datenbankuser
Zum Anlegen unseres Datenbankusers bearbeiten wir nun die mitgelieferte Musterdatei.
# vim /var/www/web-cyradm/scripts/insertuser_mysql.sql
- /var/www/web-cyradm/scripts/insertuser_mysql.sql
USE mysql; INSERT INTO USER (Host, USER, Password, Select_priv, Insert_priv, Update_priv, Delete_priv, Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv, File_priv, Grant_priv, References_priv, Index_priv, Alter_priv) VALUES ('vml000090.dmz.nausch.org', 'web-cyradmin', PASSWORD('Klausi-is-a-Geek!'), 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N'); INSERT INTO USER (Host, USER, Password, Select_priv, Insert_priv, Update_priv, Delete_priv, Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv, File_priv, Grant_priv, References_priv, Index_priv, Alter_priv) VALUES ('10.0.0.90', 'web-cyradministrator', PASSWORD('Klausi-is-a-Geek!'), 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N', 'N'); INSERT INTO db (Host, Db, USER, Select_priv, Insert_priv, Update_priv, Delete_priv, Create_priv, Drop_priv, Grant_priv, References_priv, Index_priv, Alter_priv) VALUES ('vml000090.dmz.nausch.org', 'mail', 'web-cyradministrator', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y '); INSERT INTO db (Host, Db, USER, Select_priv, Insert_priv, Update_priv, Delete_priv, Create_priv, Drop_priv, Grant_priv, References_priv, Index_priv, Alter_priv) VALUES ('10.0.0.90', 'mail', 'web-cyradministrator', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y '); FLUSH privileges; CREATE DATABASE mail;
Anschließend passen wir noch die Dateiberechtigungen dieser Konfigurationsdatei an.
# chmod 600 /var/www/web-cyradm/scripts/insertuser_mysql.sql
Zum Importieren der Daten aus der vorgenannten Konfigurationsdatei in unseren mySQL-Server nutzen wir nachfolgenden Aufruf.
# /usr/bin/mysql -h mysql.dmz.nausch.org -u root -p < /var/www/web-cyradm/scripts/insertuser_mysql.sql
Definition Datenbanktabellen
Auch zum Anlegen der Datenbanktabellen greifen wir auf die „Dienste“ der mitgelieferten Musterdatei zurück.
# vim /var/www/web-cyradm/scripts/create_mysql.sql
- /var/www/web-cyradm/scripts/create_mysql.sql
# version 2.2.6 # http://phpwizard.net/phpMyAdmin/ # http://www.phpmyadmin.net/ (download page) # # Host: localhost # Generation TIME: Nov 04, 2002 at 01:44 AM # Server version: 3.23.52 # PHP Version: 4.2.3 # DATABASE : `mail` # -------------------------------------------------------- # Django : 2012-02-21 USE mail; # # TABLE STRUCTURE FOR TABLE `accountuser` # CREATE TABLE accountuser ( username VARCHAR(255) BINARY NOT NULL DEFAULT '', password VARCHAR(50) BINARY NOT NULL DEFAULT '', prefix VARCHAR(50) NOT NULL DEFAULT '', domain_name VARCHAR(255) NOT NULL DEFAULT '', imap INT(10) NOT NULL DEFAULT '1', pop INT(10) NOT NULL DEFAULT '1', sieve INT(10) NOT NULL DEFAULT '1', smtpauth INT(10) NOT NULL DEFAULT '1', UNIQUE KEY username (username) ) TYPE=MyISAM; # -------------------------------------------------------- # # TABLE STRUCTURE FOR TABLE `adminuser` # CREATE TABLE adminuser ( username VARCHAR(50) BINARY NOT NULL DEFAULT '', password VARCHAR(50) BINARY NOT NULL DEFAULT '', TYPE INT(11) NOT NULL DEFAULT '0', SID VARCHAR(255) NOT NULL DEFAULT '', home VARCHAR(255) NOT NULL DEFAULT '', PRIMARY KEY (username) ) TYPE=MyISAM; # -------------------------------------------------------- # # TABLE STRUCTURE FOR TABLE `settings` # CREATE TABLE settings ( `username` VARCHAR(50) BINARY NOT NULL DEFAULT '', `style` VARCHAR(50) NOT NULL DEFAULT 'default', `maxdisplay` INT(4) NOT NULL DEFAULT '15', `warnlevel` INT(3) NOT NULL DEFAULT '90', PRIMARY KEY (username) ) TYPE=MyISAM; # -------------------------------------------------------- # # TABLE STRUCTURE FOR TABLE `alias` # CREATE TABLE alias ( alias VARCHAR(255) NOT NULL DEFAULT '', dest longtext, username VARCHAR(50) NOT NULL DEFAULT '', STATUS INT(11) NOT NULL DEFAULT '1', PRIMARY KEY (alias) ) TYPE=MyISAM; # -------------------------------------------------------- # # TABLE STRUCTURE FOR TABLE `domain` # CREATE TABLE DOMAIN ( domain_name VARCHAR(255) NOT NULL DEFAULT '', prefix VARCHAR(50) NOT NULL DEFAULT '', maxaccounts INT(11) NOT NULL DEFAULT '20', quota INT(10) NOT NULL DEFAULT '20000', domainquota INT(10) NOT NULL DEFAULT '0', transport VARCHAR(255) NOT NULL DEFAULT 'cyrus', freenames enum('YES','NO') NOT NULL DEFAULT 'NO', freeaddress enum('YES','NO') NOT NULL DEFAULT 'NO', folders VARCHAR(255) NOT NULL DEFAULT '', PRIMARY KEY (domain_name), UNIQUE KEY prefix (prefix) ) TYPE=MyISAM; # -------------------------------------------------------- # # TABLE STRUCTURE FOR TABLE `domainadmin` # CREATE TABLE domainadmin ( domain_name VARCHAR(255) NOT NULL DEFAULT '', adminuser VARCHAR(255) NOT NULL DEFAULT '' ) TYPE=MyISAM; # -------------------------------------------------------- # # TABLE STRUCTURE FOR TABLE `search` # CREATE TABLE SEARCH ( search_id VARCHAR(255) NOT NULL DEFAULT '', search_sql text NOT NULL, perpage INT(11) NOT NULL DEFAULT '0', TIMESTAMP TIMESTAMP(14) NOT NULL, PRIMARY KEY (search_id), KEY search_id (search_id) ) TYPE=MyISAM; # -------------------------------------------------------- # # TABLE STRUCTURE FOR TABLE `virtual` # CREATE TABLE virtual ( alias VARCHAR(255) NOT NULL DEFAULT '', dest longtext, username VARCHAR(50) NOT NULL DEFAULT '', STATUS INT(11) NOT NULL DEFAULT '1', KEY alias (alias) ) TYPE=MyISAM; CREATE TABLE log ( id INT(11) NOT NULL AUTO_INCREMENT, msg text NOT NULL, USER VARCHAR(255) NOT NULL DEFAULT '', host VARCHAR(255) NOT NULL DEFAULT '', TIME datetime NOT NULL DEFAULT '2000-00-00 00:00:00', pid VARCHAR(255) NOT NULL DEFAULT '', PRIMARY KEY (id) ) TYPE=MyISAM; # Django : 2012-02-21 # DEFAULT : INSERT INTO adminuser (username, password) VALUES ('admin', ENCRYPT('test')); INSERT INTO adminuser (username, password) VALUES ('admin', ENCRYPT('mein_supergeheimes_Admin-Passwort')); INSERT INTO domainadmin (domain_name,adminuser) VALUES ('*','admin'); # Django : 2012-02-21 # DEFAULT : INSERT INTO accountuser (username, password) VALUES ('cyrus', ENCRYPT('secret')); INSERT INTO accountuser (username, password) VALUES ('cyrus', ENCRYPT('account-user-passwort')); INSERT INTO `settings` ( `username` , `style` , `maxdisplay` , `warnlevel` ) VALUES ( 'admin', 'default', '15', '90'); ALTER TABLE `log` ADD INDEX `idx_log_user` ( `user` );
Auch hier legen wir die nötigen Datenbanktabellen und Nutzer aus der Konfigurationsdatei in unserem Datenbankserver mit Hilfe des folgenden Befehlsaufrufes an.
# /usr/bin/mysql -h mysql.dmz.nausch.org -u web-cyradministrator -p < /var/www/web-cyradm/scripts/create_mysql.sql
Verbindungstest
Nun können wir eine erste Verbindung zu unserem Administrations-vHost unseres Webservers aufbauen.
$ firefox web-cyradm.nausch.org
Fazit
Dank nachfolgender Konfigurationsoptionen in der /etc/imapd.conf können wir eigentlich auf eine zusätzliche GUI verzichten.
# Ein Wert größer als Null setzt einen Quo in kByte. Ein Wert der nicht 0 ist, # erlaubt dem Benutzer das anlegen seiner eigenen INBOX autocreatequota: 2048000 # Sobald 90% der Quota erreicht ist, gibt der Server Warnmeldungen aus quotawarn: 90 # Postfach wird angelegt, wenn per lmtpd eine Nachricht angeliefert wird, # für die noch kein Inbox besteht createonpost: no # Loggt sich ein User neu an, oder es wird eine Nachricht per lmtpd # angeliefert, für das noch kein Account besteht, so wird dieser automatisch # mit den definierten Ordnern angelegt ###autocreateinboxfolders: inbox|achive autocreateinboxfolders: Archives | Drafts | Sent | Trash # Loggt sich ein User neu an, oder es wird eine Nachricht per lmtpd # angeliefert, für das noch kein Account besteht, so werden automatisch # folgende Ordner abboniert autosubscribeinboxfolders: Archives | Drafts | Sent | Trash
Haben wir einen neuen Nutzer in unserem zentralen LDAP-Verzeichnis angelegt und der Nutzer meldet sich das erste mal am IMAP-Server an, wird automatisch sein Nutzerkonto angelegt, die Quota vergeben, sowie die Defaut-Ordner angelegt und abboniert.