Prerequisites

Required Software

Preparation

1. Install Docker and Docker Compose

Follow the official instructions to install Docker and Docker Compose:

Verify the installation:

docker --version
docker-compose --version

2. Log rotation

Create the file /etc/docker/daemon.json

{
  "log-driver": "json-file",
  "log-opts": {
    "max-size": "250m",
    "max-file": "3"
  }
}

3. Configure a .env File

Create a CTLive folder with a .env file to define the required environment variables. Example:

CTLIVE_IMAGE_BASE=harbor.utils.reiteklab.eu.rd.eilab.biz
MONGODB_ADMIN_PASSWORD=MongoDBPasswordToUse
PUBLIC_URL=https://siotunnel.ei.eilabonline.biz/altitudeimchannel
INFOBIP_URL=https://gxxyr.api.infobip.com
REDIS_PASSWORD=RedisPasswordToUse

Ensure the .env file is secure:

chmod 600 .env

4. Installation of docker-compose.yaml

Download, into the same directory, docker-compose.yaml and nginx.conf file from https://bitbucket.org/enghouseglobal/ir-rt-reitek-ctlive_helm/src/main/docker-compose/

5. Enabling SSL

To enable SSL you need a valid SSL certificate for your domain/ip in PEM format.

Copy your crt and key file into a folder named cert

Tune nginx.conf file to load the cert files

    server {
        listen       80;
        listen       443 ssl;
        ssl_certificate "/etc/pki/nginx/server.crt";
        ssl_certificate_key "/etc/pki/nginx/server.key";

Docker Login

Before starting it’s required to login into the Enghouse Docker registry hosting CTLive images.

Ask to CTLive PM to provide valid credentials to be able to access to the image registry.

To do that run a command similar to the following and imput your username and passoword

docker login harbor.utils.reiteklab.eu.rd.eilab.biz/reitek/

Starting CTLive

  1. Start the Containers Run the following command:

    docker-compose up -d

  2. Check the Status Ensure all containers are running:

    docker-compose ps

  3. Access the Application Open a browser and visit:

    http://<hostname>/livechat/default/lib/livechatsdk.js
http://<hostname>/ctlivemgr

Configuration

Accesso to CTLiveMGR (http://<hostname>ctlivemgr) with:

From this application, you can assign a password to the tenant admin user, clicking on the admin tag

image-20250104-192229.png

Admin username and password can be used to login again into CTLiveMGR, to have full control of the CTLive domain configuration.

Troubleshooting

Check Logs

Use the following command:

docker compose logs -tf

To check logs of a single module specify the module name

docker compose logs ctlivemgr -tf

Flags:

  • -t is required to add timestamp to logs

  • -f to follow logs

Stopping and Removing CTLive

  1. Stop the Containers:

    docker-compose down

  2. Remove Volumes (if necessary):

    docker-compose down -v

Maintenance

Data Backup

Data is saved using a docker volumes named ctlive_mongodb_data.

To check the name of the volume:

docker volume ls | grep mongodb

To inspect the volume:

 docker inspect volume ctlive_mongodb_data

This is a possible output with the full path where data is store:

[
    {
        "CreatedAt": "2024-12-31T14:53:03+01:00",
        "Driver": "local",
        "Labels": {
            "com.docker.compose.project": "ctlive",
            "com.docker.compose.version": "2.27.0",
            "com.docker.compose.volume": "mongodb_data"
        },
        "Mountpoint": "/var/lib/docker/volumes/ctlive_mongodb_data/_data",
        "Name": "ctlive_mongodb_data",
        "Options": null,
        "Scope": "local"
    }
]

To back up the data:

docker run --rm --volumes-from mongodb -v $(pwd):/backup busybox tar czvf /backup/mongodb_backup.tar.gz /data/db