90 lines
3.6 KiB
Markdown
90 lines
3.6 KiB
Markdown
# VirtFusion Direct Provisioning Module for WHMCS
|
|
|
|
[](https://github.com/EZSCALE/virtfusion-whmcs-module/actions)
|
|
|
|
|
|
|
|
|
|
This module requires VirtFusion v1.7.3 or higher as this is what it's based on. Please refer to the
|
|
official [documentation](https://docs.virtfusion.com/integrations/whmcs).
|
|
|
|
## Installation
|
|
|
|
1. Download the latest release from the [releases](https://github.com/EZSCALE/virtfusion-whmcs-module/releases) page.
|
|
2. Extract the contents of the archive and upload the modules folder to your WHMCS installation directory.
|
|
|
|
## :heavy_exclamation_mark: Important Notes :heavy_exclamation_mark:
|
|
|
|
You must create two custom fields in WHMCS for this module to work. You need to configure the following custom fields on
|
|
each product you want to use this module with.
|
|
|
|
| Field Name | Field Type | Description | Validation | Select Options | Admin Only | Required Field | Show on Order Form | Show on Invoice |
|
|
|--------------------------|------------|--------------------------|-------------|----------------|------------|----------------|--------------------|-----------------|
|
|
| Initial Operating System | Text Box | Set to whatever you want | Leave Blank | Leave Blank | :x: | :x: | :white_check_mark: | :x: |
|
|
| Initial SSH Key | Text Box | Set to whatever you want | Leave Blank | Leave Blank | :x: | :x: | :white_check_mark: | :x: |
|
|
|
|
You can run this SQL query to create the custom fields:
|
|
|
|
```sql
|
|
-- Insert records for Initial Operating System if they don't already exist
|
|
INSERT INTO tblcustomfields
|
|
(type, relid, fieldname, fieldtype, description, fieldoptions, regexpr, adminonly, required, showorder, showinvoice,
|
|
sortorder, created_at, updated_at)
|
|
SELECT 'product',
|
|
id,
|
|
'Initial Operating System',
|
|
'text',
|
|
'',
|
|
'',
|
|
'',
|
|
'',
|
|
'',
|
|
'on',
|
|
'',
|
|
0,
|
|
UTC_TIMESTAMP(),
|
|
UTC_TIMESTAMP()
|
|
FROM tblproducts
|
|
WHERE servertype = 'VirtFusionDirect'
|
|
AND NOT EXISTS (SELECT 1
|
|
FROM tblcustomfields
|
|
WHERE fieldname = 'Initial Operating System'
|
|
AND relid = tblproducts.id);
|
|
|
|
-- Insert records for Initial SSH Key if they don't already exist
|
|
INSERT INTO tblcustomfields
|
|
(type, relid, fieldname, fieldtype, description, fieldoptions, regexpr, adminonly, required, showorder, showinvoice,
|
|
sortorder, created_at, updated_at)
|
|
SELECT 'product',
|
|
id,
|
|
'Initial SSH Key',
|
|
'text',
|
|
'',
|
|
'',
|
|
'',
|
|
'',
|
|
'',
|
|
'on',
|
|
'',
|
|
0,
|
|
UTC_TIMESTAMP(),
|
|
UTC_TIMESTAMP()
|
|
FROM tblproducts
|
|
WHERE servertype = 'VirtFusionDirect'
|
|
AND NOT EXISTS (SELECT 1
|
|
FROM tblcustomfields
|
|
WHERE fieldname = 'Initial SSH Key'
|
|
AND relid = tblproducts.id);
|
|
```
|
|
|
|
|
|
## What does this module change?
|
|
|
|
This module changes the following things:
|
|
|
|
- Adds configurable options to the product configuration page to allow the user to select the operating system and add
|
|
an ssh key to the initial deployment.
|
|
|
|
## TODO
|
|
|
|
- [ ] Add post checkout checks to ensure the user has selected an operating system and added a ssh key. |