Forge Home

opensipscp

This module install OpenSIPS Control Panel, a PHP Web Portal for provisioning OpenSIPS SIP server.

4,457 downloads

2,553 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.3.1 (latest)
  • 0.3.0
  • 0.2.0
  • 0.1.0
released Oct 3rd 2019
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
  • , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'alisio-opensipscp', '0.3.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add alisio-opensipscp
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install alisio-opensipscp --version 0.3.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

alisio/opensipscp — version 0.3.1 Oct 3rd 2019

opensipscp

Table of Contents

  1. Description
  2. Setup - The basics of getting started with opensipscp
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

This module install OpenSIPS Control Panel, a PHP Web Portal for provisioning OpenSIPS SIP server.

Setup

This module OpenSIPS CP Web Portal and it does not include OpenSIPS sip proxy. The opensips must be installed some other way (e.g: using alisio-opensips module)

This module writes to the mysql database so be careful if installing on top of an existent OpenSIPS installation. You should consider backup your database first.

Beginning with opensipscp

To install OpenSIPS CP with the default module options, simply include the class in your manifest.

include opensipscp

To install OpenSIPS proxy and OpenSIPS control with default values

class{'opensips':}

class{'opensipscp':}

Class['opensips'] -> Class['opensipscp']

Setup Requirements

  • Mysql database
  • Apache
  • opensips

Usage

Include usage examples for common use cases in the Usage section. Show your users how to use your module to solve problems, and be sure to include code examples. Include three to five examples of the most important or common tasks a user can accomplish with your module. Show users how to accomplish more complex tasks that involve different types, classes, and functions working in tandem.

You can use the following parameters to customize your installation.

  • $db_opensips_db The opensips database. It must match your current opensips installation. Default value: 'opensips'
  • $db_opensips_user The database user. Default Value: 'opensips'
  • $db_opensips_pw The password for the opensips database user. Default value 'opensipsrw'
  • $db_server_ip The opensips database host. Default value: 'localhost'
  • $opensipscp_admin_user The initial OpenSIPS Control Panel GUI admin user. Default value:'admin'
  • $opensipscp_admin_pw The initial OpenSIPS Control Panel GUI admin password. Default value: 'opensips'
  • $opensipscp_alias_folder The apache alias for the OpenSIPS Control Panel. Default Value: '/cp'

Limitations

This module does not provision an OpenSIPS proxy server.

This module was tested with puppet 5 running on Centos7.

Development

Please follow the licence guidelines