What is WHMCS Auto Install Module?

Overview

This information will provide help to to setup WHMCS to auto-install scripts throughout consumer account creation. Setting this up may be very simple. This information assumes that you’ve got already put in Softaculous in your server.

Word: This works solely with cPanel, cPanel Prolonged, DirectAdmin, Plesk, Interworx, Centos Internet Panel, and Vestacp in the mean time.

Listing of Scripts

All of the scripts in Softaculous will be Auto Put in. Following is the favored checklist of scripts :

WordPress, b2evolution, StatusNet, Drupal, Mambo, phpBB, SMF, AEF, Coppermine, Gallery, Jcow, OpenClassifieds, openX, WebCalendar, Shadows Rising, phpList, SquirrelMail, LimeSurvey, Piwik, SugarCRM, PHProjekt, osCommerce, Magento, phpBook, HESK, osTicket, kPlaylist, VidiScript, Gregarius, CodeIgniter, Moodle, Elgg.

(See the primary pic to see the place it’s a must to add the names of scripts, the field outlined in pink is the place you add the checklist of scripts.)

Obtain and Add

Obtain the Auto Set up Hook right here File:Autoinstall.zip
Unzip it and add the file referred to as softaculous.php, in your /path/to/whmcs/consists of/hooks/ Listing. If you wish to debug for any errors or check the Auto Set up is working correctly please additionally add the softaculous_debug.php file in your /path/to/whmcs/consists of/hooks/ Listing. You’ll be able to take away the softaculous_debug.php file later after it really works efficiently.

If you wish to add Auto Set up for Customized Scripts then please modify softaculous_extra.php and add it as effectively. In any other case you dont have to add softaculous_extra.php

Modifying a Product/Service

Now login to your WHMCS Template Admin Panel. This information assumes you’ve already setup WHMCS to create consumer accounts mechanically. When you’ve got not already setup your server you’ll find detailed guides on the WHMCS Wiki

Setup Customized Fields

Go to Setup -> Merchandise/Companies and click on on the Edit Product Icon of the Product you want to setup Auto Set up for.

Within the Edit Product part, click on the ‘Customized Fields’ tab. Within the Customized Fields tab > Add New Customized Area.
We must add four Customized Fields.

You’ll be able to solely add 1 Customized Area at a time, so after including the primary area hit the ‘Save Modifications’ button, for the 2nd area to indicate up.

That is how we add customized fields.
See the pictures beneath for the four customized fields.

 

 

Word : You may give “None” as the primary possibility within the Listing of Scripts. If customers dont wish to set up a script when their account is created, they’ll select “None” to chorus from putting in any script.
Very Essential Word : Fill within the fields identify as per the picture solely. IF you want to modify the Area Names (e.g. “Admin Username” as a substitute of “Admin Identify”) then you will need to add the softaculous_extra.php file as effectively (it has pattern code to change the sector names).

Further Customized Fields

You too can setup extra Fields for non-compulsory parameters like “Website Identify”, “Website Description”, and many others. Proceed including the Fields that you simply want equally as you probably did above.
It’s good to make another change within the softaculous_extra.php

It’s good to create an Array $GLOBALS[‘softaculous_conf’][‘custom_fields’] add the variety of fields you wish to add on this array the important thing of the array would be the identify of the sector within the set up.xml file of the script.
For Eg: If you wish to add the Website Identify area for WordPress
1. Go to /var/softaculous/wp/set up.xml
2. Seek for the positioning identify area, you’re going to get the next code:
<enter kind="textual content" identify="site_name" dimension="30" worth="My Weblog">
</enter>

three. The important thing for $GLOBALS[‘softaculous_conf’][‘custom_fields’] would be the identify of the enter tag i.e. site_name
four. The worth for $GLOBALS[‘softaculous_conf’][‘custom_fields’] would be the Customized Area identify that you simply supplied within the WHMCS product setup on this case Website Identify.
5. The extra area is now setup.

 

Setup Module Run Time

The Softaculous Hook will run and attempt to Auto Set up the script solely when the account is being created. This feature will be discovered whereas enhancing the Product/Service in Module SettingsTab. You’ll be able to select any of the choice within the picture proven beneath. Simply keep in mind that Softaculous will create the account solely as per the tactic you choose.

 

As soon as you’re performed with the four fields, hit the Save Modifications button and you’re performed.

Testing the Setup

You’ll be able to check the setup by making a DUMMY Order and going to the settings of that order.
For debugging functions add softaculous_debug.php within the /path/to/whmcs/consists of/hooks/ Listing. Should you dont add the softaculous_debug.php no error messages shall be proven.