Revision as of 01:29, 24 February 2011 (view source) Matt (talk | contribs) ← Older edit		Latest revision as of 15:22, 10 January 2023 (view source) James.white (talk | contribs) (→‎Troubleshooting)
(50 intermediate revisions by 7 users not shown)
Line 1:		Line 1:
−	Centova Cast is an internet radio stream hosting control panel. To find out more about it, please refer to http://www.centova.com/pages/cast/	+	== About this Module ==
−	The guides below explain how to setup and utilise the Centova Cast integration with WHMCS.	+	[http://www.centova.com/pages/cast/ Centova Cast] is an internet radio stream hosting control panel. The Centova Cast module allows you to add and manage Centova Cast servers in WHMCS.
		+	{{Provisioning_Module
		+	| changepw = Yes
		+	| clientarealink = Yes
		+	| usageupdates = Yes
		+	| additional = Start, Stop and Restart Stream}}
		+	== Adding a Centova Cast Server ==
		+
		+	To set up a Centova Cast server in WHMCS:
		+
		+	# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
		+	# Click '''Add New Server'''.
		+	# Select ''Centova Cast'' from the menu.
		+	# Enter the hostname or IP address.
		+	# Enter the username and password or access hash.
		+	# Click '''Continue'''.
		+	# Enter the remaining desired server details.
		+	# Examine the displayed default port. If your server uses a different port, check '''Override with Custom Port''' and enter the correct port. For more information, see [[Server Port Overrides]].
		+	# Click '''Save Changes'''.
		+	# If this is the only Centova Cast server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.
		+
		+	=== Creating an CentovaCast Product ===
		+
		+	You can create a product that provisions accounts on your CentovaCast 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'''.
−	==Setting Up a Server==	+	Make certain to configure the following settings:
−	#Login to WHMCS, go to Setup, and then click Manage Servers. Then, click Add New Server.	+	* For '''Account template name''', enter the Centova Cast account template to use for this package. You can create account templates in Centova Cast under '''Account Templates'''.
−	#On the Add New Server page, fill out the following fields:	+	* For '''Max listeners''', enter the maximum number of simultaneous listeners.
		+	* For '''Max bit rate''', enter the maximum bit rate in kbps.
		+	* For '''Data transfer limit''', enter the monthly data transfer limit.
		+	* For '''Disk quota''', enter the total disk quota. This amount must accomodate all of the server's configuration and log files and any media for the autoDJ.
		+	* For '''Start server''', choose ''yes'' to automatically start the server after provisioning or ''no'' to start the server manually. If autoDJ is enabled, the server cannot start until the user uploads media.
−	Name - Set this to the hostname of the machine on which Centova Cast is running.	+	==== Optional Configurable Options ====
−		+
−	IP Address: Set this to the IP address of the machine on which Centova Cast is running.	+	Optionally, you can create the following configurable options at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Configurable Options]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Configurable Options'''.[[File:CentovaCast-configoptions1.png|thumb|CentovaCast Setup]]
−		+
−	Hostname: Enter the complete URL to your Centova Cast installation, for example:	+	<div class="docs-alert-info">
−	http://centovacast.yourdomain.com/cast/	+	* You '''must''' use these exact option names.
−		+	* For options that set a limit, create a value for each limit that you wish to offer for that option.
−	Type: Select Centovacast from the list.	+	</div>
−		+
−	Username: Set this to: admin	+	* '''Max listeners''' — Sets a custom listener limit.
−		+	* '''Max bit rate''' — Sets a custom maximum bit rate (in kbps). Centova Cast treats this as a numeric value in kbps and will strip any non-numeric characters.
−	Password: Enter your Centova Cast administrator password.	+	* '''Data transfer limit''' — Sets a custom data transfer limit (in MB per month). CentovaCast treats this as a numeric value in megabytes and will strip any non-numeric characters.
−		+	* '''Disk quota''' — Sets a custom disk quota (in MB). CentovaCast treats this as a numeric value in megabytes and will strip any non-numeric characters.
−	All other fields can be ignored. When finished, click Create Server.
−	#Next, go to Setup, and then click Products/Services. Then, click Create a New Product.	+	=== WHMCS Connect ===
−	#Select Shared Hosting Account and select a suitable product group and name. Then, click Continue.
−	#On the Module Settings tab, fill out the following fields:
−	Module Name - Select "Centovacast" from the list.	+	This module does not support [[WHMCS Connect]].
−
−	Account template name - Enter the name of the Centova Cast account template to use for this
−	package. You can create your account templates in Centova Cast by clicking “Account Templates”
−	This feature allows you to predefine completely custom configurations for each package.
−
−	Max listeners - Specify the maximum number simultaneous listeners for this stream. You may
−	optionally leave this blank to use the value specified in the account template.
−
−	Max bit rate - Specify the maximum bit rate (in kbps) for this stream. You may optionally
−	leave this blank to use the value specified in the account template.
−	*Data transfer limit - Specify the monthly data transfer limit for this stream. You may
−	optionally leave this blank to use the value specified in the account template.
−
−	Disk quota - Specify the disk quota for this stream (which must be large enough to
−	accommodate all of this server's configuration files, log files, and any media uploaded for
−	the autoDJ). You may optionally leave this blank to use the value specified in the account
−	template.
−
−	Start server - Set this to “yes” to automatically start the server after provisioning, or
−	“no” if you want the user to start it manually before using it. Note that this only applies
−	to non-autoDJ streams; if an autoDJ is enabled, it cannot be started until media is uploaded.
−	#This step is optional. If you would like to allow your users to “build their own” packages, and have WHMCS to prompt the user for various stream limit options (bit rate, data transfer limit, etc.) and be able to set custom pricing for each option, click the Configurable Options tab.	+	==Troubleshooting==
−	#Next, click the the Add New Configurable Option link, and follow the directions to create one of the following options. Note that in all cases, the “Option Name” field is case-sensitive and must precisely match what is shown below or the option will not be recognized by Centova Cast.
−	Max listeners - This allows the user to specify a custom listener limit. Enter Max listeners	+	===Common Error Codes===
−	in the Option Name field to begin. Next, in the Add Option field, enter the number of
−	listeners, then enter the extra fee for this number of listeners, and click Save Changes.
−	Repeat this process for each listener limit you wish to offer.
−
−	Max bit rate - This allows the user to specify a custom maximum bit rate (in kbps). Enter Max
−	bit rate in the Option Name field to begin. Next, in the Add Option field, enter the bit rate,
−	then enter the extra fee for this bit rate, and click Save Changes. Repeat this process for
−	each bit rate you wish to offer. Note that Centova Cast treats this as a numeric value in
−	kbps, and will strip any non-numeric characters out of this value before attempting to use it.
−
−	Data transfer limit - This allows the user to specify a custom data transfer limit (in MB per
−	month). Enter Data transfer limit in the Option Name field to begin. Next, in the Add Option
−	field, enter the limit (in MB), then enter the extra fee for this limit, and click Save
−	Changes. Repeat this process for each limit you wish to offer. Note that Centova Cast treats
−	this as a numeric value in megabytes, and will strip any non-numeric characters out of this
−	value before attempting to use it.
−
−	Disk quota - This allows the user to specify a custom disk quota (in MB). Enter Disk quota
−	in the Option Name field to begin. Next, in the Add Option field, enter the quota (in MB),
−	then enter the extra fee for this quota, and click Save Changes. Repeat this process for each
−	quota you wish to offer. Note that Centova Cast treats this as a numeric value in megabytes,
−	and will strip any non-numeric characters out of this value before attempting to use it.
−	#All other fields should be filled out in the usual manner, as when creating any other WHMCS product. When finished, click Save Changes to create your product.	+	* '''Unsupported protocol''' — There is an incorrect value for hostname field in the server setup. Make sure that you have entered the full URL to Centova Cast (see above).
−	The Centova Cast module is now ready to use, and will function like any other built-in WHMCS module (CPanel, Plesk, etc.)	+	* '''Invalid source/server type''' — There is not an account template name in the products module settings or the specified name is invalid.
−	For further assistance, Centova's documentation is available @ http://www.centova.com/docs/cast/centovacast_install_guide.php	+	For help, see [https://cdn.centova.net/assets/docs/cast/centovacast_install.pdf Centova's documentation].
		+	{{modules}}

---

Latest revision as of 15:22, 10 January 2023

About this Module

Centova Cast is an internet radio stream hosting control panel. The Centova Cast module allows you to add and manage Centova Cast servers in WHMCS.

Supported Features

Create	Suspend	Unsuspend	Terminate
Yes	Yes	Yes	Yes

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

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

Adding a Centova Cast Server

To set up a Centova Cast server in WHMCS:

1. Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
2. Click Add New Server.
3. Select Centova Cast from the menu.
4. Enter the hostname or IP address.
5. Enter the username and password or access hash.
6. Click Continue.
7. Enter the remaining desired server details.
8. Examine the displayed default port. If your server uses a different port, check Override with Custom Port and enter the correct port. For more information, see Server Port Overrides.
9. Click Save Changes.
10. If this is the only Centova Cast server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.

Creating an CentovaCast Product

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

Make certain to configure the following settings:

• For Account template name, enter the Centova Cast account template to use for this package. You can create account templates in Centova Cast under Account Templates.
• For Max listeners, enter the maximum number of simultaneous listeners.
• For Max bit rate, enter the maximum bit rate in kbps.
• For Data transfer limit, enter the monthly data transfer limit.
• For Disk quota, enter the total disk quota. This amount must accomodate all of the server's configuration and log files and any media for the autoDJ.
• For Start server, choose yes to automatically start the server after provisioning or no to start the server manually. If autoDJ is enabled, the server cannot start until the user uploads media.

Optional Configurable Options

Optionally, you can create the following configurable options at Configuration () > System Settings > Configurable Options or, prior to WHMCS 8.0, Setup > Products/Services > Configurable Options.

• Max listeners — Sets a custom listener limit.
• Max bit rate — Sets a custom maximum bit rate (in kbps). Centova Cast treats this as a numeric value in kbps and will strip any non-numeric characters.
• Data transfer limit — Sets a custom data transfer limit (in MB per month). CentovaCast treats this as a numeric value in megabytes and will strip any non-numeric characters.
• Disk quota — Sets a custom disk quota (in MB). CentovaCast treats this as a numeric value in megabytes and will strip any non-numeric characters.

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

Common Error Codes

• Unsupported protocol — There is an incorrect value for hostname field in the server setup. Make sure that you have entered the full URL to Centova Cast (see above).

• Invalid source/server type — There is not an account template name in the products module settings or the specified name is invalid.

For help, see Centova's documentation.