The Installation Process

This guide goes through the process of installing arpReach on a standard cPanel hosting. Examples include HostGator, Liquid Web, Just Host, and thousands of others.

In this section:

  1. Setting up your database
  2. Getting ready to install arpReach
  3. Upload the files
  4. Run the installation wizard
  5. Run arpReach for the first time
  6. Activate arpReach
  7. Create the scheduled task
  8. Handling the incoming email task

Setting up your database

arpReach software requires one MySQL database which you will need to create manually using the method supplied by your web hosting provider.

Make a note of the following settings of the new database in a text document which you will reference in a later part of the installation process:

host 

database name

username 

password
Useful Links

Creating and selecting a database using the command line
Creating a database using cPanel
Creating a database using DirectAdmin

Getting ready to install arpReach

Login to the download area using the username and password provided in your order email.

Download the latest zipped release version of arpReach and save it to a folder on your computer.

download software

Read and accept the usage terms.

agree to eula

The system will build your download and then present an OK button.

building licensed download

Click OK to begin your download and save the zip file to a location you can access on your computer

click ok to download

Unzip the ZIP file you downloaded to a temporary directory on your local computer preserving the directory structure. (See useful resources below for software if required.)

Open the file config.inc.php. Important Note: You must use a text editor such as NotePad and not a word-processor like MS Word.)

Enter the config settings shown and save the file. The database settings are those you used when creating the MySQL database.

Now rename the file to config.php.

Useful Resources

7-Zip – An open source utility for manipulating archives. Formats 7z, ZIP, GZIP, BZIP2 and TAR are supported fully, other formats can be unpacked.
Keka – A free Mac utility for manipulating archive files. Extraction formats supported: RAR, 7z, Lzma, xz, Zip, Tar, Gzip, Bzip2, ISO, EXE, CAB, PAX, ACE (PPC)

Upload the files

On your website, create a directory where you want to install the software. Alternatively, create a sub-domain.

Examples:

example.com/<dir>

… where <dir> is the directory you create for the software to be installed.

If you opt to create a sub-domain, the format will be:

<sd>.example.com

… where <sd> is the sub-domain you create.

Using an FTP software, upload the contents of your temporary directory on your computer to the directory you created on your website.

Important Note: Files must be uploaded in Binary mode.

The following directories need to be writable (Linux chmod 777) by the web process. Use your FTP software to set this.

schedule_logs
 schedule_errors
 temp
Useful resources:

FileZilla: FileZilla is open source FTP (File Transfer) software distributed free of charge under the terms of the GNU General Public License

Run the installation wizard

In your browser, run the installation wizard using:

example.com/<dir>/install/index.php

… where <dir> is the directory you created for the software.

If you opted to create a sub-domain, the format will be:

<sd>.example.com/install/index.php

… where <sd> is the sub-domain you created.

The installation wizard will step you through the process. Any errors will be explained and solutions suggested.

As a security measure delete the /install directory and all of the files in it once you have completed installing arpReach.

Run the software

When installation is complete, you can run the software for the first time by visiting:

 example.com/<dir>/a.php

… or:

<sd>.example.com/a.php

Running the software for the first time creates a new administrator whose sign-in details are:

Username: admin
Password: 12345

Once logged in you will see these warning messages at the top of your screen.

Initial warning messages

You should change these initial log in username and password settings as soon as you can by visiting the Setup / Personal Settings menu option. There you can also set other options to personalize your session.

Activate your software

If you need to activate your software, you will be taken to the activation screen when you sign in or you can visit:

Setup / Activate License

Please refer to the full process for generating your activation code.

Enter the license number, license password, and activation code you have been given, check the box to agree to the terms of use, and click Activate Now.

license activation screen

Your software is now activated.

At any time, you can obtain an activation code for your software from the arpReach Hub:

https://hub.arpreach.net/

Create the scheduled task

The software requires one scheduled (cron on Linux) task to be created in your domain’s control panel. We recommend running it every 5 minutes.

The scheduled task takes care of many operations of the software, including sending due email and managing incoming subscriptions and bounces.

Your web host can advise on how scheduled tasks should be set up on your hosting. The scheduled task should NOT be set up using wget or any other HTTP or web based process as timeouts will be a problem.

“Contact your host if you need assistance with setting up your scheduled task as servers vary widely”

It must be set up by running the script directly using “command line” PHP like this:

php /path/to/public_html/<dir>/a.php cli/auto>/dev/null 2>&1

Important Note: php will usually be php-cli on a cPanel/WHM server. You should also be aware that the command line will vary from server to server and you should ask your hosting company for and use the correct path to PHP for your server.

Handling incoming email

The software needs to be able to handle incoming email to manage emailed subscriptions, unsubscriptions and bounces.

The best way to handle this is to create an email account on your domain for the exclusive use of the software.

You can usually do this in your hosting control panel.

At the same time set the “default” or “catch-all” address of your domain to forward unrouted email to this account.

“Check out the Help menu in the software for extensive support resources”

The software will monitor this account for emailed subscriptions and bounces. To set this up …

In the software, visit:

Setup / System Settings

Go into the System tab and open the Incoming email section.

Enter the details for the email account you created to handle incoming email.

Now, each time the scheduled task runs, all of the email in the email account will be read, processed and deleted.

Installation is complete

arpReach is now installed and ready for use.

Test mode

Test mode allows you to use all aspects of the software without any email actually being sent although the software will act as if it has sent it.

To enable test mode, visit:

Setup / System Settings

… go to the System tab and expand the Outgoing Email section.