📘 Oempro Installation (v4.7.0 or older)

Oempro is a leading PHP based Enterprise Grade Email Marketing solution – which can be used by small and medium sized companies as well the ESP (Email Service Provider) edition can be used for large providers wanting to start their own Email Marketing Services business.

Oempro also provides a robust api which can be used to perform many backend functions to create users, campaigns, mailing lists etc. The next topic is the installation plan and we will create a check list and take a look at the pre-requisites required for the Oempro installation.

Installation Plan

These steps should be followed to install Oempro on your server:

  1. Check server settings
  2. Download the Oempro package from the client area
  3. Download the license key from the client area (license.dat)
  4. Unzip the Oempro package
  5. Upload Oempro files to your server
  6. Setup directory and file permissions
  7. Prepare the MySQL database
  8. Run the web based installation utility

System Requirements

We have tried our best to make Oempro work on all kinds of platforms. We have listed out the default settings required for Oempro installation to function properly. If your server meets the following requirements (most of them are default settings), Oempro will run on your server:

Server Side Requirements

Server
Linux/Unix, Windows or Mac OS X

Web Server
Apache, Microsoft IIS or any similar web server

PHP Version
PHP v5.1 or above with Ioncube Loaders

PHP Extensions
imap extension — for POP3 bounce processing
curl extension — for remote content fetching

PHP Settings
safe_mode — should be turned OFF
magic_quotes_gpc — should be turned OFF
register_globals — should be turned OFF

Database
MySQL v4.11 or above (v5 or higher suggested)
CRON/Scheduled Tasks

In order to allow Oempro to handle the email delivery, auto responders and bounce handling for you, you will need to setup cron jobs (default) or scheduled tasks in Windows (default)

Client Side Requirements

Web Browser
Firefox 2+, Safari 3+, Internet Explorer 7+

In order to allow Oempro to handle the email delivery, auto responders and bounce handling for you, you will need to setup cron jobs (default) or scheduled tasks in Windows (default)

Check Server Settings

Be sure that your server meets the listed server requirements.

If you are not sure about your server settings, feel free to get in touch with our support team. Please visit the client area and click Open Support Ticket link on the left menu.

If some components are missing or there’s an incompatibility with your server settings, you may contact your server administrator and request assistance.

Download The Oempro Package From The Client Area

After your purchase gets completed, you will receive an order confirmation email from us. This email contains link to your client area and username/password information to login.

Once you are logged into the client area, you can download your purchased products with a single click.

If you have forgotten (or don’t know) your client area login information, simply click Forgot Password link on the client area login screen and enter the email address you have submitted while purchasing.

Here’s a screen shot of the client area welcome page which allows you to download purchased products with a single-click:

Unzip The Oempro Package

All packages are available for download in ZIP format in the client area. You will need unzip application to unzip the downloaded package.

Most recent operating systems (Mac OS X, Windows, Linux, etc.) comes with a built-in unzip tool.

  • Create a directory on your computer and move the downloaded ZIP file inside this directory
  • Unzip the ZIP package inside the directory

Upload Oempro Files To Your Server

Now, you need to decide where to install Oempro on your web site. It can be one of the following:

Once you decide the location, open your FTP client and upload all Oempro files and directories to the location on your server. This process may take a while depending on your internet connection speed.

Upload the license.dat to your [install_path]/data directory.

Setup Directory And 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 on your SSH Terminal:

chmod -R 0777 /path/to/oempro/data

Prepare The MySQL Database

Oempro needs a MySQL database to store its data such as users, campaigns and subscribers. You can either use your existing MySQL database or create a dedicated MySQL database for Oempro on your server.

Oempro database tables are prefixed with “oempro_”. Therefore, there will be no chance to conflict with any other existing table in your database.

Oempro 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

Run The Web Based Installation Utility

Point your web browser to http://yoursite.com/oempro/install/

It’s assumed that Oempro is being installed on http://yourdomain.com/oempro/ address. Please change it according to your own uploaded directory and URL.

Following screen shots show the installation progress. It will take only a minute if you have configured your server properly before installation:

Installation Options

Fields Explained
Application Path
Type the path where Oempro is uploaded – the full path must be entered. Be sure that there’s no ending slash. Example: /home/octeth/www/oempro
Application URL
Type the URL of your Oempro. Be sure that there’s no ending slash. Example: http://www.domain.com/oempro
MySQL Host
Type in the host name (or IP address) of your MySQL server 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 Oempro
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

Once the installation is over you will see the installation completed screen as shown in the below screenshot. Please make sure that you remove the install directory once the installation is completed.

Friendly URL’s

Friendly URLs allow you and your users to use Oempro with nice and clean URLs. By default, Oempro admin and user area URLs are like below:

http://yourwebsite.com/app/index.php/admin/ or http://yourwebsie.com/app/index.php/user/

When you enable friendly URL’s the links will look like:

http://yourwebsite.com/app/admin/ or http://yourwebsie.com/app/user/

To enable this you will need to follow the steps below.

  • Make sure that you have URL rewriting enabled within your Apache. [if its not talk to your hosting provider]
  • Set HTACCESS_ENABLED configuration option to TRUE in /oempro_path/data/config.inc.php file.
  • Rename htaccess file to .htaccess in oempro_path/app/ directory.

​Scheduled Tasks Setup

CRON Jobs (Scheduled Tasks in Windows) are used to trigger certain commands periodically. Oempro uses cron jobs extensively to automate some processes such as email sending, auto responder sending and list synchronization.

This guide will describe how to setup both CRON (in *nix/Mac OS X/Linux) and Scheduled Tasks (in Windows) step by step.

Oempro comes with 4 main cron modules.

  1. General processes
  2. Email campaign send engine
  3. Auto responder send engine
  4. List synchronization

If you are going to use the pop3 method for bounce, spam complaints and email request processing you will also have to add bounce, spam and request processing modules to the cron as well.

  • Bounce handling (POP3 method)
  • SPAM complaint handling (POP3 method)
  • Email request handling (POP3 method)

Each periodical process in Oempro has been separated into different CRON job commands to maximize the performance and avoid the waiting time until one process gets completed.

Oempro CRON and email piping methods (described in the next chapter) are located under [installation_path]/oempro/cli/ directory:

……

The above screen shows that there are many files under “cli” directory. We will explain each file later on in this chapter.

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.

How To Setup CRON Jobs? (*nix, Mac OS X, Linux)

There are two methods for setting up CRONs in Oempro. You need to select the appropriate method based on your server configuration:

  • Command line CRON modules
    This method needs SSH/Telnet access to your server and execute
  • Regular CRON modules
    This method is easier to setup and more compatible with wide range of server (and hosting) types

Command Line CRON Modules
Command line compatible cron jobs are located under [oempro directory]/cli/. These CRON modules must be executed with the PHP interpreter on your server:

Type the following command to edit the existing CRON jobs.

$ crontab –e

Add the following new CRON jobs:

          • php -d safe_mode=off -f /path/to/oempro/cli/send.php >/dev/null
          • php -d safe_mode=off -f /path/to/oempro/cli/sync.php >/dev/null
          • php -d safe_mode=off -f /path/to/oempro/cli/transactional_send.php >/dev/null
          • php -d safe_mode=off -f /path/to/oempro/cli/general.php >/dev/null

Now Save the file and crontab should report – Installing New Crontab

Regular CRON Modules
Web browser compatible cron jobs are located under [oempro_directory]/cli/ and they start with “web_” and “pop3_” prefix:

  • web_send.php
  • web_sync.php
  • web_transactional_send.php
  • web_general.php
  • pop3_bounce.php
  • pop3_fbl.php
  • pop3_requests.php

These CRON jobs must be executed with a web browser (Firefox, Internet Explorer, Safari, etc.) or a command line based browser such as (wget or curl). We suggest using these modules if you are unable to execute command line compatible CRON jobs. They are less affected by your web server configuration and limits.

In order to setup these cron jobs on your web server, login to your server via telnet or SSH and follow these steps:

  1. pe the following command to edit the existing CRON jobs.crontab –e

  2. Add the following new CRON jobs:* * * * * curl -s http://yoursite.com/oempro/cli/web_send.php >/dev/null

  3. * * * * curl -s http://yoursite.com/oempro/cli/web_sync.php >/dev/null

  4. * * * * curl -s http://yoursite.com/oempro/cli/web_transactional_send.php >/dev/null

  5. * * * * curl -s http://yoursite.com/oempro/cli/web_general.php >/dev/null

  6. * * * * curl -s http://yoursite.com/oempro/cli/pop3_bounce.php >/dev/null

  7. * * * * curl -s http://yoursite.com/oempro/cli/pop3_fbl.php >/dev/null

  8. * * * * curl -s http://yoursite.com/oempro/cli/pop3_requests.php >/dev/null

  9. Now Save the file and crontab should report – Installing New Crontab

That’s it – you are done with the CRON setup and the server will execute the three jobs every minute.

How To Setup Scheduled Tasks? (Windows)

The following procedure explains how to setup scheduled tasks for Oempro scheduled tasks in Microsoft Windows operating system.

The scheduled tasks that we will setup will execute the wget command to load Oempro scheduled task modules. The wget command is not available in the default installation of Windows operating system. Therefore, you will need to download wget application and install it before setting up scheduled tasks in Windows.

Downloading and Installing wget

  1. Go to http://xoomer.alice.it/hherold and download wget application for Microsoft Windows
  2. Copy all DLL files to your C:\WINDOWS\system32 directory
  3. Copy wget.exe file to C:\WINDOWS\ directory

There are several wget binaries for Windows. You can select another one by making a search on Google:

http://www.google.com.tr/search?q=wget+windows

Setting Up Scheduled Tasks

  1. Open the Start Menu and click on Control Panel
  2. From the Control Panel, open up Scheduled Tasks
  3. Right click in space
  4. Select New, followed by Scheduled Task
  5. We will name the task as “Oempro Send Engine”
  6. The command we want the scheduled task to run is:
    C:\WINDOWS\wget.exe -q -O NUL http://yoursite.com/oempro/cli/web_send.php
  7. Ensure that the Enabled box is checked
  8. Switch to Schedule tab
  9. Schedule the task to run every minute
  10. Save the task

Repeat this process for the following scheduled tasks:

What Happens If There’s No CRON Support On The Server?

If you don’t have CRON support on your server or don’t know how to set it, you can use an online service http://www.webbasedcron.com/ to execute your cron jobs.