Configuration - WHMCS Integration Guide

Table of Contents

 

Install the latest WHMCS Module 

Please make sure you have the latest version of Media Control Panel.
You can check this from MediaCP Administration -> Software Updates.

  1. Download the MediaCP Module
    The latest WHMCS Module file is packaged with the MediaCP software.

    a) Login to Cast-Control Billing / Client Area
    b) Select "View Your licenses" from the side menu.
    c) Select "View & Download" next to your License.




  2. d) Download the Latest MediaCP Stable Package.

  3. Extract Contents
    Extract the MediaCP ZIP package to your desktop and navigate to the upload_and_rename/other/whmcs/ directory.

  4. Upload CCMEDIAPANEL Module
    Upload the “ccmediapanel” directory and all contents to [WHMCS-Install-Directory]/modules/server/

 

Adding a server in WHMCS 

Now that you have installed the CCMEDIAPANEL Module for WHMCS, you will need to add a new server to WHMCS.

  1. Login to WHMCS

  2. Add a new Server
    Open Setup -> Server and select "Add New Server".
    Fill in your own details similarly as seen in the image below:

























  3. Save Changes
    Your new server should now be ready to assign products too.

 

Creating a new product 

You are now ready to create and configure your first product for the MediaCP.

  1. Login to WHMCS.

  2. Navigate to Setup -> Products / Services.

  3. Create a New Product
    Give your new product a name suitable to the service you are providing.
    For this example, we use Wowza Media. The Product Type and Product Group are not important.







    Click Continue.

  4. Untick "Require Domain" options
    It is unnecessary to configure domain options for a shoutcast server, so you will want to untick this from the "Details" tab.

  5. Select the appropriate Module
    It is important to note, that if you are using the MediaCP you will need to select the "Ccmediapanel" module and not the "CastControl" module.
    The "CastControl" module is for our older product called the ShoutcastCP.

    You will now be required to configure the Module Options.
    Refer to the next step for information.

  6. Save your new product

CCMEDIAPANEL Module Configuration 

Auth: MediaCP API Key found in MCP -> Administration -> API Key Example looks like: "hZpXtXWtXtXLhcTahXATp1epr3BunJgcmA-HWci_hKCbeHfKnX6Kxw=="

System Path: The exact URL to your Media Control Panel. For Example: http://std.demo.multiplicitysolutions.com/mediacp/

Service Type: This is the type of service you will be providing.Be sure your control panel supports this or there will be problems.

Source: It is important that you match sources appropriately.If you are unsure, look in the MediaCP -> Create a new server for the different source types that are available with each plugin.

  • Shoutcast198 – sctrans, sctransv2
  • Ices04, streamTranscoderV3
  • Icecast – ices04, ices20
  • WindowsMediaServices – NONE 
  • WowzaMedia – NONE

 

Other values are quite self explanatory and can be generally overwritten in Configurable Options

Configurable Options 

Generic Options

 

Option Name

Description

Example

Service Type

 

 

Shoutcast
Icecast

Wowza Media Server

Windows Media Service

CDS Service

Source

AutoDJ / Source

 

sctransv1

sctransv2

ices04

ices20

streamTranscoderV3

Maximum Users

 

 

25

100

150

200

Maximum Bitrate

Values must match those in 
Max Bit Rate” selection
under Module Settings.

 

24Kbps

64Kbps

96Kbps

128Kbps

256Kbps

560Kbps

640Kbps

720Kbps

1024Kbps

Bandwidth

 

 

5GB

10GB

1TB

2TB

Disk Quota

 

512MB

10GB

5TB

MSN Service Control

 

Enabled, Disabled

 

 

 

 

Service Specific Options

Shoutcast

Option Name

Description

Example

Port 80 Proxy

 

Enabled, Disabled

 

 

 

 

Icecast with Ices 0.4

Option Name

Description

Example

Source Reencode

Reencode MP3 Files

Yes, No

 

 

 

 

Wowza Media Server

Option Name

Description

Example

Wowza Media Type

 

Shoutcast

Live Streaming

Ondemand Streaming

 

 

 

 

 

Email Templates 

A common request in the email template is a way to display the IP address and Port base seperately from each other.
The following example template shows how to achieve this:

 

Dear {$client_name},

PLEASE READ THIS EMAIL IN FULL AND PRINT IT FOR YOUR RECORDS

 Thank you for your order from us! Your hosting account has now been setup and this email contains all the information you will need in order to begin using your account.

Control Panel Access

URL: {$service_server_hostname}
Username: {$service_username}
Password: {$service_password}

 

Service Details
{assign var="shoutcast" value=$service_domain|explode:":"}

Host Address: {$shoutcast.0}
Port Base: {$shoutcast.1}

Products Web Services LiveZilla Live Help