Installation with Docker Compose

Having met the Solution Prerequisites

  1. Download the deployment script deploy.sh  and place it in the user home or any desired directory. This script will:
    1. delete the chat-solution directory if it exists.
    2. download the chat-solution deployment profiles in chat-solution directory from GitLab.
  2. To execute the script, give it the execute permissions and execute it. 

    # chmod 755 deploy.sh
    # ./deploy.sh
  3. To install NGINX and configure reverse proxy using NGINX, run the following script

    # cd chat-solution/reverse-proxy
    # chmod 775 nginx_install.sh
    # ./nginx_install.sh

    More information about reverse proxy configuration using NGINX can be found here.
    If NGINX doesn't startup after the configuration or doesn't pass requests to applications, execute following bash commands in host machine (for SELinux)

    setenforce 0
    systemctl restart nginx
  4. Set timezone according to the host machine timezone in <installation-directory>/chat-solution/docker/environment-variables/common-variables.env. The expected timezone value should be standard TZ Database Name. e.g.

    TZ=Asia/Karachi
  5. For a quick installation, please change these parameters in services environment variables files. Read Docker Services for a reference to understand and tweak Chat solution components environment configurations.

  6. Having environment configurations done,  navigate to to thechat-solutiondirectory and execute following commands: 

    #  chmod 755 docker_deployment_local_script.sh
    # ./docker_deployment_local_script.sh
  7. Type the name of the deployment profile to deploy. Choose the deployment profile that suits your requirement.

  8. If you are using articulate, open chat-solution/docker/environment-variables/rasa-connector-variables.env file and set the BOOTSTRAP environment variable value to true.
  9. Run the following command to ensure that all the components are up and running: 


    docker ps -a



    Services mentioned in the screenshot above must have status “Up”. If any service is not Up, see the Troubleshooting section.

  10. Access the customer chat gadget from (https://<fqdn>/customer-gadget), If you can see the following customer chat gadget loaded, the solution is up and running.



Next step:

Install the license key.

Final step:

Restart MRE service after license installation. This is a system limitation.

Core Chat Solution Services 

These are the service projects used by the core chat solution deployment profile.

Service

Exposed URL

chathttps://<fqdn>/chat
Socket Serverhttps://<fqdn>
mre-uihttps://<fqdn>/mre-ui
mre-microservicehttps://<fqdn>/mre-microservice
agent-gadgethttps://<fqdn>/agent-gadget
customer-gadgethttps://<fqdn>/customer-gadget
database-connectorhttps://<fqdn>/database-connector
sms-connectorhttps://<fqdn>/sms
ummhttps://<fqdn>/umm
ecm-front-endhttps://<fqdn>/ecm-frontend
knowledge-base-uihttps://<fqdn>/kb
file-enginehttps://<fqdn>/file-engine



Related articles