General
The general configuration affects your entire Routr instance. The general configuration
can be provided using the file config/config.yml located at the root of your Routr installation.
General Configuration Parameters
| Property | Description | Required |
|---|---|---|
| apiVersion | Indicates the version of the resource (Not yet implemented) | Yes |
| metadata.userAgent | Sets sip header User-Agent to the desired value | No |
| spec.dataSource.provider | Defines data provider. Defaults to files_data_provider | No |
| spec.dataSource.parameters | Data Source Parameters. Ex.: 'host=localhost,port=6379' | No |
| spec.bindAddr | Default stack IP address | No |
| spec.externAddr | IP address to advertise | No |
| spec.localnets | Local networks. Use in combination with spec.externAddr | No |
| spec.recordRoute | Stay within the signaling path | No |
| spec.transport.[*].bindAddr | Overwrites spec.bindAddr for transport entry | No |
| spec.transport.[*].port | Transport port | Yes |
| spec.transport.[*].protocol | Valid values are: tcp, udp, tls, sctp, ws, wss | Yes |
| spec.registrarIntf | Internal causes the server to use the IP and port it "sees"(received & rport) from a device attempting to register. Defaults to External | No |
| spec.accessControlList.deny.[*] | Deny incoming traffic from network list | No |
| spec.accessControlList.allow.[*] | Allow incoming traffic from network list | No |
| spec.restService.bindAddr | Restful service listening address | No |
| spec.restService.port | Restful service port. Defaults to 4567 | No |
| spec.restService.minThreads | Minimum thread allocation. Defaults to 8 | No |
| spec.restService.maxThreads | Maximum thread allocation. Defaults to 200 | No |
| spec.restService.timeOutMillis | Will reject requests that last more than this value. Defaults to 5000(5 seconds) | No |
| spec.restService.unsecured | Disabled https for restful calls. Defaults to false | No |
| spec.restService.keyStore | Path to keyStore | No |
| spec.restService.trueStore | Path to trueStore | No |
| spec.restService.keyStorePassword | Password for keyStore | No |
| spec.restService.trueStorePassword | Password for trueStore | No |
| spec.securityContext.keyStore | Path to keyStore | Yes |
| spec.securityContext.trustStore | Path to trueStore | Yes |
| spec.securityContext.keyStorePassword | Password for keyStore | Yes |
| spec.securityContext.keyStoreType | KeyStore type | Yes |
| spec.securityContext.client.authType | Type of client authentication. Defaults to DisabledAll. See https://goo.gl/1vKbXW for more options | No |
| spec.securityContext.client.protocols.[*] | Accepted TLS protocols. Defaults to [TLSv1.2] | No |
| spec.securityContext.debugging | Turns ON or OFF ssl debugging. Defaults to false | No |
| spec.ex_rtpEngine.enabled | If enabled, it will send all media thru the RTPEngine. Defaults to false | No |
| spec.ex_rtpEngine.proto | Reserved to allow for NG commands via http, https, and udp. Currently only http is supported | No |
| spec.ex_rtpEngine.host | Address for RTPEngine | No |
| spec.ex_rtpEngine.port | Port for RTPEngine | No |
| spec.ex_convertTelToE164 | If enabled, it will convert the number on ingress calls to E164 format before routing the call. Defaults to false | No |
| spec.ex_uniqueGatewayPerHostPort | If enabled, it will yield an error if a Gateway with the same host and port combination already exists. Defaults to false | No |
Variables prefixed with
ex_are experimental features and may be removed or renamed in the future.
Transport Configuration
Routr supports tcp, udp, tls, sctp, ws, and wss as transport protocols.
The server requires at least one transport protocol.
To bind a transport protocol to a specific IP address, you can use the spec.transport.bindAddr or more generally spec.bindAddr.
Datasource Providers
Routr currently implements two data providers: redis_data_provider and files_data_provider. The default data provider is the files_data_provider.
The docker distribution of the server uses
redis_data_providerby default
Redis Data Provider
The parameters for redis_data_provider are:
| Parameter | Description | Required |
|---|---|---|
| host | Redis host. Defaults to 'localhost' | No |
| port | Redis port. The default port is 6379 | No |
| secret | Password to access database | No |
Files Data Provider
The parameters for files_data_provider are:
| Parameter | Description | Required |
|---|---|---|
| path | Path to configuration files. Defaults to the config folder | No |
This implementation has the limitation that writes operations have to be performed manually on the files.
Configuring the server behind a NAT
The spec.externAddr and spec.localnets parameters help Routr identify the
correct path for any given traffic. The spec.externAddr is typically the Internet
facing IP address. The spec.localnets is an array with valid CIDR, IP/Mask, or single IP values.
Here is quick example:
spec:
externAddr: 172.220.231.23
localnets: [172.17.0.2/16]
Access Control List
The Access Control List(ACL) provides with a security mechanism to disable network
access from unwanted sources. ACL rules exist at general or Domain level. Here is an example,
blocking all traffic except from IP address 192.168.0.1.
spec:
accessControlList:
deny: [0.0.0.0/1] # Deny all
allow: [192.168.0.1/31]
Basic Example
apiVersion: v1beta1
spec:
transport:
- protocol: tcp
port: 5060
- protocol: udp
port: 5060