Many Sysadmins have to solve the problem of giving customers the ability of
creating, modifying and deleting email-users on their own. For such needs of virtual email
hosting Xmailserver is a really good choice. This article covers how to install and configure the umpl-xmail
webmail and admintool which helps to make the postmasters' live easier.
umpl-xmail is intented to be used on any Linux / BSD platform (designed for Linux/Apache). The
code should also work on windows-servers but you will have to search for bugs on your own.
If you have questions about umpl-xmail feel free to join the umpl xmail mailinglist at http://lists.waaf.net/mailman/listinfo/umpl-xmail or contact me
at schmidt_nospam_@waaf.net.
After the installation you are able to use the following features (multilingual, at the moment:
german, english, spanish, french, italian, dutch, slovenian, russian, polish, swedish, turkish, hungrian, arabic and greek):
Root-Interface ( http://umpl-xmail.tld/root/ ):
creating, modifying and deleting domains incl. root/postmaster-user
This is the description for first-time installation. If you want update an existing umpl-xmail installation you can go to the next point!
There are two different ways to install - I suggest using the perl-installer! If you can't use it ( because
of having no root-access to the web-/ mysql-/ mailserver or having the services shared on diifferent machines )
you can also install and configure umpl xmail by hand.
The perl-installer and upgrade scripts will run on all ***x-like platforms and where successfully tested on the following systems:
- Linux: SuSE 7.3, 8.0, 8.2, 9.0 (perl 5.61 and 5.8), Debian Woody (perl 5.6 and 5.8).
- M$-Windows (Cygwin): XP, 2000 (perl 5.6, 5.61, 5.8.2).
If you have serious problems running it, please contact umpl-xmail_AT_lists.waaf.net
cd /tmp/
wget http://umpl.de/download/umpl_xmail-2.11.tar.gz
tar xfz umpl_xmail-2.11.tar.gz
cd umpl_xmail-2.11
Run the included install-script and answer the questions.
./umpl_xmail_install-211.pl
Running the installer will do the following for you (You can choose if the commands are done by the installer or written to a textfile for manual processing!):
Create all needed directories and permitions in a target-dir ( under your webservers doc_root )
Create Xmail Ctrl-Account (if XmCrypt & ctrlaccounts.tab are reachable)
Create Mysql User & Database (if wanted, written to txt-file!)
Create Mysql Tables (written to txt-file!)
Create umpl xmail configuration
Copy all PHP & HTML files to target-dir
After having finished you will at least have to do the following:
Run the created textfile with mysql-commands to do all MySQL stuff, e.g.
mysql -uroot -p < umpl_xmail_install.mysql
IF you choosed to run commands by hand during installation you also have to run the created textfile with sh-commands, e.g.
sh umpl_xmail_install.sh
You can now add a VIRTUAL HOST for umpl xmail OR simply run it within a subdirector of your doc_root.
Start using umpl xmail by: open your browser and go to http://umpl-xmail-server/root/ OR http://server/umpl-xmail-dir/root/ and log in with the data created during installation and that can be found at user_data.php ($XM_user and $XM_passwrd).
This is the description for updating an existing umpl-xmail installation.
There are two different ways to update - I suggest using the perl-installer! If you can't use it ( because
of having no root-access to the web-/ mysqlserver or having the services shared on different machines )
you can also install and configure umpl xmail by hand.
Currently the perl-installer does only support updating from Version 2.9 or 2.10.
Automatic update using perl-installer (umpl_xmail_upgrade)
cd /tmp/
wget http://umpl.de/download/umpl_xmail-2.11.tar.gz
tar xfz umpl_xmail-2.11.tar.gz
cd umpl_xmail-2.11
Run one of the included upgrade-scripts and answer the questions, e.g.
./umpl_xmail_upgrade_29-211.pl # if you have V 2.9
./umpl_xmail_upgrade_210-211.pl # if you have V 2.10
The Upgrade-script is only for the mentioned release! - If you have an older version running, please first update to the last version!
Running the upgrade-script will do the following for you (You can choose if the commands are done by the installer or written to a textfile for manual procesing!):
Update Mysql Tables (written to txt-file!)
Make Backups of files to be renewed
Copy all updated files to target-dir
After having finished you will at least have to do the following:
Run the created textfile with mysql-commands to do all MySQL stuff, e.g.
mysql -uroot -p < umpl_xmail_install.mysql
IF you choosed to run commands by hand during installation you also have to run the created textfile with sh-commands, e.g.
umpl xmail is (c) 2001-2004 waaf.net computing, released under Gnu Puplic License - This means you can
use, share and modify this software, but it whould be usefull if you also contribute by developing
and helping free software! e.g. by creating new language templates ;-)
If you want to say thanks to the authors you can do this by sending e.g. a picture postcard to:
waaf.net computing
Achim Schmidt
Haster Strasse 42
DE 49191 Belm
Germany
schmidt_NOSPAM_@waaf.net
(remove _NOSPAM_)
Getting started
Beginning with Version 2.10 autoreply.sh
is bundled with umpl_xmail, which needs to know the correct MAIL_ROOT!
If you don't have Mail_ROOT at /var/MailRoot/ please change it inside '$doc_root/autoreply.sh!
People that use umpl_xmail on Microsoft Windows
environment (e.g. Roxen or IIS) please take an closer look to README.W32!
After having installed umpl-xmail you can start like that:
• log in at /root using the $XM_user & $XM_passwrd values out of user_data.php. • create domain.com with pw test and a quota of 20 users and 100MB. • log in at /index.php using user: root@domain.com and pw test. • navigate to root-admin and you can create a user willi@domain.com with pw test2 and a quota of 10 MB • now you can log in as user willi@domain.com with pw test2 at /index.php • the non-root users can't access root-admin but use webmail, forwarding, etc.
Thats the system - hope you enjoy it!
Files / Directories
# install-dir (to give during install)
/ # install-dir
/ *.php # PHP-Files Enduser-Interface
/user_data.php # data for Xmail & MySQL
/root_*.php # PHP-Files Postmaster-Admin
/inc/ * # include-Files for Postmaster & Enduser-Interface
/img/ * # images
/root/ # Root-Admin
/root/ *.php # PHP-Dateien Root-Admin
/root/class* # Include-Files for Root-Interface
/root/img/ * # images
/tmp/* # tmp files used by webmail (attachements)
/autoreply/* # text-files with users vacation-messages
/README # text-documentation
/INSTALL # text-install-documentation
/LICENSE # text-gpl
License
This program is free software; you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details. You should have received a copy of the GNU General
Public License along with this program; if not, write to the
Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
For more details see: http://www.gnu.org/copyleft/gpl.html
Credits
Thanks to those people for contributing / giving inspiration to this project:
This is the description for first-time installation.