Introduction

Iradialer requires a configuration JSON file with site specific configurations. The values in this file are used to configure various processes that are part of the iradialer solution.

On Debian, this file needs to be in the path /AEC/serverdetails.json

On Windows, this file needs to be in the path C:\Program Files\<tenant_id>\serverdetails.json

This file will be read and configurations loaded on two occasions:

During installation/upgradation of iradialer using the installer.
During OS startup on machines where iradialer is already installed.

This document gives a sample of the file and explains the attributes in it.

Configuration

Sample

{
"redis_endpoint": "my.remote.redis.server.in.cloud.com",
"unique_hive_name": "IRA_HIVE_1",

"proxy_web": "https://cslm.ae.acqueon.com/iralic/license",

"http_proxy": "",

"lic_mode": "CLOUD",
"licenses_assigned": [

{"product":"txhive", "item":"instance", "count":"20", "tenant":"all"},
{"product":"mod_iradialer", "item":"iradial", "count":"20", "tenant":"demo"},
{ "product": "iracpa", "item": "amd", "count": "20", "tenant": "demo"}
],
"gateways": [
{"name":"chime", "username":"testuser", "password":"test1234", "realm": "r4nd0mt3xt.voiceconnector.chime.aws", "From-user": "+19876543210",

"transport": "tls"}

"external_ip": "1.2.3.4",

"log_retention":"30"

}

Explanation

Name	Description
redis_endpoint	The FQDN/URL of the redis endpoint to connect to. Do not mention the port. Set it to localhost in case of a non HA setup which uses a local redis server.
unique_hive_name	The unique name representing the hive this machine is to be part of. In a HA setup with multiple machines, all machines should connect to the same redis_endpoint and set the same unique_hive_name. In order to create a unique hive name, login to www.iraware.com or contact Epicode support.
proxy_web	If you have configured your web server as a reverse proxy to https://www.iraware.com/license, then configure this value to your web url.
http_proxy	If the deployment site needs all requests to go via a HTTP proxy, put the HTTP proxy details here.
lic_mode	The licensing mode. One of “CLOUD” or “NODE”. Defaults to “CLOUD” if not mentioned.
licenses_assigned	The list of the licenses to be acquired by this hive. The entry for product txhive should always be in this list since this acquires the licenses for our product TxHive, which is required for interprocess communication between our components. We recommend leaving the count at 20, meaning 20 components can connect to the hive. For a non HA setup, this count can be reduced to 10. If CPA is not required in this server instance, then the entry iracpa need not be mentioned. Else mention it with the count of licenses required. If the server instance is only used for CPA and the iradialer APIs are not required, then you need not mention mod_iradialer in the list. Else mention the count of licenses required.
	product	Name of the Epicode product
	item	Type of license required for the product
	count	Number of licenses required for this hive identified with unique_hive_name.
	tenant	The unique tenant id this hive belongs to.
gateways	The array of SIP gateways to be defined. Each gateway will be a json in the array.
	name	The name to be given to the gateway. Do not use any spaces in the name. The only special character allowed is underscore( _ ). You will be using this gateway name in the makecall request (Ex. sofia/gateway/chime).
	username	The SIP trunk username provided by your SIP service provider.
	password	The SIP trunk password provided by your SIP service provider.
	realm	The realm provided by your SIP service provider.
	proxy	The proxy to be used for the gateway. Will use the value of the realm if not provided.
	From-domain	The domain for the gateway. Will use the value of the realm if not provided.
	From-user	The caller ID to be set for calls through this SIP trunk.
	transport	The network transport to be used for communication with the SIP service provider. Accepted values are udp, tcp, tls. Note that setting this to tls will enable encryption for both SIP signalling and RTP, i.e. TLS+SRTP.
external_ip	The external IP address to be advertised in SIP signaling. When not set, the default value is server internal IP.
log_retention	The number of days the IraDialer log files have to be retained before automatically purging them.

Force load updated serverdetails.json

As mentioned in the introduction, iradialer will automatically read serverdetails.json and load the configurations during the installation/upgradation process and during server startup.

If the file is updated when there is no upgradation scheduled and you do not wish to restart the server for the changes to take effect, follow the steps below to force iradialer to load the configurations from the serverdetails.json file. Note that this process will restart the iradialer services and thus, should only be performed during non production hours.

Debian

For iradialer 1.3.x

sudo dpkg-reconfigure iradialer

For iradialer 1.4.x

sudo /opt/epi/script/reconfigure_ira_service

For iradialer 1.6.x

sudo /usr/local/epi/scripts/reconfigure_ira_services.sh

Windows

If the file is updated, run the following commands to reload the configurations from the serverdetails.json file.

1. Run command prompt as administrator and navigate to the following folder.

2. cd C:\<tenant_id>\IraDialer\script

3. Startup.bat

If you do not pass any arguments to Startup.bat it takes CLOUD as lic_type. Pass NODE as an argument if you want node locked license.

The command needs to be run on both the servers if it's running a HA setup.

Verification:

If all the configurations are successfully loaded , IraDialer dashboard will show all the components along with the license details.

Refer to KB

https://support.epicode.in/help/en-gb/28-iradialer/189-iradialer-dashboard

Configuring serverdetails.json