Question 1

Installing Clientexec

Accepted Answer

This article will show you how to install Clientexec manually (without the use of a script auto-installer). Before proceeding, we recommend reviewing the System Requirements to ensure your hosting environment is fully compatible.

|| Softaculous Auto Installer: Does your server have Softaculous installed? If so, you may install Clientexec through Softaculous. Click here.

|| Installatron Auto Installer: Does your server have Installatron installed? If so, you may install Clientexec through Installatron. Click here.

Installing Clientexec

Q: System Requirements

The following are the requirements for Clientexec: | Requirement | Recommended | | -------- | -------- | | PHP Version | 7.4.x, 8.1.x - 8.2.x | | PHP Memory Limit | 128M | | PHP Extensions | GD | | | cURL | | | Multibyte String | | | PDO | | | SOAP | | | MySQLi | | | imap | | | iconv | | | SimpleXML | | MySQL Strict Mode | Disabled | | **ionCube Loader ** | 12.0 or higher (13.x for PHP 8.2+) | || Clientexec is tested to run in Linux based environments running the Apache web server. Other environments such as Windows-based configurations may work, however, you may experience compatibility issues with which our Support Team cannot assist you with.

With the System Requirements having been met, you are now ready to proceed. Installing Clientexec only takes a few steps. Let's begin:

Downloading Clientexec

You can download the latest stable version of Clientexec from the Clientexec Downloads Page. From this page, click the orange Download button.

Uploading and Extracting Clientexec

The next step is to upload the zip you have just downloaded to your web server in the directory of your choosing. You can do this using your web hosting control panels File Manager or through FTP.

Using cPanel File Manager

To upload and extract Clientexec using the cPanel File Manager, follow the steps below:

Log into your c

Question 2

System Requirements

Accepted Answer

The following are the requirements for Clientexec:

| Requirement | Recommended | | -------- | -------- | | PHP Version | 7.4.x, 8.1.x - 8.2.x | | PHP Memory Limit | 128M | | PHP Extensions | GD | | | cURL | | | Multibyte String | | | PDO | | | SOAP | | | MySQLi | | | imap | | | iconv | | | SimpleXML | | MySQL Strict Mode | Disabled | | **ionCube Loader ** | 12.0 or higher (13.x for PHP 8.2+) |

|| Clientexec is tested to run in Linux based environments running the Apache web server. Other environments such as Windows-based configurations may work, however, you may experience compatibility issues with which our Support Team cannot assist you with.

Question 3

How to import data from WHMCS

Accepted Answer

The WHMCS Importer plugin available in Clientexec helps you to import your clients, packages, invoices, tickets, and servers from a WHMCS installation.

This article will guide you on how to import that data using the importer plugin.

|| Before proceeding please generate a backup of both your WHMCS database and Clientexec database giving you the ability to revert back in the event of an issue. Also, please first make sure to set your default currency, as the imported data will use that currency.

|| The WHMCS importer has been tested with WHMCS 8.x though may be compatible with other versions.

Steps :

Before importing, please first make sure to set your default currency, as the imported data will use that currency. You can set your default currency in **Settings **> **Billing **> Currencies. Check the checkbox of the currency you want to set as default, and then press the Set Default button to save the changes. If you change this after importing, the imported data will not be updated to use that currency.
Login to your Clientexec installation, and navigate to **Setting **> **Utilities **> Import Data > WHMCS
Before proceeding please generate a backup of both your **WHMCS **database and **Clientexec **database giving you the ability to revert back in the event of an issue.
Please note that any package with "Collections" status in WHMCS will be set as "Active" status in Clientexec, and any invoice with "Collections" status in WHMCS will be

Question 4

Server Plugin Development Guide

Accepted Answer

A server plugin allows Clientexec to automatically provision and manage services.

We have created a sample server module that should be used as a starting point: https://github.com/clientexec/sample-server

Naming Convention

The name of the plugin directory MUST be all lower case, and alphanumeric, such as sample.

The name of the plugin file, and the plugin class MUST start with Plugin, followed by the name of the directory with ONLY the first letter capitalized, such as PluginSample

Features

Each server plugin can define certain features to be available or not.

**packageName **- If Clientexec should show the "Package Name On Server" option.
**testConnection **- If this plugin supports testing the server credentials (coded in the testConnection function).
**showNameservers **- If this plugin should have name servers associated with it.
**directlink **- If this plugin has a direct login link from the client side.
**upgrades **- If this plugin supports automatic upgrades and downgrades.
**publicPanels **- Any array of public panels for this plugin..

public $features = [
    'packageName' => true,
    'testConnection' => true,
    'showNameservers' => false,
    'directlink' => true,
    'upgrades' => true,
    'publicPanels' => [
        'advanced' => 'Advanced'
    ]
];

Configuration

Each server p

Question 5

Setting Up the Square Payment Plugin

Accepted Answer

In order to configure your Square Payment plugin, navigate to **Settings **> **Plugins **> Payment Processors.

Click Square Payment in the drop-down.

Supported Features:

| One-Time Payments | Recurring | Refunds | | -------- | -------- | -------- | | Yes | Yes | Yes |

If you are utilizing Square Payment, it is recommended to mark Yes next to In Signup so that your clients can pay with Square Payment during the signup and payment process.

Other Options:

| **Field Name **| **Description **| | -------- | -------- | | One-Time Payments | Select YES if you want to allow customers to make one-time payments through this payment processor. | | Available in Profile Billing Tab | This plugin is available to admins in the user's profile billing tab. | | Square Payment Application ID | Please enter your Square Payment Application ID here. | | Square Payment Location ID | Please enter your Square Payment Location ID here. | | Square Payment Access Token | Please enter your Square Payment Access Token here. | | Use Sandbox | Select YES if you want to use Square Payment's testing server, so no actual monetary transactions are made. | | Signup Name | Select the name to display in the signup process for this payment type. Example: eCheck or Credit Card.

Question 6

How to enable logging

Accepted Answer

When assisting you, Support staff may ask you to provide log files to troubleshoot a problem. Here's how you can create such logs:

In config.php, edit the following lines:

define('LOGLEVEL', 4); define('LOGTEXTFILE', '/home/user/logs/ce.log');

In our example we use 4 as the logging level, but you can put any number between 0 and 5, which have the following meanings:

No logging
Security attacks attempts, errors and important messages (recommended level)
Reserved for debugging (only logs if DEBUG is true in config.php)
Warnings and EventLogs, VIEW/ACTION and Request URIs and URI redirections and POST/COOKIE values
plugin events, curl requests, some function calls with their parameters, etc.
include suppressed actions and SMTP traffic.
Action responses (ajax,serialized,XML (as array)

Remember to put quotes around the file you specified next to LOG_TEXTFILE. You must create this file and give it writing permissions to the user under which your webserver runs. Also, don't put this file under the webserver documents root directory, as it will contain passwords and other sensitive information.

If you're trying to generate a log to send to support to help them diagnose problem, enable logging just before reproducing the problem, and then disable it just after having reproduced the problem, so the log will only show what support needs to know.

Please use log level 4 when submitting a log to staff. If you are sending a log about SMTP not working

Frequently Read Articles

Browse All Categories