sbc-outbound

This application provides a part of the SBC (Session Border Controller) functionality of jambonz. It handles outbound INVITE requests from the cpaas application server that is going to carrier sip trunks or registered sip users/devices, including webrtc applications.

Configuration

Configuration is provided via environment variables:

variable	meaning	required?
DRACHTIO_HOST	ip address of drachtio server (typically '127.0.0.1')	yes
DRACHTIO_PORT	listening port of drachtio server for control connections (typically 9022)	yes
DRACHTIO_SECRET	shared secret	yes
ENABLE_METRICS	if 1, metrics will be generated	no
JAMBONES_LOGLEVEL	log level for application, 'info' or 'debug'	no
JAMBONES_MYSQL_HOST	mysql host	yes
JAMBONES_MYSQL_USER	mysql username	yes
JAMBONES_MYSQL_PASSWORD	mysql password	yes
JAMBONES_MYSQL_DATABASE	mysql data	yes
JAMBONES_MYSQL_CONNECTION_LIMIT	mysql connection limit	no
JAMBONES_NETWORK_CIDR	CIDR of private network that feature server is running in (e.g. '172.31.0.0/16')	yes
JAMBONES_REDIS_HOST	redis host	yes
JAMBONES_REDIS_PORT	redis port	yes
JAMBONES_RTPENGINES	commans-separated list of ip:ng-port for rtpengines (e.g. '172.31.32.10:22222')	yes
JAMBONES_SBCS	list of IP addresses (on the internal network) of SBCs, comma-separated	yes
STATS_HOST	ip address of metrics host (usually '127.0.0.1' since telegraf is installed locally	no
STATS_PORT	listening port for metrics host	no
STATS_PROTOCOL	'tcp' or 'udp'	no
STATS_TELEGRAF	if 1, metrics will be generated in telegraf format	no

running under pm2

Typically, this application runs under pm2 using an ecosystem.config.js file similar to this:

module.exports = {
  apps : [
  {
    name: 'sbc-outbound',
    cwd: '/home/admin/apps/sbc-outbound',
    script: 'app.js',
    instance_var: 'INSTANCE_ID',
    out_file: '/home/admin/.pm2/logs/jambonz-sbc-outbound.log',
    err_file: '/home/admin/.pm2/logs/jambonz-sbc-outbound.log',
    exec_mode: 'fork',
    instances: 1,
    autorestart: true,
    watch: false,
    max_memory_restart: '1G',    env: {
     NODE_ENV: 'production',
      JAMBONES_LOGLEVEL: 'info',
      DRACHTIO_HOST: '127.0.0.1',
      DRACHTIO_PORT: 9022,
      DRACHTIO_SECRET: 'cymru',
      JAMBONES_RTPENGINES: '172.31.32.10:22222',
      JAMBONES_MYSQL_HOST: 'aurora-cluster-jambonz.cluster-xxxxxxxxxxxxx.us-west-1.rds.amazonaws.com',
      JAMBONES_MYSQL_USER: 'admin',
      JAMBONES_MYSQL_PASSWORD: 'JambonzR0ck$',
      JAMBONES_MYSQL_DATABASE: 'jambones',
      JAMBONES_MYSQL_CONNECTION_LIMIT: 10,
      JAMBONES_REDIS_HOST: 'jambonz.zzzzzzz.0001.usw1.cache.amazonaws.com',
      JAMBONES_REDIS_PORT: 6379,
      ENABLE_METRICS: 1,
      STATS_HOST: '127.0.0.1',
      STATS_PORT: 8125,
      STATS_PROTOCOL: 'tcp',
      STATS_TELEGRAF: 1,
    }
  }]
};

Running the test suite

To run the included test suite, you will need to have docker installed on your laptop.

npm test