Extract the module .zip file

Upload the module folder to your WHMCS provisioning module folder, and rename it to cometbackup.

• e.g. your_whmcs_root_folder / modules / servers / cometbackup

Navigate to Setup > Products/Services > Servers and click Add New Server.

Choose a name, and input your Comet server's connection details (including port, but not protocol) in the Hostname field.

Select Comet Backup as the server's Type, enter your login details, enable the Secure option if your server is using HTTPS, and click Save.

• You can use the Test Connection button to confirm whether your server is accessible using the provided address and credentials.

While still in the Servers area, click Create New Group and assign your server to your new server group.

• We strongly recommend that you only have one server per Comet server group in WHMCS - having more than one server in a group may result in unexpected behaviour.

Navigate to Setup > Products/Services > Products/Services.

Create a product group if none exists.

Create a new product, assigned to your product group.

In the product's Details tab, we recommend disabling the Require Domain option.

In the product's Module Settings tab, select Comet Backup and choose the new server group.

• If you wish for new orders to be automatically accepted and new accounts to be immediately created on the Comet server, you should select Automatically setup the product as soon as an order is placed (or Automatically setup the product as soon as the first payment is received if you want to require payment first) in the Module Settings tab.

If you wish to allow your users to specify custom usernames or custom passwords, visit your product's Custom Fields tab.

• To allow custom usernames, under Add New Custom Field:

  • Set Field Name to Username
  • Set Field Type to Text Box
  • Set Validation to /^.{6}/
    • Comet requires usernames to contain at least 6 characters, which this validation rule enforces. If this is not set correctly, short usernames may result in a silent failure; WHMCS will allow the user to complete the order process, but the new service will be marked as Pending and a 'CreateAccount' failure will be logged to the Utilities > Module Queue page.
  • Enable the options for both Required Field and Show on Order Form.
  • You should ideally set a Description explaining the 6 character length requirement, and any other limitations that you may have implemented via the Validation field.
  • If you also have a custom field for user passwords, you may wish to set Display Order to a lower number than the corresponding value applied to the Password field, in order to ensure that Username is displayed first.
  • Click Save Changes to add your new custom field.

• An example of a custom Username field configuration:

• To allow custom passwords, under Add New Custom Field:

  • Set Field Name to Password
  • Set Field Type to Password
  • Set Validation to /^.{8}/
    • Comet requires passwords to contain at least 8 characters, which this validation rule enforces. If this is not set correctly, short passwords may result in a silent failure; WHMCS will allow the user to complete the order process, but the new service will be marked as Pending and a CreateAccount failure will be logged to the Utilities > Module Queue page.
  • Enable the options for both Required Field and Show on Order Form.
  • You should ideally set a Description explaining the 8 character length requirement, and any other limitations that you may have implemented via the Validation field.
  • If you also have a custom field for usernames, you may wish to set Display Order to a higher number than the corresponding value applied to the Username field, in order to ensure that Password is displayed first.
  • Click Save Changes to add your new custom field.

• An example of a custom Password field configuration:

• Please note that service passwords in WHMCS are not obscured from the Admin area.

Select a policy group and storage vault if desired, and save your changes.

• If the [Create New Policy Group].. option is selected, this will cause a new policy group to be created and assigned on the Comet server with the following options:
  • Storage vault creation / editing / deletion disallowed.
    • This helps to ensure that users cannot avoid storage vault quotas assigned via WHMCS.
    • Available storage vault types are restricted to the Comet server type, preventing reassignment of an existing vault to a different type.
  • Password changes via the client software are disallowed, although WHMCS administrators and Comet Server administrators may reset user passwords.
    • This requires users to manage their passwords via WHMCS, keeping the WHMCS password on record in sync with the actual password on the Comet server.
• New policy groups will be created the first time the module attempts to assign them to a new account.

This product can now be used to provision and manage Comet accounts from WHMCS.