Skip to content

setup.md

Latest commit

 

History

History
58 lines (45 loc) · 2.97 KB

setup.md

File metadata and controls

58 lines (45 loc) · 2.97 KB
Raw

OpenSIPS SoftSwitch - Community Edition - Setup

Prerequisites

To run this platform, you need to have Docker and Docker Compose installed on your machine. Also, git is another requirement to clone the repository.

Network

The platform uses a bridge network to connect the containers. This means that the containers can communicate with each other using their IP addresses. The IP addresses are set in the .env file.

To access the containers from outside this network, port forwarding is used to map the ports from the host machine to the containers. (e.g. OpenSIPS-CP container will be accessible at localhost:80).

Containers may also have access to every service on the host machine that is listening on some port. This is why the HOST_IP address is set in the .env file and you MUST set it to the IP address of an interface from the host machine.

Configuration

There is the .env file where you can set up the following variables:

  • HOST_IP: IP address of a interface from the host machine; defaults to the first IP associated on the host
  • NETWORK: IP addresses class for Docker containers in CIDR notation (IP/mask); default is 172.72.0.0/24
  • OPENSIPS_IP: IP address of the OpenSIPS container; default is 172.72.0.2
  • MYSQL_IP: IP address of the MySQL container; default is 172.72.0.3
  • MYSQL_ROOT_PASSWORD: root password for MySQL container; default is root
  • MYSQL_DATABASE: database name for OpenSIPS; default is opensips
  • MYSQL_USER: database user for OpenSIPS; default is opensips
  • MYSQL_PASSWORD: password for OpenSIPS database user; default is opensipsrw
  • CP_IP: IP address of the OpenSIPS-CP container; default is 172.72.0.4
  • RTPPROXY_IP: IP address of the RTPProxy container; default is 172.72.0.5
  • RTPPROXY_PORT: listening port for RTPProxy; default is 7899
  • MINPORT: minimum of the port range for RTPProxy; default is 30000
  • MAXPORT: maximum of the port range for RTPProxy; default is 30100
  • FREESWITCH_IP: IP address of the FreeSWITCH container; default is 172.72.0.6
  • ENABLE_HOMER: enable or disable Homer SIP capture (yes/no); check the Homer section to enable it; default is no/disabled
  • HOMER_IP: Homer IP used to trace the traffic; check the Homer; default is HOST_IP
  • HOMER_Port: Homer port used to trace the traffic; check the Homer; default is 9060
  • DEFAULT_DOMAIN: a default domain provided for OpenSIPS; default is domain.sip

Start Service

Once the configuration is finalized (i.e. editting the .env file), you can start the service using:

docker-compose up  # if you use the standalone Docker Compose

# use --build when you need to rebuild the images (e.g. after editing the modules.inc.php)
docker-compose up --build

# or
docker compose up --build  # if you use the Docker Compose plugin

# add -d to run in detached mode
docker-compose up --build -d