OpenSIPS SoftSwitch - Community Edition

This project contains a fully functional OpenSIPS setup used as a SoftSwitch that provides the following features:

• SIP Proxy with support for TCP and UDP
• topology hiding for all calls
• dialplans for user and did formats
• star codes to enable/disable DND
• call forward URIs for each user:
  • always forward
  • busy forward
  • no answer forward
  • not found forward
• ACLs for each user:
  • User Enabled
  • Force NAT
  • Enable PSTN
  • DND
  • VM Enabled
  • VM Permanent Redirect
  • VM Redirect Not Found
  • VM Redirect on Busy
  • VM Redirect on No Answer
• RTPProxy for voice traffic
• FreeSWITCH for media services:
  • voicemails
  • announcements

Getting Started

The simplest way to get the project running is to setup Docker on your host and then run:

git clone --recursive https://github.com/OpenSIPS/opensips-softswitch-ce.git
cd softswitch

# configure your private IP address before launching the containers
MY_IP=10.0.0.23; sed -i 's/HOST_IP=.*/HOST_IP='$MY_IP'/g' .env

docker compose up

For more information about setup, please check the Setup page.

Once everything is initialized, you should be able to access the OpenSIPS Control Panel using the following credentials:

• URL: http://localhost/cp
• User: admin
• Password: opensips

For more information about provisioning, please check the Provisioning page.

At this point you can follow the Getting Started tutorial to test the OpenSIPS SoftSwitch Community Edition.

Testing

OpenSIPS SoftwSwitch comes with a set of tests that you can run once the setup is complete:

./run-sipssert.sh

For more information, please check the Testing page.

OpenSIPS

OpenSIPS configuration is developed in a separate git repository that can be found here.

Homer

In order to be able to visualize SoftSwitch call flows, it is recommended to setup the Homer tool by following these steps.

Documentation

Documentation pages contain the following topics:

• Setup - contains information about how to install and setup
• Getting Started - show how you can use the SoftSwitch to test certain scenarios
• Components - list of components used in the project
• Provisioning - useful information about provisioning the platform
• Testing - information about testing the platform
• Homer - information about setting up Homer server
• Devel - information about development

Contribute

This project is Community driven, therefore any contribution is welcome. Feel free to open a pull request for any fix/feature you find useful.

License

The OpenSIPS SoftSwitch Community Edition source code is licensed under the GNU General Public License v3.0

All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0

© 2024 - SIP Point Consulting SRL