Deploy SupportPal on cPanel

Prerequisites

Before you install SupportPal, ensure your web hosting provider is compatible with our system requirements. The most notable requirement is the ionCube loader PHP extension.

If you manage the server, ensure the required extensions are installed via EasyApache in WHM.

If CloudLinux is installed, you may be able to install any required extensions in the cPanel account through the 'Select PHP Version' page.

Installation & Configuration

Download SupportPal

Download the current stable release at our downloads area (client area login required).

Upload, Extract and Set File Permissions

1. Open the File Manager.
   
2. Browse to the directory where you want to store SupportPal. Typically: public_html.
3. Click the Upload button and upload the SupportPal release.
   
4. Right click on the SupportPal release and select Extract.
   
5. Press Extract File(s).
   

Create Database

1. Visit MySQL Database Wizard from the cPanel dashboard.
   
2. Create a new database with a name of your choice:
   
3. Create a database user and remember the password for later:
   
4. Click 'All Privileges' when adding the user and click 'Next Step' to complete the wizard.
   'All Privileges' is the simplest option, but if you wish to choose only certain privileges, see the System Requirements for what is required.
   

Run Installer

1. Start the install process by visiting the URL where you have uploaded SupportPal, e.g. http://yourdomain.com/support.
2. Verify the correct version shows in the installation type and click continue.
3. Read through our EULA and accept.
4. The installer will verify if your server passes the system requirements. If anything shows a cross, please correct and retry. It's worth checking over optional requirements in case it covers a feature you'd like to use. Continue when everything required passes.
5. Enter your database details (created above).
6. Click the 'Begin' button, this will start the process of running the database migrations and seeds. This may take several minutes, wait for it to complete and then click 'Continue' once the button shows.
7. Enter your license key, and it should show a 'License Valid' below. If it doesn't, you may need to re-issue the license at our client area and then enter it again. Also fill in your operator account details and continue.
8. Enter your company information and change the locale settings as necessary and continue.
9. The installation is complete, keep a note of the operator panel login URL.

Set up Cron Job

1. The cron job is used to perform background tasks such as sending emails and closing inactive tickets. Select Cron Jobs from the dashboard.
   
2. Input your email address into the Cron Email section and click Update Email. This will notify you whenever there is a problem with the SupportPal cron job and enable you to take corrective action.
   
3. Browse down the page to Add New Cron Job. Select Once per minute from the Common Settings dropdown, and input the following into the Command box, replacing <supportpal_base_path> with your own path:

   php -q /<supportpal_base_path>/cron

   You may need to change the PHP executable, especially if your account makes use of MultiPHP, for example to /usr/local/bin/php or /usr/local/bin/ea-php72. Check the PHP command examples shown on the page.

Next Steps

Congratulations, you've successfully installed SupportPal!

We now recommend that you learn how to administer your installation.