Difference between revisions of "Soyoustart WHMCS Module"

From WHMCS Global Services Module Documentation
Jump to: navigation, search
(5 intermediate revisions by the same user not shown)
Line 21: Line 21:
  
  
====How to configure the addon module?====
+
==How to configure the addon module?==
  
 
You need to activate the module from the WHMCS admin panel:
 
You need to activate the module from the WHMCS admin panel:
Line 50: Line 50:
 
'''Step 2: Imap Settings'''
 
'''Step 2: Imap Settings'''
  
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|800px|thumb|center]]
  
[[File:WHMCS - OVH VPS Dedicated Server Addon Imap Settings Webmail Accounts.png|800px|thumb|center]]
+
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 :
  
[[File:WHMCS - OVH SYS Kimsufi VPS Dedicated Server Module Imap Settings.png|800px|thumb|center]]
 
  
 +
{| class="wikitable"
 +
|-
 +
! 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?'''
  
===Configure the Products?===
+
To test the cron job follow the below easy steps.
  
We are providing two type of  module one module work with only OVH VPS Account and another one compatible with Dedicated servers OVH / SoYouStart and Kmisufi.
+
'''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.
  
'''Step 1).''' [[Configure VPS Products:Soyoustart WHMCS Module|How to configure the OVH VPS products ]]
+
Once the process completed end user will get the mail.
  
'''Step 2).''' [[Configure Dedicated Products:Soyoustart WHMCS Module|How to configure the Dedicated Server products ]]
 
  
'''Step 2).''' [[Configure Cron Job:Soyoustart WHMCS Module|Setup The Cron Job ]]
+
[[File:WHMCS - OVH VPS Dedicated Server Addon Imap Settings Webmail Accounts.png|800px|thumb|center]]
  
 +
[[File:WHMCS - OVH VPS Dedicated Server Addon Imap Settings Gmail Accounts.png|800px|thumb|center]]
  
  

Revision as of 10:08, 4 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 module files.
  2. Under Modules folder, you will find two folder i.e. servers and addons.
  3. 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.
  4. You need to upload the servers folder to WHMCS directory whmcsdir/modules/servers/.

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
Transfer Type: Binary Mode Selected or ASCII select. You must have to select Binary mode otherwise you will get error file corrupted.


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 test the module ?

Test OVH VPS server products

Step 1). How to test the OVH VPS products

Test Dedicated server products

Step 1). How to test the OVH Dedicated products

How to upgrade the Module from V3.x to V4.0 ?

Step 1). How to upgrade the OVH VPS products