Installation
From Emailworks Wiki / Documentation
Contents |
Before You Install
Before started to install Emailworks Maillist Manager, we strongly recommend you to read Where to Start? article. It will give you an idea about hosting environment and how to start installing Emailworks Maillist Manager on your server.
Hosting Emailworks Maillist Manager
Most hosting providers and personal installations on Unix/Linux systems should be able to host Emailworks Maillist Manager under very common configurations. However, you shouldn't forget that running Emailworks Maillist Manager (or any other email marketing software) on a shared hosting will cause you email delivery issues unless you use a third party SMTP server such as smtp.com
Installing Emailworks Maillist Manager
Step 1: Download Latest Emailworks Maillist Manager Version
Login to your client area and download latest Emailworks Maillist Manager version from "Downloads" section. There are two types of Emailworks Maillist Manager package. Zend and Ioncube packages. Based on your server settings, you may prefer downloading Zend encoded Emailworks Maillist Manager package or Ioncube encoded Emailworks Maillist Manager package.
After downloading the ZIP file, download your license.dat file as well. License.dat file can be generated by submitting the domain that you are going install and use Emailworks Maillist Manager.
- Create a directory on your computer and move the downloaded ZIP file inside this directory
- Unzip the ZIP package inside the directory
- Copy the downloaded license.dat file inside the /data/ directory
Ioncube If you are going to use ioncube version, be sure that your PHP is set to run ioncube encoded files. Ioncube loader files can be downloaded from http://www.ioncube.com/loaders.php page. It's free to download. You can use the PHP script file which is included in download packages for testing the installation of ioncube on your server.
Zend Emailworks Maillist Manager is compiled with Zend Guard 5.0+. You will need Zend Optimizer 3.3 or higher on your server in order to install Emailworks Maillist Manager zend version.
Step 2: Database
Go to your MySQL database administration panel (most hosting providers use phpMyAdmin for managing your database) and create a new database. If you have only one database and it is already in use, you can still install Emailworks Maillist Manager in it. Emailworks Maillist Manager database tables are separated with "Emailworks_" prefix.
IMPORTANT: Emailworks Maillist Manager is not compatible with STRICT_MODE MySQL configuration. This option is disabled by default on MySQL servers but it might have been enabled for your server. If it is enabled, simply contact your server administrator or edit MySQL configuration file to remove STRICT_MODE from sql_mode parameter in MySQL configuration file.
Step 3: Uploading Files
Now, you will decide where to use Emailworks Maillist Manager on your web site. It can be;
- sub-directory (http://yoursite.com/Emailworks Maillist Manager/)
- root directory (http://yoursite.com/)
- sub-domain (http://Emailworks.yoursite.com/)
Once you decided the location, open your FTP client and upload all Emailworks Maillist Manager files and directories to the location on your server. This process may take a while depending on your internet connection speed.
Important: If you are going to upload Zend package of Emailworks Maillist Manager, set your FTP client to upload files in BINARY format. Otherwise, Zend encoded PHP files may get corrupted during the transfer.
Step 4: Setting Up File Permissions
Once upload process is completed, you will need to change file and directory permissions for the following:
- [install_path]/data (including all directories and files inside this directory)
This can be done via your FTP client by setting up directory and file permissions to 0777. If you prefer SSH, just execute the following command in your SSH connection:
chmod -R 0777 /path/to/Emailworks Maillist Manager/data
Step 5: Run the Install Utility
Point your web browser to http://yoursite.com/path/to/Emailworks Maillist Manager/install/
Following screen shots show the installation progress. It will take only a minute if you have configured your server properly before installation:
In the above screen you will see License details such as type, users, expiry date etc and some other fields to fill in
- Application path
- Type the path where Emailworks Maillist Manager is uploaded – the full path must be entered
- Example: /home/octeth/www/Emailworks Maillist Manager
- Application URL
- Type the URL of your Emailworks Maillist Manager
- Example: http://www.domain.com/Emailworks Maillist Manager
- MySQL Host
- Type in the host name of the MySQL if it is different than “localhost”
- MySQL Username
- Type in the username which is used to access MySQL Database
- MySQL Password
- Type in the password for the MySQL username you entered
- MySQL Database
- Type in the name of the MySQL Database you are going to use for Emailworks Maillist Manager
- Name
- Type in the name of the person who will be administrating the whole system
- Email Address
- Type in the valid Email address
- Username
- Type in the preferred administrative username
- Password
- Type in the preferred password for the administrative username
The above screen will be displayed after the installation is completed successfully. You can make the note of your Administration Area as well User Area.
Administration Area is to set the options of the overall system and User Area is used to create mailing lists, import subscribers and launch campaigns based on the access levels the user has.
WARNING: Once installation of Emailworks Maillist Manager is completed, please delete “install” directory.
Step 6: Setting CRON Jobs (Scheduled Tasks)
CRON Jobs (Scheduled Tasks in Windows) are used to trigger certain commands periodically. Emailworks Maillist Manager uses cron jobs extensively to automate some processes such as email sending, auto responder sending and list synchronization.
There six CRON jobs to be set for Emailworks Maillist Manager:
- Auto Responder Send Engine (transactional_send.php or web_transactional_send.php)
- Email Send Engine (send.php or web_send.php)
- List Synchronization (sync.php or web_sync.php)
- Bounce processing (pop3_bounce.php)
- SPAM complaint processing (pop3_fbl.php)
- Subscriber request processing (pop3_requests.php)
Setting up cron jobs vary based on your operating system. In this guide, we will explain how to set cron jobs for Linux and Windows operating systems. Please contact your hosting provider to learn more about how to set it on your own hosting environment.
Common Installation Problems
The following are some of the most common problems that are noticed during installation. For more information and troubleshooting with your Emailworks Maillist Manager installation, get in touch with us.
Install utility is displaying warnings about my server settings
Emailworks Maillist Manager will check your PHP settings to see if it can run without any problems or not. If a setting is not compatible with Emailworks Maillist Manager, it will display you a warning message and description of the problem. You may solve these issues by changing your PHP settings or contacting your hosting provider.
I am receiving MySQL errors
Be sure that your MySQL version is v4.11 or higher. Older MySQL versions are not compatible with Emailworks Maillist Manager.
Install utility displays warning message about file permissions
Be sure that you have set file and directory permissions for the listed files and directories above. If not, login to your server with FTP or SSH client and set permissions again for the listed files and/or directories.
What's the Next?
Congratulations! Emailworks Maillist Manager is now installed on your server and ready to be configured. Proceed with Setting Up Your Emailworks Maillist Manager guide to learn more about configuring your Emailworks Maillist Manager.
