Revision as of 21:12, 9 March 2008 (view source) Joe (talk | contribs) ← Older edit		Latest revision as of 15:46, 27 March 2024 (view source) James.white (talk | contribs) (→‎Adding a MediaCP Server)
(14 intermediate revisions by 6 users not shown)
Line 1:		Line 1:
−	'''Adding a CastControl Server'''	+	== About this Module ==
−	The following steps guide you through the process of setting up a server in WHMCS for CastControl Accounts.	+	The MediaCP module allows you to add and manage MediaCP servers in WHMCS.
		+	{{Provisioning_Module
		+	| changepackage = Yes
		+	| changepw = Yes
		+	| clientarealink = Yes
		+	| additional = Start and Stop Stream}}
		+	== Adding a MediaCP Server ==
−	1. Begin by going to Configuration > Manage Servers
−	2. Click Add New Server	+	To set up a MediaCP server in WHMCS, you '''must''' [https://github.com/mediacontrolpanel/whmcs-onpremise/archive/refs/heads/master.zip download the module] and install it according to [http://www.cast-control.net/mediacp/documentation/configuration/whmcs-integration-guide/ MediaCP's instructions].
		+
		+	After installation, you can add and configure servers at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
−	3. Enter the server name, IP address, select the server type "Castcontrol" from the dropdown menu	+	== Creating a MediaCP Product ==
		+
		+	You can create a product that provisions accounts on your MediaCP server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
−	4. Enter the Super Administrative details in the Username & Password fields	+	=== WHMCS Connect ===
−	5. Click Create Server to complete the process	+	This module does not support [[WHMCS Connect]].
−	Your CastControl server is now configured in WHMCS.  You can now move on to create your first CastControl Package.	+	==Troubleshooting==
−	'''Setting up a CastControl Package'''	+	''N/A''
−	1. Go to Configuration > Products/Services	+	{{modules}}
−
−	2. Click Create a New Product and then enter the name for your new package
−
−	3. Set the product type to "Other" and untick the Show Domain Options tick box
−
−	4. Configure the pricing, welcome email, and other configuration options as normal
−
−	5. Next, go to the Server Settings tab of the product config
−
−	6. Select Castcontrol in the Server Type dropdown menu
−
−	7. The page will refresh with the options for a Castcontrol package
−
−	8. Most of the fields should be fairly straightforward - the more difficult fields are explained below:
−
−	Auth: This is the security hash found under Cast-Control Administration -> API Key
−	Host: This is the hostname/domain without the http prefix
−	Path: This should be the web URL path to cast-control. For example, if the URL is http://mydomain.com/castcontrol, the path will be /castcontrol/.
−	Port: Usually 80 unless the web server is running on a separate port.
−
−	9.Next go to the Custom Fields tab and setup an admin only field called "PortBase".  This will be used to store the PortBase for each account created.
−
−	'''Optional Configurable Options'''
−
−	You may also wish to add configurable options to your CastControl package.  With these, you can show your customers option on the order form to customise the ShoutCast hosting package.  The configurable options can be named as follows with the following options as examples:
−
−	'''Maximum Users''' - 16,32,64,etc...
−
−	'''Maximum Bit Rate''' - 8KB,16KB,20KB,24KB,32KB,etc...
−
−	'''Bandwidth''' - 100MB,200MB,Unlimited,etc...
−
−	'''Auto DJ''' - Yes or No
−
−	What this allows you to do is offer a single package that provides all your different options.  And each different option can increase or decrease the price of the overall package as appropriate.

---

Latest revision as of 15:46, 27 March 2024

About this Module

The MediaCP module allows you to add and manage MediaCP servers in WHMCS.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

Change Package	Change Password	Usage Updates	Client Area Link
Yes	Yes	No	Yes

In addition to the above, this module also supports the following non-standard functions: Start and Stop Stream

Adding a MediaCP Server

To set up a MediaCP server in WHMCS, you must download the module and install it according to MediaCP's instructions.

After installation, you can add and configure servers at Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.

Creating a MediaCP Product

You can create a product that provisions accounts on your MediaCP server at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

N/A