Difference between revisions of "Soyoustart WHMCS Module"

From WHMCS Global Services Module Documentation
Jump to: navigation, search
(Installation Procedure)
(3 intermediate revisions by the same user not shown)
Line 12: Line 12:
 
====How to upload the module files?====
 
====How to upload the module files?====
 
 
# Extract the downloaded module files.
+
# Extract the downloaded files folder "soyoustart".
 +
# You will find three folders under it "crons", "modules" & "temmplates".
 +
# Upload all crons files under WHMCS directory whmcsdir/crons/
 
# Under Modules folder, you will find two folder i.e. servers and addons.  
 
# Under Modules folder, you will find two folder i.e. servers and addons.  
 
# You need to upload the modules folder to WHMCS directory whmcsdir/modules/addons/. It will copy the required module files and nothing will be overwritten.
 
# You need to upload the modules folder to WHMCS directory whmcsdir/modules/addons/. It will copy the required module files and nothing will be overwritten.
 
# You need to upload the servers folder to WHMCS directory whmcsdir/modules/servers/.
 
# You need to upload the servers folder to WHMCS directory whmcsdir/modules/servers/.
 +
# Now open templates/orderforms folder from the downloaded module files.
 +
# You will find "configureproduct.tpl" file under it.
 +
# You need to upload this file in  whmcsdir/templates/orderforms, In case you are using a custom cart, please do not use upload this file. You can skip this step.
  
'''Note*: Module files are encrypted in the Ioncube Binary mode. So if you are uploading the Files through Filezilla or any other FTP client please check the <br>'''
+
Note:-  Please firstly take the backup of your orderform file "configureproduct.tpl"
'''Transfer Type: Binary Mode Selected or ASCII select. You must have to select Binary mode otherwise you will get error file corrupted.'''
 
  
 +
 +
==Installation Procedure==
  
 
==How to configure the addon module?==
 
==How to configure the addon module?==
Line 37: Line 43:
 
'''User Needs to Select Company Name from OVH, SoYouStart & Kimsufi'''
 
'''User Needs to Select Company Name from OVH, SoYouStart & Kimsufi'''
  
[[File:WHMCS - OVH VPS Dedicated Server Addon Key Generation Process.png|800px|thumb|center]]
+
[[File:WHMCS - OVH VPS Dedicated Server Addon Key Generation Process.png]]
  
  
Line 52: Line 58:
 
With the help of Imap Settings, admin can easily setup Email Piping with Webmail and Gmail.  
 
With the help of Imap Settings, admin can easily setup Email Piping with Webmail and Gmail.  
  
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Imap Settings.png|800px|thumb|center]]
+
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Imap Settings.png]]
  
 
Above Screenshots shows the cron job has been successfully setup, in case it is not setup it will show an error.
 
Above Screenshots shows the cron job has been successfully setup, in case it is not setup it will show an error.
Line 114: Line 120:
 
You will see products automatically generated in this section, from here you can set custom names for all the products.
 
You will see products automatically generated in this section, from here you can set custom names for all the products.
  
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Products Setup.png|800px|thumb|center]]
+
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Products Setup.png]]
  
  
Line 120: Line 126:
 
You can set the margins on the products in percentage value.
 
You can set the margins on the products in percentage value.
  
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Setup Pricing Margins.png|800px|thumb|center]]
+
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Setup Pricing Margins.png]]
  
  
 
'''Setting Pricing Of Individual Product'''
 
'''Setting Pricing Of Individual Product'''
  
You can easily set a custom price of a products and all its configurable options.  
+
You can easily set a custom price of products and all its configurable options.  
  
 
'''List of the Config options you can set the prices of:
 
'''List of the Config options you can set the prices of:
Line 138: Line 144:
 
*License Type
 
*License Type
  
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Product Prices Setup.png|800px|thumb|center]]
+
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Product Prices Setup.png]]
  
 
==How to Create Operating Systems Config Options?==
 
==How to Create Operating Systems Config Options?==
 
You can easily create configuration options for operating systems and set custom names.
 
You can easily create configuration options for operating systems and set custom names.
  
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Setup OS Config.png|800px|center]]
+
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Setup OS Config.png]]
  
 
==Creating License Configurable Options & Set Prices==
 
==Creating License Configurable Options & Set Prices==
Line 149: Line 155:
 
With this option, admin can create license configurable options and set custom prices to them.  
 
With this option, admin can create license configurable options and set custom prices to them.  
  
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Licenses Config Options.png|800px|center]]
+
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Licenses Config Options.png]]
  
  
 
==Email Templates Setup==
 
==Email Templates Setup==
 +
 +
Admin can easily manage all email templates from this section, admin can edit templates according to the requirements.
 +
 +
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Email Templates Management.png]]

Revision as of 10:00, 5 November 2019

Getting Started=

Requirements for Installation

  • WHMCS 6.x - 7.x
  • WHMCS DB User must have all permissions of the DB before installation and activation of this Module GRANT ALL PRIVILEGES ON db_base.* TO db_user @'localhost' IDENTIFIED BY 'db_passwd';
  • Active Account required at OVH/SoYouStart/Kimsufi website.
  • Application Key
  • Secret Key
  • OVH/Kimsufi/SoYouStart account name or Registered Email Id.

Installation Procedure

How to upload the module files?

  1. Extract the downloaded files folder "soyoustart".
  2. You will find three folders under it "crons", "modules" & "temmplates".
  3. Upload all crons files under WHMCS directory whmcsdir/crons/
  4. Under Modules folder, you will find two folder i.e. servers and addons.
  5. You need to upload the modules folder to WHMCS directory whmcsdir/modules/addons/. It will copy the required module files and nothing will be overwritten.
  6. You need to upload the servers folder to WHMCS directory whmcsdir/modules/servers/.
  7. Now open templates/orderforms folder from the downloaded module files.
  8. You will find "configureproduct.tpl" file under it.
  9. You need to upload this file in whmcsdir/templates/orderforms, In case you are using a custom cart, please do not use upload this file. You can skip this step.

Note:- Please firstly take the backup of your orderform file "configureproduct.tpl"


Installation Procedure

How to configure the addon module?

You need to activate the module from the WHMCS admin panel:

  • Go to the WHMCS admin panel, click on Setup → Addon Modules.
  • Click Activate at SoYouStart Addon For WHMCS
  • Click Configure, enter your License Key and select Full Administrator at Access Control.


Step 1: Key Setup

You need to generate a key to configure the servers through our module. Admin can generate multiple keys with our module and can resell multiple servers from OVH, SYS and Kimsufi.

User Needs to Select Company Name from OVH, SoYouStart & Kimsufi

WHMCS - OVH VPS Dedicated Server Addon Key Generation Process.png


  1. Select Location
  2. Add Application Key
  3. Add Secret Key
  4. Add Username/Email Id

All the above-required data you will get from the OVH, SYS and Kimsufi official account.


Step 2: Imap Settings

With the help of Imap Settings, admin can easily setup Email Piping with Webmail and Gmail.

WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Imap Settings.png

Above Screenshots shows the cron job has been successfully setup, in case it is not setup it will show an error.


Configure Cron Job: Soyoustart WHMCS Module

Step 1). First of all copy the crons folder files and upload in your existing crons folder file.

Step 2). After upload the files edit the config.php in your cron folder and set the whmcsbase path in whmcsurl variable.

Step 3). Set the following cron job :


Minute Hour Day Month Weekday Command
*/5 * * * * php -q /YOURWHMCSCRONFOLDER/soyoustartcron_vps.php
*/5 * * * * php -q /YOURWHMCSCRONFOLDER/soyoustartcron_dedicated.php
*/30 * * * * php -q /YOURWHMCSCRONFOLDER/syc_soyoustartcron.php.php

How to test the cron job?

To test the cron job follow the below easy steps.

Step 1 Make sure you have assigned the server to the user or user purchased the server from you and that is running mode.

Step 2 Login as a client in which customers have servers. Go to client product service in your WHMCS client area. And view the server details page then click on the Power tab and click on the Netboot button to choose Rescue in Rescue mode and boot it.

Once the process completed end user will get the mail.


WHMCS - OVH VPS Dedicated Server Addon Imap Settings Webmail Accounts.png
WHMCS - OVH VPS Dedicated Server Addon Imap Settings Gmail Accounts.png


How to Configure Products in the Module?

You can easily setup the VPS & Dedicated Server products with our addons. For this, you need to go to WHMCS Admin Panel -> Addons -> Soyoustart VPS Dedicated -> Product Setup

  • Select the Type of Product (Dedicated or VPS)
  • Select the Account Name
  • Select the Operating System


Product Group Settings

  • Choose Group Name
  • Set WHMCS Product Group Name


Product Setting

You will see products automatically generated in this section, from here you can set custom names for all the products.

WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Products Setup.png


Pricing Setting You can set the margins on the products in percentage value.

WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Setup Pricing Margins.png


Setting Pricing Of Individual Product

You can easily set a custom price of products and all its configurable options.

List of the Config options you can set the prices of:

  • Operating System
  • Server Location
  • Disk
  • Public network
  • Memory
  • Control Panel Software
  • Additional IPs
  • License Type

WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Product Prices Setup.png

How to Create Operating Systems Config Options?

You can easily create configuration options for operating systems and set custom names.

WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Setup OS Config.png

Creating License Configurable Options & Set Prices

With this option, admin can create license configurable options and set custom prices to them.

WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Licenses Config Options.png


Email Templates Setup

Admin can easily manage all email templates from this section, admin can edit templates according to the requirements.

WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Email Templates Management.png