WebMail Lite documentation

Install on cPanel

Introduction

You can easily install WebMail Lite on a cPanel server.

If you're a hosting provider and wish to offer WebMail Lite to your clients (instead of the current webmail software), follow the instructions below.

Installing through direct embedding

The installation is really simple, it is performed with the installation wizard which guides you through the entire process.

To begin, download the installer package from here. You can do that using the following command in terminal:

wget https://afterlogic.com/download/webmail-panel-installer.tar.gz

Usually, it's downloaded to /root directory or your home dir on a cPanel server. In either case, extract it to the same location:

cd ~
tar -xzvf ./webmail-panel-installer.tar.gz

To perform the installation, root access is required. Open the installer directory, make sure that install script has sufficient execute permissions and run it:

cd ./webmail-panel-installer
chmod a+x ./installer
./installer -t lite -a install

The installer downloads WebMail Lite package and performs the basic product configuration. The default installation path is /usr/local/cpanel/base/3rdparty/afterlogic.

It is assumed that this is blank installation of WebMail on particular server. In case if existing WebMail installation is found in this folder, installation will be aborted. For upgrading existing installation, a different command is required:

./installer -t lite -a upgrade

While upgrading the existing installation, only files are replaced while all data in the database are kept intact, the database structure is updated if necessary. Thus, you won't lose any existing data created by previous installations of WebMail Lite. And if you choose to remove WebMail installation, that is done with:

./installer -a remove

Troubleshooting the installation

If the following message is displayed when setting up the product:

WARNING! Database tables were not created. Try creating them from AdminPanel.

that means command-line version of PHP doesn't have PDO extension enabled, so the installer couldn't create the database tables. The issue isn't fatal though, you should still be able to create tables from Database settings screen of AdminPanel, see below on how to access it.

You might get the same message when upgrading the product installation. In that case, you need to use "Update tables" rather than "Create tables".

If you get error message of the following kind during the install:

Can't locate YAML/Syck.pm in @INC (@INC contains: /usr/local/cpanel /usr/local/lib64/perl5
/usr/local/share/perl5 /usr/lib64/perl5/vendor_perl /usr/share/perl5/vendor_perl /usr/lib64/perl5 /usr/share/perl5
.) at /usr/local/cpanel/Cpanel/CPAN/YAML/Syck.pm line 8.
BEGIN failed--compilation aborted at /usr/local/cpanel/Cpanel/CPAN/YAML/Syck.pm line 8.
Compilation failed in require at /usr/local/cpanel/Cpanel/DataStore.pm line 19.
FAILED!

It means your cPanel installation is not configured for installing third-party modules yet. You can fix that by running the following commands:

perl -MCPAN -e shell
install YAML::Syck
exit

Then, unistall WebMail and try installing it again.

If you encounter problem with attaching files, that's typically caused by insufficient permissions, see cPanel-related part of attachments troubleshooting page.

Accessing WebMail and AdminPanel

Once the installation is complete, WebMail Lite can be accessed at http://domain.com/webmail/. Here, domain.com stands for any domain name hosted by the server (IP address can be used instead). Any customer can access WebMail Lite by adding /webmail/ to their domains. Once logged in, user will get full list of available webmail clients:

Note that you'll need email address created in cPanel to check mail, and you'll also need it to configure the product. To fine-tune WebMail Lite installation, first log in webmail screen as shown above, and then log in AdminPanel at the URL of the following kind:

http://domain.com:2095/3rdparty/afterlogic/adminpanel/index.php

or

https://domain.com:2096/3rdparty/afterlogic/adminpanel/index.php

where domain.com can be any domain hosted by this cPanel server. Default AdminPanel credentials supplied by the installer are mailadm/12345 for username and password respectively.

Once again, you need to be logged into email account to be able to access AdminPanel. The simplest way to do that is to enter WebMail Lite first, and then modify the URL. Remove everything after /3rdparty/afterlogic/ in the URL and add adminpanel/index.php to it.

Once entered the AdminPanel, you can change the default password for AdminPanel access, and configure the product in any other way you like. This is, however, optional, as the installer sets up the product to the fully operational state.

Alternative installation method

In some cases, using cPanel installer for AfterLogic WebMail might not be suitable: for example, if you don't have root access to the system, or you want to use native login screen of WebMail rather than one offered by cPanel.

The alternative solution is to install a regular package of WebMail Lite. This is done in exactly the same way you would do with any other PHP application: upload it to web directory of a particular domain, setup access permissions, configure the database, etc. You will also be able to use built-in installation wizard of WebMail Lite available at URL of the following kind: http://www.yourdomain.com/mail/install/ (note that /webmail/ directory name is reserved by cPanel itself so you can't use that, but something like /email/, /mail/, /afterlogic/ etc. would work just fine).

And even though WebMail Lite is installed under a specific domain in this scenario, it is still possible to access any email account hosted by that cPanel server.