AzuraCast WHMCS Module

Overview

The AzuraCast WHMCS Module automates the entire lifecycle of radio stations — from order to termination. When a customer places an order, the module automatically provisions a fully configured AzuraCast station, creates user credentials, assigns permissions, and sends a welcome email with all connection details.

It integrates seamlessly into both the WHMCS Admin Area (for operators) and the WHMCS Client Area (for customers), providing a premium self-service experience with an embedded radio player, SSO deep-linking, and real-time station management.

Key Features

System Requirements

AzuraCast Server

• AzuraCast installed via Docker (recommended) or Ansible
• API Key with full administrator permissions
• Network access between your WHMCS server and AzuraCast server (HTTPS recommended)
• AzuraCast version 0.19+ (tested up to 0.23.x)

Download & Installation

After purchasing the module, download the ZIP archive from your client area or the link provided in your order confirmation email.

Extract the Archive

Extract the downloaded ZIP file. You will see the module folder containing three subdirectories that mirror the WHMCS root structure:

Downloaded ZIP archive and extracted module folder

Module folder structure: global-email-template, includes, and modules

Upload to WHMCS

Upload all three folders to your WHMCS root directory, merging them with the existing folder structure. You can use FTP/SFTP, SCP, or your hosting panel's file manager.

Option A: Via FTP / SCP

Upload via FTP/SCP — merge modules/ and includes/ into WHMCS root

Option B: Via Plesk / cPanel File Manager

Upload via Plesk File Manager — navigate to httpdocs/ and upload

Verify Installation

After upload, confirm these paths exist on your server:

whmcs-root/
  modules/
    servers/azuracast/           # Server module
      azuracast.php
      lib/API.php
      lib/StationManager.php
      lib/LicenseGuard.php
      hooks.php
      cron.php
      sync.php
      templates/client/overview.tpl
    addons/azuracast_manager/    # Addon module
      azuracast_manager.php
      lib/License.php
      hooks.php
      index.php
  includes/
    hooks/
      azuracast_services_display.php
      azuracast_sync_button.php

Addon Activation

After uploading the files, activate the AzuraCast Manager addon module in your WHMCS admin panel.

1. Navigate to Addon Modules

   Go to Configuration → Addon Modules in the WHMCS admin area. Find “AzuraCast Manager” in the list and click the Activate button.

   

   Click “Activate” on the AzuraCast Manager addon
2. Configure the Addon

   After activation, the configuration panel expands. Enter your license key, select which admin roles should have access, and click Save Changes.

   

   Enter license key, set access control, and save

License Setup

A valid license key is required for the module to function. You receive your license key after purchase. Enter it in the addon configuration field and click Save.

Verify License

After saving, click the “License Active” badge to view your license details including the registered owner, product, email, issue date, and expiration.

License verification popup showing active status

Step 1: Connect Your AzuraCast Server

Enter your AzuraCast server connection details:

• Server Name — A friendly name for display in WHMCS admin (e.g., “AzuraCast Production”)
• Hostname or IP — Your AzuraCast server address without https://
• Direct Server IP (optional) — Only needed if the hostname is behind a CDN/proxy
• API Key — Must have full administrator permissions (How to create an API key)

Step 1: Enter your AzuraCast server details

Click “Test Connection & Add Server” to verify the connection. On success, you’ll see the AzuraCast version and the server will be added to WHMCS.

Connection test passed — server added with status “Active”

Step 2: Create Radio Hosting Products

The wizard creates 4 pre-configured example products with sensible defaults for common radio hosting plans:

Step 2: Preview of the 4 example products before creation

Products created successfully with assigned WHMCS IDs

Step 3: Create Custom Fields

Each AzuraCast product requires 14 custom fields (9 admin-only + 5 customer-facing). The wizard scans all products and creates any missing fields automatically.

Step 3: Custom field status before creation

All custom fields created — 14/14 per product

Custom Field Types

Step 4: Email Template

The wizard creates a custom email template “AzuraCast Station Credentials” that is sent to customers when their station is provisioned. It includes all connection details, login credentials, and stream URLs.

Step 4: Email template created with custom merge fields

Step 5: Setup Complete

All done! The wizard summarizes everything that was configured: servers, products, custom fields, and email template.

Setup complete — all components configured and ready

License Information

The top section displays your license key, activation status, registered owner, product type, billing cycle, and expiration date. A green License Active badge confirms your license is valid.

Dashboard: License info, server configuration, and product status overview

Servers

Lists all configured AzuraCast servers with hostname, IP, HTTPS status, and connection status. Click Edit to modify server settings or Remove to delete a server connection.

Product Status

Shows all AzuraCast products with their custom field health. Each product should show 14/14 Complete. If fields are missing, use the “Create All Missing Fields” quick action.

Product status and email template management

Email Template

Displays the current email template status. Use “Set on All Products” to assign the template as the welcome email for all AzuraCast products, or “Reset Template” to recreate it with default content.

Available Merge Fields

Lists all custom merge fields provided by the module for use in email templates:

Merge fields, Sync Tool section, and Quick Actions

Quick Actions

• Create All Missing Fields — Scans all AzuraCast products and creates any missing custom fields. Existing fields are not modified.
• Run Setup Wizard Again — Reopens the step-by-step wizard to review or reconfigure your server, products, fields, and email templates.
• Open Sync Tool — Launch the Sync Tool to detect and resolve inconsistencies between AzuraCast and WHMCS.

Product Details

Navigate to Configuration → Products/Services to see all your AzuraCast products under the “Radio Hosting” group.

Products/Services page — Radio Hosting group

Click on a product to edit its details including name, description, product group, and order form settings.

Product Details tab — name, description, and display settings

Pricing

Configure recurring pricing for each billing cycle (monthly, quarterly, semi-annually, annually, etc.).

Pricing tab — configure billing cycles and amounts

Module Settings

The Module Settings tab controls how each product provisions stations on AzuraCast. These 12 configurable options define the station specifications:

Module Settings — all 12 configurable station options

Custom Fields

The Custom Fields tab shows all 14 fields for the product. The 5 customer-facing fields appear on the order form and let customers personalize their station during checkout.

Custom Fields — customer-facing fields on the order form

Template Editor

Navigate to Configuration → Email Templates and find “AzuraCast Station Credentials” under Product/Service Messages.

Email Templates list — AzuraCast Station Credentials

Click to edit the template. The default template includes sections for:

• Welcome message with client and service information
• Panel login credentials (URL, email, password)
• Broadcast passwords (source, admin)
• Stream URLs (direct stream, public player page)
• Client portal link for station management

Email template editor with subject line and body

Available Merge Fields

The module registers custom merge fields that you can use in any email template. They are available in the “Available Merge Fields” panel on the right side of the template editor.

Available merge fields in the template editor sidebar

Server Configuration

The AzuraCast server is automatically configured during the Setup Wizard. You can review and modify it at Configuration → System Settings → Servers.

Server configuration — AzuraCast server and server group

Key settings include:

• Server Name — Display name in admin panel
• IP Address — AzuraCast server IP for API connections
• Server Group — Used to assign products to this server
• Fill Type — “Add to the least full server” for multi-server setups

Hero Player & Controls (1–23)

Client area hero banner — annotated UI elements (1–23)

Radio player close-up — now playing, controls, and SSO buttons

Station Features & Stream Connection (24–44)

Station features, stream connection, and station status — annotated (24–44)

Station Features Grid (24–34)

Each tile is an SSO deep-link — customers click and are automatically logged in to the corresponding AzuraCast page:

Stream Connection (35–39)

Station Status (40–44)

Broadcast Credentials (45–51)

Connection details for broadcasting software (BUTT, Mixxx, OBS, SAM Broadcaster, etc.), with separate Icecast and Shoutcast formats:

Broadcast credentials — annotated (45–51)

Complete client area page — full overview from hero to broadcast credentials

Dashboard

Access the Sync Tool from the AzuraCast Manager Dashboard or via Addons → AzuraCast Manager → Open Sync Tool. The dashboard shows:

• Total Stations — All stations on the AzuraCast server
• Linked — Stations properly connected to an active WHMCS service
• Unlinked — Stations on AzuraCast without a matching WHMCS service
• Missing — WHMCS services referencing stations that no longer exist
• Status Mismatch — Suspend/unsuspend status differs between WHMCS and AzuraCast
• Unused Roles — Leftover user roles no longer assigned to any user

Sync Tool dashboard — station sync overview

For each unlinked station, you can:

• Link — Associate it with an existing WHMCS service
• Restart — Restart the station’s services
• Delete — Remove the station from AzuraCast

Maintenance Actions

The Maintenance dropdown provides advanced cleanup and repair functions:

Maintenance dropdown with repair and cleanup actions

How does auto-provisioning work?

When a customer places an order and pays (or based on your auto-setup setting), the module automatically: creates a new AzuraCast station with the configured settings, creates a user account with the customer’s email, assigns a custom role with appropriate permissions, sets up mount points and storage quotas, generates source/admin passwords, and sends the welcome email with all credentials.

Which AzuraCast versions are supported?

The module is tested with AzuraCast 0.19+ through 0.23.x. It uses the AzuraCast REST API which maintains backward compatibility. Both Docker and Ansible installations are supported.

Can I use the module with multiple AzuraCast servers?

Yes. Add multiple servers during the Setup Wizard (Step 1) or later via the Dashboard. Create a server group and WHMCS will distribute new stations across servers using the “least full” algorithm.

What happens when a service is suspended?

The module disables the station on AzuraCast (stops streaming) and locks the user account. When unsuspended, everything is restored automatically.

What happens when a service is terminated?

The module deletes the station, user account, and role from AzuraCast, and clears all custom field data in WHMCS. If the station was already manually deleted on AzuraCast, the module handles the 404 gracefully and still cleans up WHMCS data.

Can I customize the client area template?

Yes. The client area is rendered from templates/client/overview.tpl inside the server module directory. You can modify the Smarty template to match your brand, but be careful not to break the JavaScript functionality.

How does SSO (Single Sign-On) work?

When a customer clicks an SSO button (e.g., “Music Files” or “Dashboard”), the module generates an AzuraCast login token, uses an iframe bridge to set the session cookie, and then redirects the customer to the target page. This works seamlessly because the AzuraCast panel and the login token share the same domain.

How do I update the module?

Download the latest version, upload and overwrite the files (same process as initial installation), and clear the Smarty template cache. No database changes are needed — the module handles migrations automatically.

The connection test fails. What should I check?

• Verify the hostname/IP is correct and reachable from your WHMCS server
• Ensure the API key has full administrator permissions
• Check that HTTPS is enabled if using a secure connection
• If behind Cloudflare, provide the direct server IP in the optional field
• Check firewall rules allow outbound HTTPS from WHMCS to AzuraCast

How do I get support?

Contact us via the support ticket system in your client area. Include your license key and any error messages for faster resolution.