azuracast-whmcs-module/README.md

AzuraCast WHMCS Module

This is a WHMCS Server Provisioning Module that allows you to automatically setup Shoutcast accounts on your AzuraCast installation with ease.

Features

Admin Features

• Setup AzuraCast Servers
• Setup AzuraCast Products
• Service Create & Terminate

Client Features

• Order AzuraCast Products
• View AzuraCast Product Details
• Change AzuraCast Panel Password
• Stop, Start & Restart Shoutcast
• Stop, Start & Restart Liquidsoup (AutoDJ)
• Provide AzuraCast Panel login information

Getting started

Please ensure that you only download from the official Releases page, if you clone this Git you may encounter issues.

Installation

To install this module simply upload the entire folder & contents named "azuracast" to your "/modules/servers" directory for WHMCS.

Configuration

Server Configutation

Go into your WHMCS Admin Area and then to "Setup" > "Products/Services" > "Servers" & then "Add New Server"

• Name - Enter any name you wish.
• Hostname - Enter the URL of your AzuraCast installation (without the http or backslash)
• IP Address - Enter the IP Address of your AzuraCast installation
• Assigned IP Addresses - Same as above
• Maximum No. of Accounts - Enter the maximum number of accounts you wish to have on this server
• Type - Chose AzuraCast from the dropdown list
• Username - Leave empty
• Password - Enter the API key with all permissions from your AzuraCast installation > My Account
• Secure - If your AzuraCast installation uses SSL (HTTPS), tick this box (It is recommended to use HTTPS)

Custom Email Template

Go into your WHMCS Admin Area and then to "Setup" > "Email Templates" > "Create New Email Template"

• Email Type - Product/Service
• Unique Name - AzuraCast Welcome Email Click "Create"
• Subject - Your Shoutcast Hosting Information Click on the Source Code (<>) button on the right hand side of the editor and then copy & paste the following...

<p align="center"><strong>PLEASE READ THIS EMAIL IN FULL AND PRINT IT FOR YOUR RECORDS</strong></p>
<p>Dear {$client_name},</p>
<p>Thank you for your order from us! Your shoutcast account has now been setup and this email contains all the information you will need in order to begin using your account.</p>
<p><strong>New Account Information</strong></p>
<p>Control Panel: <a href="{$service_server_hostname}" target="_blank" rel="noopener">{$service_server_hostname}</a><br />Username: {$service_username}<br />Password: {$service_password}</p>
<p>You can do actions such as start, stop and restart the Shoutcast Server &amp; AutoDJ straight from within your client area without the need to sign into your AzuraCast Panel.</p>
<p><strong>Product Information</strong></p>
<p>Product Name: {$service_product_name}<br />Billing Cycle: {$service_billing_cycle}<br />Payment Amount: {$service_recurring_amount}</p>
<p>Thank you for choosing us.</p>
<p>{$signature}</p>

Click "Ok". You can now edit this as you please and then "Save Changes"

Product Configutation

Go into your WHMCS Admin Area and then to "Setup" > "Products/Services" > "Products/Services" & then setup a Group and then "Create a New Product"

Details tab

• Product Type - Other
• Product Group - Select the Group you created in the previous step
• Product Name & Description - Enter the product name you'd like to use as well as the description
• Welcome Email - AzuraCast Welcome Email

Module Settings tab

• Module Name - AzuraCast Fill out the rest of the options as desired per product you create.

Custom Fields tab

Create the following custom fields ensuring that they are named exactly the same.

• Station Name (Text Box, Required, Show on Order Form, Show on Invoice)
• Station URL (Text Box, Required, Show on Order Form)
• Station Genre (Text Box, Required, Show on Order Form)
• Station Description (Text Area, Required, Show on Order Form)
• Station ID (Text Box, Admin Only)
• AzuraCast ID (Text Box, Admin Only)
• Permission ID (Text Box, Admin Only)

Leave the remaining tabs default, remember to set the price, billing cycle and if orders are setup automatically.

And obviously click "Save Changes"

Any problems?

Don't worry, simply raise an Issue and I will help you out the best I can, remember - I do this part time so replies or updates may be slow, but I will get back to you!