Table of contents

1. Introduction

The OpenGate Containers module allows you to manage VoIP connections in an OpenGate environment, as well as to configure extensions, trunks, etc. This guide explains how to perform a quick installation. Please refer to the Presence Installation Guides for more information about the different modules and architectures.

2. Installation

2.1. Prerequisites

To complete a successful installation and ensure a proper operation as described in this guide, the following must be met:

• Have a “host” machine with a recent version of Docker Engine and Docker Compose installed.

• The “host” machine must have the network properly configured according to the network architecture.

  • In case of a Master node configured with a SIP Registrar, at least two IPs are required.

• The “host” machine should not execute other services which may clash with the ports used in your services.

  • Exception: The Master node should have an MTA installed, such as “postfix” to send voicemail emails.

  • When a “SMTP relay" server is required, it must be configured as detailed in Configuring email relay for voicemails .

• The “host” machine must not limit the connection to your services through a firewall.

Refer to the following quick guide: Rocky Linux 9 (or Red Hat 9) - Quick Installation with Docker

2.2. General installation process

There are different types of environments which require different services to be started (Master, Node, WebRTC, and combinations of these), and therefore a help script is provided that automates the following steps: Creating the docker-compose.yml and .env files, creating the secrets, connecting to the registry and pulling the images. This script can be launched directly using the following command:

Replace MODE with one of the following:

• master: Installs postgresql, ssh-server, webservices, kamailio and asterisk.

• masterwebrtc: Same as master, but adds freeswitch to use as WebRTC Gateway.

• masteronlywebrtc: Does not include kamailio, which allows you to use it in environments with a single IP with WebRTC phones. However, no Agent/SIP user extensions can be registered.

• node: Installs asterisk and ssh-server.

• nodewebrtc: Same as node, but adds freeswitch to use as WebRTC Gateway.

• webrtc: Installs freeswitch and ssh-server.

• turn: Installs coturn server.

The optional parameter -norecording configures an environment without integration with Presence Recording, eliminating the need to set up a shared folder for recordings.

If you run this command on a previous existing environment, you will be prompted to proceed before replacing the docker-compose.yml and .env files. A backup copy of these files (ending in .bak) will be created, so you can review them if you choose to overwrite. This could be useful if you want to convert a previous installation (e.g. a master to masterwebrtc).

2.3. Additional technical information

Refer to this document: OpenGate Containers - Additional Technical Information

3. Installing a sample Master + Node + WebRTC

3.1. Installing the OpenGate Master

Run the install command, specifying the master option.

After executing this command, connection to the registry will be automatically established and images will be pulled.

Open

Command progress example

When done, the following screen will prompt you to configure the environments in the.env file, and will also show the instructions to create secrets. Something like this:

Edit the .env file using your preferred editor, and configure at least the following lines:

• DATA_BINDADDR: Set the IP address of the data network.

• VOICE_BINDADDR: Set the IP address of the voice network. If you do not set up voice/data separation, use the same as before.

• SIP_REGISTRAR_IP: Set the IP address of the SIP Registrar. This cannot be one of the previous IPs. Make sure to configure two IP addresses in the host operating system.

• RECORDING_SHARE, RECORDING_SHARE_USER y RECORDING_SHARE_PASSWORD: Set the parameters for the shared recordings folder.

Filenames starting with a dot (such as .env) are hidden in Linux. If you connect using a graphical interface, please make sure to enable the option to show those files.

Open

Example. MobaXterm option to show hidden files

Next, execute the steps to create the secrets:

• Replace MYPASSWORD with the password you want:

  This password and the value of the DB_USER variable (opengaterw, by default) must match the configuration set up in the Presence OpenGate Proxy Server Configuration program.

• Generate the SSH keys:

   

• Generate self-signed certificates if you do not have your own (if you have one, place it in secrets/asterisk.pem):

  • Then, concatenate the two resulting files into a single one at the corresponding path:

Finally, start with the command below:

3.2. Installing the OpenGate Node

Run the install command, specifying the node option.

After executing this command, connection to the registry will be automatically established and images will be pulled.

When done, a screen will prompt you to configure the environments in the.env file, and will also show the instructions to create secrets.

Edit the .env file using your preferred editor, and configure at least the following lines:

• DATA_BINDADDR: Set the IP address of the data network.

• VOICE_BINDADDR: Set the IP address of the voice network. If you do not set up voice/data separation, use the same as before.

• RECORDING_SHARE, RECORDING_SHARE_USER y RECORDING_SHARE_PASSWORD: Set the parameters for the shared recordings folder.

Next, execute the steps to create the secrets:

• Copy the SSH public key you generated on the Master server. You can do this either by manually using a graphical SFTP/SCP client or by executing the following command on the node:

  Where opengate is the user you configured on the operating system of the Master server, and MASTERIP is its IP address. You will need to correctly enter the password for the opengate user of the Master machine when prompted.

• Generate self-signed certificates if you do not have your own (if you have one, place it in secrets/asterisk.pem):

  • Then, concatenate the two resulting files into a single one at the corresponding path:

Finally, start with the command below:

3.3. Installing the OpenGate WebRTC Gateway

Run the install command, specifying the webrtc option.

After executing this command, connection to the registry will be automatically established and images will be pulled.

When done, a screen will prompt you to configure the environments in the.env file, and will also show the instructions to create secrets.

Edit the .env file using your preferred editor, and configure at least the following lines:

• WSS_BINDADDR: Set the IP address of the DMZ network (if you don’t have DMZ/Private network separation, enter the Private network IP).

• WSS_EXTERNAL_IP: Set the public external IP address of the system.

Next, execute the steps to create the secrets:

• Copy the SSH public key you generated on the Master server. You can do this either by manually using a graphical SFTP/SCP client or by executing the following command on the node:

  Where opengate is the user you configured on the operating system of the Master server, and MASTERIP is its IP address. You will need to correctly enter the password for the opengate user of the Master machine when prompted.

• Generate self-signed certificates if you do not have your own (if you have one, place it in secrets/freeswitch.pem):

  • Then, concatenate the two resulting files into a single one at the corresponding path:

Finally, start with the command below:

4. Update

1. Edit the docker-compose.yml file and check tags from all images.

   1. Tags pointing to :latest will automatically download the latest version.

   2. Alternatively, indicate a specific release (example: release-01). Please, check https://enghouseglobal.atlassian.net/wiki/spaces/PSRN.

2. Run the following commands to update and start the environment again:

3. The above commands will cause that containers with changes (and also depending containers) to restart.

Once the environment is up and running, old images can be cleared using docker image prune.

5. Restoring from backup

1. Edit the .env file in the Master node to set the variable RESTORE_MODE=true.

2. Stop Presence OpenGate Proxy Server and any other applications that may be using the database. Apply the changes using the following command: docker compose up -d.

3. Wait for the environment to get started again. Then, access the Master node IP from a web browser.
   
   

   1. Load the backup copy and follow the steps.

   2. If the restore process is performed using a backup copy generated with another database user (e.g., for 12.3 or 13.0 updates), you may expect many changes related to permissions in the above first step.

4. When all the steps are completed, edit the .env file in the Master node. Set the variable RESTORE_MODE=false and apply using the following command: docker compose up -d.

6. IMPORTANT

Certain technical details are important to keep in mind:

• You MUST NOT change the database username once the environment has been started for the first time. The PostgreSQL official container creates the database for the user specified in the first boot. If you subsequently change that user, the database will not start successfully.

• Docker compose does not update the configuration of CIFS volumes (such as the recordings volume of Presence Recording). If you wish to modify this configuration once the volume has been created, you must first stop the environment, then delete the volume using the following command: docker compose down; docker volume rm VOLUME_NAME, and start the environment with docker compose up -d.

• If you make a change that results in the creation of a new container (e.g. a change to the image, one environment variable or volume), then the previous trace logs will be lost.

  • Make a backup if you deem it necessary. For example, a backup of the last 48 hours: docker compose logs -t --since 48h | gzip -c > 48hlogs.gz.

• In case of a core dump in a service that is running in a container, the kernel configuration of the host machine is inherited, which means that this configuration will be saved in the host as specified. For Rocky Linux 9, these are stored in /var/lib/systemd/coredumps.

6.1. Directory of recordings

Because of the change made to set absolute paths, it is important to update the configuration of Presence Recording Server so that the new absolute paths will be used as shown below:

Note that the /recordings part of the path must match the RECORDING_MOUNT_POINT=/recordings variable. If you change this to another value, then the path configured in the Recording Server must be modified accordingly.