Page Comparison

📋 What’s about

The XCALLY Push Gateway, consists of different modules:

• Flexisip that includes:

  • a SIP proxy specifically used to handle SIP communications: via SIP comes the registration from a mobile phone and the push gateway takes the register notification and sends it to XCALLY server, which responds to push gateway and push gateway responds to mobile);

  • Push Notification system: when the app is in the background, the call comes to XCALLY and it's necessary to resume the app to manage the call. So there is a notification system that contacts Apple Push Notification which sends a notification to the agent's mobile. Device receives the Push Notification and agent can manage the call;
    Refer to the official Flexisip Configuration Reference Guide for detailed explanations of configuration parameters of flexisip.conf

• Redis Cache system used to keep in memory foreground and background devices;

• Redis Insight: cache dashboard to view what mobiles connected on database. By default dashboards are installed, so you can hook up your database, and if you have mobiles connected, you will see them on dashboard cache.

These modules are run through the docker, so container where the application runs regardless of the operating system. In fact the XCALLY App Flexisip Docker aims to build a Docker image based on Debian 12 with Flexisip, within a Dockerized environment for improved scalability and manageability.
In next sections you can find instructions on how to launch the docker compose file.

📁 Configuration folders and scenarios

To configure the push gateway you have to download the zip file reported below, firstly choosing if you want to install the push gateway:

Moreover as transport protocol, you can decide if you want to use TCP or TLS protocol with secure certificate.

Requirements

⚙️ Configuration Steps

📁 File to download

• With this command, you can download the file on the server:

curl -u 'public:bs4#)W]h8+VK),RV' --silent --location https://repository.xenialab.com/repository/provisioning/push-gateway/push-gateway.tar.gz -o /tmp/push-gateway.tar.gz

• Launch this command to unarchive:

• The push gateway folder will be created. To enter the folder, run the command:

Then you have to choose if you want to configure TCP or TLS. Explore the relative documentation to know the configuration procedure

🔧 TCP Configuration

• You have to retrieve your public IP

• Open your editor (e.g. vi or nano) and configure the flexisip.conf file:

• Modify Transports Configuration in the file:

• Open your editor (e.g. vi or nano):

vi /var/opt/push-gateway/docker-compose.yml

In flexisip service, you need to modify ports section:

#if you use push gateway on another server (stand alone solution)

ports:
  - 5060:5060
  - 5061:5061

#if you use the same server (by indicating the chosen ports) 
ports:
  - 9999:9999
  - 9998:9998

• Run docker container:

🔧 TLS Configuration

If instead, you want to use TLS, you need to copy your certificates data: KeyCert and Cert with Chain,that you will need when you configure the flexisip.conf file

• Enter in the folder and upload your TLS certificates:

• Open your favorite editor (e.g. vi or nano) and configure the flexisip.conf file:

• Modify Transports Configuration in the file:

• Now launch this command to run the docker container:

cd /var/opt/push-gateway
docker compose up -d

▶️ Useful commands

🛑 How to run and stop the containers

To stop and remove the containers (preserving the data), run the following command in the same directory as the docker-compose.yml file:

This command will stop and remove all containers associated with the docker-compose.yml file.

Otherwise, to remove the whole stack (including data):

Instead, to remove the single container:

To verify Container Startup: to verify the status of the containers, you have to run the command:

➡️ How to restart the container

<service name> is the name assigned within the docker-compose.yml

To recreate the single container:

👁️ How to view logs or status

To view container logs:

To view container status:

To access a container:

RedisInsight is the module installed in the docker compose file to view cache content (it works as cache dashboard).

• Add xc-redis Database in RedisInsight

On the first launch, add the xc-redis database in RedisInsight for Redis cache management

• Once running, you can access the RedisInsight web interface by opening your browser and navigating to:

Every time a mobile app is connected, you will see all the keys saved in cache memory.

The services are now running and ready to be used.

Logs Management

To view logs of flexisip: