Mumble

PREREQUISITES

- Mumble server >= 1.2.4

- Enabled Ice support http://mumble.sourceforge.net/Murmur.ini#ice. Note: Ice must listen in the server interface.

- If the whmcs hosting server has a firewall, the domain mapi.whmcsmod.com with protocol tcp and port 443 must be opened. https://mapi.whmcsmod.com will work ask a gateway between your Mumble server and whmcs.

- If the Mumble hosting server has a firewall the port 6502( if that's your mumble ice port) must be opened and allowed for the domain mapi.whmcsmod.com.

INSTALL

1) Unzip the mumble zip file

2) Upload the addons/mumble folder to your whmcs install location in the modules/addons folder

3) Upload the server/mumble folder to your whmcs install location in the modules/servers folder

Mumble ADDON CONFIGURATION

Setup->addon modules

Click the activate button in the Mumble module

Scroll down and fill the configuration fields:

Default server hostname: Default virtual server hostname.

Welcome message: Default virtual server welcome message.

Whmcs module license: The FULL license whmcsmod.com provided you. Example: Leased-1234567890

Access Control: Click Full administrator

PRODUCT CONFIGURATION

1) Create a Mumble email template

WHMCS->SETUP->EMAIL TEMPLATES

Type: product

Unique name: Mumble welcome

Click on create button

Subject: your email subject

Body: Paste the text below

Ip: {$service_server_ip}

Port: {$service_custom_fields.0}

Usename: SuperUser

Password: {$service_password}

Click the "Save Changes" button

2) Add a Mumble server:

WHMCS->SETUP->PRODUCTS/SERVICES->SERVERS->Add new server

Name: A random name

Hostname: Your server hostname , used for email templates for example ts3.mydomain.com or teamspeak 3 ip.

Ip address: Your mumble server ip

Type: Mumble

Username: Ignore it.

Password: The mumble ICE "secret" ( http://mumble.sourceforge.net/Murmur.ini#icesecretread_and_icesecretwrite ).

Click "save"

3) Create a Mumble product:

WHMCS->SETUP->PRODUCTS/SERVICES->Create a new product

Details tab:

Product type: other

Product name: A random name for you product, for example "Mumble plan 1"

Welcome email: welcome Mumble

Module tab:

Module name: Mumble

Server group:your server group in case you made server groups

Check "Automatically setup the product as soon as the first payment is received"

Add a custom field named "Port" (CASE SENSITIVE!)

Text box

Save Changes

4) Create a Slots configurable option:

whmcs->setup->products/services->configurable options

Click "create new group" button

Group name : "Mumble"

Description: "Mumble"

In Assigned products select all your Mumble plans

Click "Add new configurable option" button Option

Name: "Slots"

NOTE: its CASE SENSITIVE.

Option Type: Quantity

Add option: "1"

Click "save changes" button

Set the price for EACH slot.

Click "save changes" button.

REGION SUPPORT ( OPTIONAL )

It is possible to display a region dropdown field in the order form to select the server region based on whmcs server groups.

For example if you have a server in London and another in California :

1- Create a server group named "Mumble London" ast SETUP->PRODUCTS->SERVERS 2- Create a server group named "California" SETUP->PRODUCTS->SERVERS. 3- Assign the whmcs Mumble server to each group. 4- Create a product custom field named "region" :

   -Check "required"
   -Check "show on order form".
   - Fill the "Select options" with the whmcs server group ids you want to display. If the "london" server group ID is 15 and the "California" server group id is 16 the value must be "15|London,16|California" . For custom field personalization check the "friendly custom fields" section at https://docs.whmcs.com/Custom_Fields .