Difference between revisions of "Addon Modules Management"
From WHMCS Documentation
| Line 1: | Line 1: | ||
| − | Addon modules | + | Addon modules allow developers to extend the functionality of WHMCS further including new pages in the admin or client areas. |
| − | + | A range of addons can be found in our Marketplace at https://marketplace.whmcs.com which contains both free and commercial addons from WHMCS and third party developers. Once you have downloaded or purchased addons these can then be installed within your WHMCS. | |
| − | |||
| − | |||
| − | |||
Documentation for creating an addon module can be found at [[Addon Modules]] | Documentation for creating an addon module can be found at [[Addon Modules]] | ||
| − | + | ===Installing An Addon=== | |
| − | == | + | # To install a new addon to WHMCS it will first need to be uploaded to your WHMCS installation. Unzip and upload the addon files to the '''/modules/addons''' directory within your installation location. Once uploaded the addon will be available within your admin area. |
| − | + | # Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules''', and the addon you have uploaded will be listed. | |
| − | + | # Click '''Activate''' next to the addon you wish to enable. The addon is now active within your WHMCS. | |
| − | + | # Click '''Configure''' and select which administrator roles you wish to have access to the addon by enabling them under the '''Access Control''' section. Some addons will also have additional options specific to the addon module. | |
| − | + | # The addon will now appear under the '''Addons''' option in the top menu. | |
| − | + | ===Removing An Addon=== | |
| − | ==Removing Addon | + | # Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. |
| − | + | # Deactivate the required addon by clicking the '''Deactivate''' button | |
| − | + | # You can now delete the directory for the addon within '''/modules/addons''' | |
| − | |||
<div class="docs-alert-danger"> | <div class="docs-alert-danger"> | ||
| − | <span class="title">Note</span><br /> | + | <span class="title">Please Note</span><br /> |
| − | Disabling an Addon Module may delete data from database | + | Disabling an Addon Module may delete data relevant to the addon from the database. |
</div> | </div> | ||
| + | ===Troubleshooting=== | ||
| + | ====Oops Error==== | ||
| + | An Oops Error Message is shown when visiting '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. This can be caused by an incompatible module. Please follow our guide on blank/oops pages to obtain the full error - https://help.whmcs.com/m/troubleshooting/l/678235-troubleshooting-a-blank-page-oops-error-message. | ||
| + | The error will reference the addon module that is causing the failure. Once you know the affected addon you can remove the addon files from '''/modules/addons''' or obtain an updated version of the addon from the developer. | ||
| + | ====Addon does not appear in menu==== | ||
| + | Ensure that you have selected the administrator roles you wish to have access as outlined in step 4 of '''Installing An Addon''' above. | ||
Revision as of 15:47, 22 September 2020
Addon modules allow developers to extend the functionality of WHMCS further including new pages in the admin or client areas. A range of addons can be found in our Marketplace at https://marketplace.whmcs.com which contains both free and commercial addons from WHMCS and third party developers. Once you have downloaded or purchased addons these can then be installed within your WHMCS.
Documentation for creating an addon module can be found at Addon Modules
Contents
Installing An Addon
- To install a new addon to WHMCS it will first need to be uploaded to your WHMCS installation. Unzip and upload the addon files to the /modules/addons directory within your installation location. Once uploaded the addon will be available within your admin area.
- Navigate to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules, and the addon you have uploaded will be listed.
- Click Activate next to the addon you wish to enable. The addon is now active within your WHMCS.
- Click Configure and select which administrator roles you wish to have access to the addon by enabling them under the Access Control section. Some addons will also have additional options specific to the addon module.
- The addon will now appear under the Addons option in the top menu.
Removing An Addon
- Navigate to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
- Deactivate the required addon by clicking the Deactivate button
- You can now delete the directory for the addon within /modules/addons
Please Note
Disabling an Addon Module may delete data relevant to the addon from the database.
Troubleshooting
Oops Error
An Oops Error Message is shown when visiting Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules. This can be caused by an incompatible module. Please follow our guide on blank/oops pages to obtain the full error - https://help.whmcs.com/m/troubleshooting/l/678235-troubleshooting-a-blank-page-oops-error-message. The error will reference the addon module that is causing the failure. Once you know the affected addon you can remove the addon files from /modules/addons or obtain an updated version of the addon from the developer.
Ensure that you have selected the administrator roles you wish to have access as outlined in step 4 of Installing An Addon above.