With our LiveConfig Hosting Modul you connect your WHMCS with your LiveConfig server. This way, orders for web hosting packages are automatically created on the LiveConfig server.
System requirements
To use the WHMCS Liveconfig Hosting Module, the following requirements must be met:
- Executable WHMCS installation version 8.3 – WHMCS 8.6
- Admin access to WHMCS
- FTP access
- installed Ioncube Loader (at least version 12)
- PHP 7.2 – 7.4 or 8.1 with SOAP
- LiveConfig server with LiveConfig Standard or Business (Basic version has no API)
- API access set up on the LiveConfig server
Installation
Module installation
- Please log into the customer area of Plambee.de Webhosting and download the current version of the LiveConfig hosting module.
- Unpack the zip.file on your computer.
- download the folder into your WHMCS directory.
- Now log into your WHMCS admin area.
- In the addon list, look for the LiveConfig Hosting module and click on “Activate” and then on “Configure”.
- In the field “Module license” please enter your license code, you can find it in the Plambee.de customer area in the product details.
- Now please specify which admin groups are allowed to access the module.
SOAP Password
In order for the module to communicate with the LiveConfig server, it is necessary to create an API password for a user. In general, according to LiveConfig, you can create an API password for each user (user != customer). The necessary commands can be found in the LiveConfig manual.
Create product
Create server
In the WHMCS backend, please go to Setup,Products/Services,Servers and create a new server there as follows.
- Name: Freely definable name
- Hostname: The hostname under which your server can be reached e.g. liveconfigpanel.mydomain.com
- IP Address: The IP address of your server
- Assigned IP Addresses: can be left blank or you can enter additional IP addresses here.
- Monthly Cost: Can be left blank
- Datacenter/NOC: Can be left blank
- Maximum No. of Accounts: Here you can enter how many accounts WHMCS should create.
- Enable/Disable: Check this box to make the server available.
- Nameservers: In this section you can enter nameservers.
- Type: In the menu Type of the server details please select the “LiveConfig Hosting Module”.
- Username: The username of the SOAP-API user.
- Password: The password of the SOAP-API user.
- Secure: Check this box to connect via HTTPS (requires an official SSL certificate for the LiveConfig panel).
- Port: By default LiveConfig runs on port 8443, if you have changed this, please activate the checkbox and enter the port.
- Test Connection: If you have entered everything, you can test the connection with this button. If you are greeted with a hello, everything is OK and you can save. If you receive an error message, please check the settings.
- Now assign the server to a server group.
If you have a multi-server environment in LiveConfig, you only need to create the main server of your network here. If you have several LiveConfig networks, you can create a server in WHMCS for each main server of the network.
Create product
In the WHMCS backend, please go to Setup,Products/Services,Products/Services and create a new hosting product. Then go to the tab “Module Settings” and select the LiveConfig Hosting Module and fill in the fields accordingly.
- Please select the server group in which the newly created server is located.
- Offer name: Please enter the name of the web hosting package that you have configured in LiveConfig with which this product is to be linked. Please make sure that the spelling is exactly the same.
- Web server: If you have a multi-server environment, please enter the server name for the web server on which the contract is to be created. If the field is left empty, localhost will be transferred.
- Mail server: If you have a multi-server environment, please enter the server name for the mail server on which the contract is to be created. If the field is left blank, localhost will be passed.
- Database server: If you have a multi-server environment, please enter the server name for the database server on which the contract is to be created. If the field is left empty, localhost will be transferred.
- Prefix: Here you can enter a prefix which will be used for the default domain, the contract name and the user name. E.g. web
- DNS-Template: If you let LiveConfig manage your name server, please enter the DNS template for the domain here.
- IP-Group: If you can assign the domain to a special IP group, please enter the name here.
- Reseller?: If it is a reseller tariff, please activate this checkbox, as resellers in LiveConfig do not have their own FTP access in this tariff, the display of the FTP access data in the customer area is deactivated.
When you have set everything, you can save the product.
Module settings
Next, please go to the module and click on Settings and specify whether a default domain should be created, the provider domain and an admin. Please also select whether the WHMCS customer number should be used for the customer created in LiveConfig or the setting in LiveConfig.
Config Options
The module also supports the WHMCS function of the Config Options, so the customers can e.g. extend individual parameters. If you do not want the customers to be able to change individual parameters, you do not need to configure Config Options, the contract will then always be created with the default values that you have stored in LiveConfig.
To create Config Options, please proceed as follows:
In the WHMCS backend, go to Setup,Products/Services, Configurable Option and create a new entry there. In the field “Group Name” enter the name, e.g. the name of the assigned product, in Description a short description and in Assigned Products the product to which these options should be assigned. After saving, you can create a new option with the button “Add new Configurable Option”. Enter the name of the option under Option Name, e.g. webspace, and the option under “Add Option”. The option can be entered in the following format VALUE|Text to be displayed, i.e. for VALUE enter the value that the module requires, e.g. 250, and for Text to be displayed enter the text that will be displayed to the customer, e.g. 250MB webspace.
Note: If you want to work with Config Options, please always create the 1st Config Options with the default value you have stored in the LiveConfig offer and set the price for this option to 0€. All other options can then be priced.
For an example, please see the image below.
The following options are available:
Option name | Example | Description | Format/Other |
webserver | localhost|Standard | If you have a multi-server environment, you can use this option to give the customer the choice of which server his website should run on. For example, you can offer different locations (Germany, France). Either localhost or the name of the server must be specified. | This option then overwrites the web server preset in the product. Option Type: Dropdown |
mailserver | localhost|Standard | If you have a multi-server environment, you can use this option to give customers the choice of which server their e-mails should run on. For example, you can offer different locations (Germany, France). Either localhost or the name of the server must be specified. | Diese Option überschreibt dann den im Produkt voreingestellten Mailservers. Option Type: Dropdown |
dbserver | localhost|Standard | Wenn Sie eine Multiserver Umgebung haben können Sie den Kunden mit dieser Option die Wahl geben auf welchem Server seine Datenbanken laufen sollen. So können Sie z.B. auch unterschiedliche Standorte (Deutschland, Frankreich) anbieten. Angegeben muss entweder localhost oder der Name des Servers. | This option then overwrites the mail server preset in the product. We recommend Dropdown as the Type option |
maxcustomers | 5|5 Clients | Maximum number of customers for resellers | Entering -1 corresponds to an unlimited number of clients |
maxusers | 5|5 User | Number of users the client may create | Must be at least 1, Entering -1 corresponds to an unlimited number of users |
webspace | 250|250 MB | Specifies how much web space the customer is allowed to have in his contract. | Entry is in MB, entry of -1 corresponds to unlimited web space |
ssi | on|No SSI | Allows the client to choose whether or not to use SSI | Option Type: YES/NO, values on or off. |
php | 0|No PHP allowed | allows the client to choose whether to use PHP and which implementation to use. | Option Type: Dropdown, 0= No PHP allowed, 1=suPHP, 2=FastCGI, 3=mod_php 4=FPM |
cgi | on|No CGI | Allows the client to choose whether or not to use CGI | Option Type: YES/NO, values on or off. |
ssl | 0|No SSL | allows the customer to choose whether SSL is available or not | Option Type: Dropdown, 0=No, 1=Yes, 2=Yes with certificate management |
cronjobs | 5|5Cronjobs | Indicates how many cronjobs are available to the client. | Option Type: Dropdown, entering -1 corresponds to an unlimited number of cronjobs |
apps | 5|5 Applications | Specifies how many apps installed by the installer the customer may use at the same time. | Option Type: Dropdown, entering -1 corresponds to an unlimited number of apps |
ftpaccounts | 5|5 FTP accesses | Specifies the maximum number of FTP accounts the client can create. | Option Type: Dropdown, entering -1 corresponds to an unlimited number of FTP accounts. |
shellaccess | 0|No shell access | Indicates if the client can access the shell | Option Type: Dropdown, 0=No, 1=scponly/sftp, 2=yes (bash) |
databases | 5|5 Databases | Indicates how many databases the client can have | Option Type: Dropdown, entering -1 corresponds to an unlimited number of databases |
subdomains | 50|50 Subdomains | Specifies how many subdomains the customer can create | Option Type: Dropdown, die Eingabe von -1 entspricht einer unbegrenzten Anzahl von Subdomains |
extdomains | 50|50 external domains | Specifies how many external domains the customer can create. | Option Type: Dropdown, entering -1 corresponds to an unlimited number of external domains |
mailboxes | 5|5 E-mail boxes | Indicates how many e-mail boxes the customer can create. | Option Type: Dropdown, the entry of -1 corresponds to an unlimited number of email mailboxes |
mailaddrs | 5|5 E-mail addresses | Indicates how many e-mail addresses the customer can create. | Option Type: Dropdown, entering -1 corresponds to an unlimited number of email addresses |
mailquota | 250|250 MB E-Mail Speicher | Indicates how much storage space is available to the customer for e-mails | Option Type: Dropdown, entering -1 corresponds to an unlimited amount of storage. Input value is MB |
traffic | 250|250 MB Traffic | Indicates how much traffic is available to the customer | Option Type: Dropdown, entering -1 corresponds to an unlimited amount of traffic. Input value is MB |
webstats | 0|keine Web statistics | Indicates which web statistics are available to the client | Option Type: Dropdown 0=none, 1=Webalizer, 2=AWStats |
memory_limit | 256m|256 MB Memory Limit | PHP Memory Limit | Option Type: Dropdown
k = Kilobyte, m=Megabyte, g=Gigabyte |
post_max_size | 30m|30 MB Post Size | Post Max Size | Option Type: Dropdown k = Kilobyte m=Megabyte g=Gigabyte |
upload_max_filesize | 30m|30 MB Upload Limit | Upload Max Filesize | Option Type: Dropdown k = Kilobyte m=Megabyte g=Gigabyte |
max_execution_time | 60|60 Seconds | MAX Execution time | Option Type: Dropdown |
It is not necessary to store all Config Options. For values for which you do not create config options (e.g. if you omit the selection of SSI), the standards of the offer configured in Liveconfig are used.
Update Notes
Update to version 1.9.0
With version 1.9.0, the global subdomain settings are transferred to the individual products. Your previous settings will be migrated. Please upload all module files and then go to the LiveConfig Hosting module to upgrade to version 1.9.0. Then configure your products first. If you configure your products first and then call up the module, your settings will be overwritten.
Update To Version 2.0.0
With version 2.0, LiveConfig version 2.8 is supported. With this version, LiveConfig has extended the API for PHP.ini values. To use this feature, additional ConfigOptions must be created, the values for which can be found in the corresponding section of the documentation.
Information on the template files
With version 1.2.0, the customer area of the module has been significantly expanded. The customer can now perform certain actions directly from your WHMCS customer area. The template files are of course individually adaptable, you can find them in the directory /modules/servers/liveconfig_hosting_mod/templates/ .
Template variables
E-Mail Template
After successful creation of the product, WHMCS can send a welcome message to the client informing them of the creation. By default, the Hosting Account Welcome Email template is used for this purpose. However, please note the following: The variable {$service_password} outputs the FTP password and the variable {$lhm_lc_pw} the password for the LiveConfig account and the variable {$service_username} outputs the contract name. If you use the customer number from LiveConfig, you can output this via the variable {$lhm_lc_kid}. As of version 1.3.0, the variable {$lhm_lc_userid} can be used to display the LiveConfig user name.
Notes
Resellerverträge
If you specify a reseller contract in the “Offer” field, no domain is transferred with the hosting contract in LiveConfig and assigned to the contract. In addition, you may only use the config option maxcustomers for reseller contracts.
manual product assignment
If you are already running a LiveConfig server and would like to manage existing contracts with WHMCS, you can link them manually from module version 1.2.0. Please proceed as follows:
- Create a product for the respective customer that corresponds to the LiveConfig package.
To do this, create an order manually in WHMCS, set the status to active and uncheck the box for sending the e-mail.
- Now go to the product in the admin area and enter the subscription, the customer number of the customer (the customer number that the customer has in LiveConfig) and the user name of the customer. The subscription corresponds to the contract name in LiveConfig, e.g. web56, and the user name corresponds to the login name that the customer enters to log in to LiveConfig.
- Now click on Save
- Now click on the button “Import Product”. By clicking on “Import Product”, the LiveConfig API is now called up with various commands to read out the necessary data. The contact ID and the customer ID are read out; these will be needed later, for example, to change the contact.
- After the successful import, the LiveConfig ContactID and LiveConfig ClientID fields are filled in.
The WHMCS product now contains all the necessary information for the client to manage their LiveConfig account via WHMCS. Please repeat this for each product.