Docker-Compose

Prerequisites

Required Software

Docker: version 20.10 or higher
Docker Compose: version 2.0 or higher
Operating System: Linux (recommended)

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.cloudando.com
MONGODB_ADMIN_PASSWORD=[MongoDBPasswordToUse]
PUBLIC_URL=[Exposed url for whatsapp through Infobip e.g. https://public.ctlive.url]
INFOBIP_URL=[Infobip api base url e.g. https://gxxyr.api.infobip.com]
REDIS_PASSWORD=[RedisPasswordToUse]

Ensure the .env file is secure:

chmod 600 .env

4. Installation of `docker-compose.yaml`

Download installation package from Version Specific Documentation. Deflate the package into the installation folder /etc/ctlive

cd /etc/ctlive
tar xvzf /path/to/package/ctlive_dc_X_X_X.tar.gz

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.

Check Version Specific Documentation to get credetials to downaload container images.

To do that run a command similar to the following and input your username and password

docker login harbor.cloudando.com/reitek

Starting CTLive

Start the Containers Run the following command:
docker compose up -d
Check the Status Ensure all containers are running:
docker compose ps
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:

domain: ADMIN
username: userAdmin
password: <password configured in .env as MONGODB_ADMIN_PASSWORD

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

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

Stop the Containers:
docker compose down
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

Upgrade and Rollback

To upgrade, downgrade or rollback ctlive version, please check the following instructions Upgrade/Rollback docker-compose procedure