{"id":2073,"date":"2019-01-01T12:03:35","date_gmt":"2019-01-01T12:03:35","guid":{"rendered":"http:\/\/www.softaculous.com\/blog\/?post_type=docs&p=2073"},"modified":"2025-09-09T06:09:52","modified_gmt":"2025-09-09T06:09:52","slug":"whmcs-auto-install-module","status":"publish","type":"docs","link":"https:\/\/www.softaculous.com\/blog\/docs\/developers\/whmcs\/whmcs-auto-install-module\/","title":{"rendered":"WHMCS Auto Install Module"},"content":{"rendered":"\n

Overview<\/h3>\n\n\n\n

This guide will help you to setup WHMCS to auto-install scripts during user account creation. Setting this up is very easy. This guide assumes that you have already installed Softaculous on your server.<\/p>\n\n\n\n

Note<\/strong>: This works only with Webuzo, cPanel, cPanel Extended, DirectAdmin, Plesk, Interworx, VestaCP, ISPmanager and CWP at the moment.<\/p>\n\n\n\n

List of Scripts<\/h3>\n\n\n\n

All the scripts in Softaculous can be Auto Installed. Following is the popular list of scripts :<\/strong><\/p>\n\n\n\n

WordPress, Joomla, Drupal, phpBB, SMF, Gallery, Magento, osTicket, CodeIgniter, Moodle, Elgg.<\/em><\/p>\n\n\n\n

(See the first pic to see where you have to add the names of scripts, the box outlined in red is where you add the list of scripts.)<\/p>\n\n\n\n

Download and Upload<\/h3>\n\n\n\n

Download the Auto Installation Hook here\u00a0File:Autoinstall.zip<\/a>
Unzip it and upload the file called\u00a0softaculous.php<\/strong>, in your \/path\/to\/whmcs\/includes\/hooks\/ Directory. If you want to debug for any errors or test the Auto Install is working properly please also upload the\u00a0softaculous_debug.php<\/strong>\u00a0file in your \/path\/to\/whmcs\/includes\/hooks\/ Directory. You can remove the\u00a0softaculous_debug.php<\/strong>\u00a0file later after it works successfully.<\/p>\n\n\n\n

If you want to add Auto Installation for Custom Scripts then please modify softaculous_extra.php<\/strong> and upload it as well. Otherwise you dont need to upload softaculous_extra.php<\/p>\n\n\n\n

Editing a Product\/Service<\/h3>\n\n\n\n

Now login to your WHMCS Admin Panel. This guide assumes you have already setup WHMCS to create user accounts automatically. If you have not already setup your server you can find detailed guides on the WHMCS Docs<\/a><\/p>\n\n\n\n

Setup Custom Fields<\/h4>\n\n\n\n

Go to Setup -> Products\/Services and click on the Edit Product Icon of the Product you wish to setup Auto Installation for.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

In the Edit Product section, click the ‘Custom Fields’ tab. In the Custom Fields tab > Add New Custom Field.
We will have to add 4 Custom Fields.<\/p>\n\n\n\n

You can only add 1 Custom Field at a time, so after adding the first field hit the ‘Save Changes’ button, for the 2nd field to show up.<\/p>\n\n\n\n

This is how we add custom fields.
See the images below for the 4 custom fields.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

Note<\/strong> : You can give “None” as the first option in the List of Scripts. If users dont want to install a script when their account is created, they can choose “None” to refrain from installing any script.
Very Important Note<\/strong> : Fill in the fields name as per the image only. IF<\/strong> you wish to modify the Field Names (e.g. “Admin Username” instead of “Admin Name”) then you must upload the softaculous_extra.php file as well (it has sample code to modify the field names).<\/p>\n\n\n\n

Additional Custom Fields<\/h4>\n\n\n\n

You can also setup additional Fields for optional parameters like “Site Name”, “Site Description”, etc. Continue adding the Fields that you wish similarly as you did above. 
You need to make one more change in the softaculous_extra.php<\/p>\n\n\n\n

You need to create an Array $GLOBALS[‘softaculous_conf’][‘custom_fields’]<\/strong> add the number of fields you want to add in this array the key of the array will be the name of the field in the install.xml<\/strong> file of the script.
For Eg: If you want to add the Site Name<\/strong> field for WordPress 
1. Go to \/var\/softaculous\/wp\/install.xml<\/strong>
2. Search for the site name field, you will get the following code:
<input type=\"text\" name=\"site_name\" size=\"30\" value=\"My Blog\">
<\/input><\/code>
3. The key for $GLOBALS[‘softaculous_conf’][‘custom_fields’]<\/strong> will be the name of the input tag i.e. site_name<\/strong>
4. The value for $GLOBALS[‘softaculous_conf’][‘custom_fields’]<\/strong> will be the Custom Field name that you provided in the WHMCS product setup in this case Site Name<\/strong>.
5. The additional field is now setup.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Setup Module Run Time<\/h4>\n\n\n\n

The Softaculous Hook will run and try to Auto Install the script only when the account is being created. This option can be found while editing the Product\/Service in Module Settings<\/strong> Tab. You can choose any of the option in the image shown below. Just remember that Softaculous will create the account only as per the method you select.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Once you are done with the 4 fields, hit the Save Changes<\/strong> button and you are done.<\/p>\n\n\n\n

Testing the Setup<\/h3>\n\n\n\n

You can test the setup by making a DUMMY Order and going to the settings of that order.
For debugging purposes upload softaculous_debug.php<\/strong> in the \/path\/to\/whmcs\/includes\/hooks\/ Directory. If you dont upload the softaculous_debug.php<\/strong> no error messages will be shown.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Creating Account<\/h4>\n\n\n\n

Make sure the Admin Name<\/strong> and Admin Pass<\/strong> are setup and the desired script is selected e.g. WordPress<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Then click on the Create<\/strong> button to create the account on the server.
You will see a Box shown in the following image<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Success Message<\/h4>\n\n\n\n

When the page reloads (assuming debugging is enabled) the following message will be shown in case of success :<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Error Message<\/h4>\n\n\n\n

Incase of Failure errors will be shown (assuming debugging is enabled).<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

There could be several reasons for the Hook Not to work :<\/p>\n\n\n\n