Skip to content

Latest commit

 

History

History
executable file
·
233 lines (150 loc) · 7.33 KB

README.md

File metadata and controls

executable file
·
233 lines (150 loc) · 7.33 KB
Raw

opensips

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with opensips
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

This module purpose is to provision a SIP server running on Centos 7. This module was tested with puppet 5.

To install opensips on a server, simply use the following:

include opensips

Module Description

This modules install an configure a SIP server based on the Opensips proxy, rtpproxy as media relay proxy and mariadb database server.

Setup

What opensips affects

Packages installed:

  • augeas
  • bash-completion
  • fail2ban
  • opensips
  • opensips-db_mysql
  • opensips-httpd
  • opensips-json
  • opensips-proto_tls
  • opensips-tls_mgm
  • opensips-pua
  • opensips-pua_usrloc
  • rtpproxy
  • sngrep
  • tcpdump

Configured services:

  • Opensips
  • Mysql
  • rtpproxy
  • syslog
  • logrotate

Setup Requirements

The following packages are dependencies:

  • epel-release

The following modules are dependencies:

  • puppetlabs-stdlib (>= 4.22.0 < 6.0.0)
  • puppetlabs-mysql (>= 10.0.0 < 11.0.0)

You must install OpenSIPS Control Panel or rtpengine media proxy if you wish to use them, as these tools are not provided by this module. It is possible to use existing puppet forge modules like alisio-opensipscp or alisio-rtpengine.

There are sample manifest inside the 'tests' folder.

Sample install with Control Panel and rtpengine:

class {'opensips':}
class {'opensipscp':}
class {'rtpengine':}

Sample install with Control Panel and rtpproxy:

class {'opensips':
  mediaproxy_type => 'rtpproxy',
}
-> class {'opensipscp':}

Usage

To install opensips on a server, simply include the class.

include opensips

Add SIP users with opensipctl:

opensipsctl add <USERNAME>@<DOMAIN> <PASSWORD>

Add domains with opensipctl:

opensipsctl domain add <DOMAIN>

To customize the installation change the parameters as desired, acording to the Parameters session.

class {'opensips':
  proxy_port => 5070,
  opensips_mediaserver_hostport => '192.168.33.10:5060'
}

Parameters

These default parameters are set for testing purposes. You should, nay, you must, change it for production.

  • $db_server_ip IP address or hostname of the mysql database server.

  • $db_server_port Mariadb server port.

  • $db_root_pw Database root password.

  • $db_opensips_db The opensips mysql database name.

  • $db_opensips_user The opensips mysql user.

  • $db_opensips_pw The password for the opensips mysql user.

  • $opensips_advertised_address The external IP address or hostname of a server behind NAT.

  • $opensips_advertised_port The external SIP port of a server behind NAT.

  • $opensips_cfg The path for the opensips config file

  • $opensips_ctlrc The path for the opensips control file

  • $opensips_http_mi_port Opensips HTTP Manager Interface Port. Default value: 8888

  • $opensips_script_mode The opensips operation mode, acording to the osipconfig utility. Accepted values: default, trunking, residential.

  • $opensips_yum_repo_baseurl Opensips 2.4 yum repo 'http://yum.opensips.org/2.4/releases/el/7/$basearch'

  • $opensips_defaultgw_hostport External gateway address:port (e.g. '127.0.0.1:5070')

  • $opensips_mediaserver_hostport External mediaserver address:port (e.g '127.0.0.1:5070')

  • $proxy_transport Opensips default signal transport. Accepted calues: udp, tcp, tls

  • $proxy_ip Address of the interface where opensips will listen to.

  • $proxy_module_ratelimit_enable Enable/disable the ratelimit module for implemeting rate limiting for SIP requests. Default: true

  • $proxy_module_ratelimit_limit threshold limit per second for the ratelimit module. Default: 10 per second

  • $proxy_port Port where opensips will listen to (e.g. 5060)

  • $proxy_eth_interface Array of ethernet interfaces where opensips will listen to. E.g ['eth0','eth2']

  • $repo_install Install necessary yum repositories. Default to true

  • $mediaproxy_ctrl_socket Control socket composed by protocol:address:port for controlling rtpproxy. E.g 'udp:127.0.0.1:22222'

  • $mediaproxy_offer_flags The “flags” string is a list of space-separated items. Each item is either an individual token, or a token in “key=value” format. Default to 'transcode-PCMA transcode-PCMU codec-mask-G729'

  • $mediaproxy_type Set which mediaproxy wil be used. Accepted values are 'rtpproxy' or 'rtpengine'. Default to rtpproxy

  • $rtpproxy_listen_ip Address where rtpproxy will listen to. E.g '0.0.0.0'

  • $rtpproxy_min_port Integer representing the lowest rtp port rtpproxy will listen to (e.g 10000)

  • $rtpproxy_max_port Integer representing the highest port rtpproxy will listen to (e.g 2000)

  • $rtpproxy_file_limit Integer representing file descriptors limit (e.g. 16000)

  • $syslog_local Syslog level (e.g. 5) for opensips and rtpproxy log

  • $syslog_file Syslog file for opensips and rtpproxy (e.g. /var/log/opensips.log)

  • tls_certificate_path Path for the certificate used with TLS and Websocket. Default to /etc/letsencrypt/live/acme.com/cert.pem

  • tls_private_key_path Path for the Private key used with TLS and Websocket. Default to /etc letsencrypt/live/acme.com/privkey.pem

  • webrtc_ws_port Websocket Ws (http) port. Default to 8080

  • webrtc_wss_port Websocket Wss (https) port. Detault to 4443

Tasks in this module

The OpenSIPS module has tasks for performing trivial operations using Bolt. Please refer to to the Puppet documentation or Bolt documentation on how to execute a task.

  • opensips::ctl Task for using opensipsctl - opensips control tool.

  • opensips::domainadd Add domain to the database using opensipsctl

  • opensips::domainrm Remove domain from the database using opensipsctl

  • opensips::domainshow Show domain in memory using opensipsctl

  • opensips::restart Restart OpenSIPS service

  • opensips::ulshow Show opensips in-RAM online users

Reference reading

The most up to date reference and documentation for all configurations can be found online manual:

Limitations

This module purpose is to provision an SIP server running on the Centos7 OS. This module was tested with puppet 5.

Development

Copyright 2019 Antonio Alisio de Meneses Cordeiro

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.