Contribute in GitHub:

Using optimal configuration settings

You can use optimal configuration settings included in your IBM® Voice Gateway releases for both your single and multi-tenant deployments. Versions 1.0.0.6c and later.

Enabling the optimal configuration

The Voice Gateway installation package includes a JSON file that specifies optimal configuration settings for a specific version. To prevent behavior changes when moving to later releases, setting defaults are not automatically changed. Instead, you can configure your deployment with environment variables or JSON configuration properties to use the optimal default values included in a specific Voice Gateway release.

Note: If the same settings are configured by both your deployment configuration and the optimal configuration file, your deployment configuration settings are used and not the optimal configuration. You can find the default values for each release in Optimal configuration settings.

See Configuration environment variables for Voice Gateway and Advanced JSON configuration properties to learn more about configuring your deployment.

Single-tenant environment: Add the USE_OPTIMAL_CONFIGURATION and OPTIMAL_CONFIGURATION_VERSION environment variables to your SIP Orchestrator container environment variable configuration.
```
 environment:
     - USE_OPTIMAL_CONFIGURATION=true
     - OPTIMAL_CONFIGURATION_VERSION=1.0.0.6c
```
Multi-tenant JSON configuration: Add the useOptimalConfiguration and optimalConfigurationVersion properties to the tenants that you want to configure. You can choose to add optimal configuration to all your tenants, or at the tenant level.

The following example shows a tenant at 234-555-7890 on the myhost.com host with the optimal configuration settings enabled for the 1.0.0.6c version.
```
{
 "tenants": [
   {
     "tenantURI":"2345557890@myhost.com",
     "description":"Voice Gateway 1.0.0.6c Optimal Config",
     "useOptimalConfiguration":"true",
     "optimalConfigurationVersion":"1.0.0.6c"      
   }
 ]
}
```

Changing the optimal configuration settings version

When upgrading Voice Gateway to a new version or changing versions, you can decide whether to leave the existing optimal configuration settings or whether to use the latest settings. Change your existing optimal configuration version to a different release by changing the OPTIMAL_CONFIGURATION_VERSION environment variable or optimalConfigurationVersion JSON configuration property for your deployment. When the optimal configuration is enabled, but the version number isn't specified, Voice Gateway uses the latest available optimal configuration changes.

You can find the available optimal configuration defaults in Optimal configuration settings.