Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Supported Linux OS

  • Ubuntu 20.04 (LTS) Focal, Ubuntu Impish 21.10, Ubuntu 22.04 (LTS) Jammy

  • Debian Buster 10, Debian Bullseye 11

  • It only supports 64bit OS

Hardware Requirements

In order to ensure the normal operation of the server's functions, the following are some configuration suggestions, and the specific requirements will change according to the actual situation.

Agents(Online)

vCPUs

Memory

Disk

50

4

8

100G

200

8

16

500G

500

16

32

1000G

Note: It is best to consider the scalability of subsequent CPU, memory, and disk during deployment.

Note: Please note that this is only a basic configuration required for CX system deployment. With the use of the system and the increase in configuration and storage information, hardware resources need to be further expanded.

Info
  1. Each CPU core need 2.5Ghz or Higher.

  2. In terms of disk storage, as more information is stored, it will need to be expanded again, and subsequent dynamic expansion needs to be considered during deployment

  3. If using third-party Oss, such as AWS S3/Azure Blob/Mini, please activate storage services with the same storage size according to the situation.

Preparing the Linux Host Machine for Installation

Tasks that MUST be completed before installing CloudFon CX

  • If the Linux on which Cloudfon CX will be installed is located in LAN, assign a static LAN IP address; if it's in a public network, please assign a static IP address for the public network.

  • Install all available updates & service packs before installing Cloudfon CX.

  • Do not install PostgreSQL on your Cloudfon CX Server.

  • Ensure that all power-saving options for your System and Network adapters are disabled (by setting the system to High Performance).

  • Do not install TeamViewer, VPN, and other similar software on the host machine.

  • The CloudFon CX must not be installed on a host that is a DNS or DHCP server.

  • Port must be permitted by your firewall: TCP: 9001,9006,443

  • Please also ensure the above ports have not been used by other applications.

  • Ensure server date-time is synced correctly, how to check date-time?

  • Ensure server that must has more than 8G of memory.

  • Please reserve 100G space to install & use the Cloudfon CX (The amount of disk used depends on the number of agents you plan to deploy and the subsequent session history and related files).

  • Must perform all Linux commands by the root user, please su root First.

Note: If the Cloudfon CX runs on a Cloud platform such as AWS, and the cloud platform has the firewall itself, you MUST open the ports on the cloud platform firewall too.

Note: All the following Linux commands must be executed in the same working path, which is assumed to be /root/cloudfon_cx in this example.

Note: The installation steps may need about 20 minutes to complete.

Installation Steps

1. Make directory and change directory

Code Block
mkdir -p /root/cloud_cx/ && cd /root/cloud_cx/

Note: cloud_cx is an example here, you can change to your directory name, and this directory will storage user data.

2. Download install scripts

Code Block
curl https://raw.githubusercontent.com/cloud-cx/cloudfon-cx-install/main/v3.2.x/cloudfon_cx_ctl.sh -o cloud_cx_ctl.sh
Code Block
curl https://raw.githubusercontent.com/cloud-cx/cloudfon-cx-install/main/v3.2.x/install_docker_cx.sh -o install_docker_cx.sh

Note: cloud_cx_ctl.sh is an example here, you can download and rename to your name.

3. Install docker environment and configure firewall.

Code Block
/bin/sh install_docker_cx.sh

4. Install MySQL, CX Service, etc.

Code Block
/bin/sh cloud_cx_ctl.sh run -i puteyun/cloud_cx:${tag}

Note: ${tag} is the release version of CloudFon CX, for example: 3.2. X,

Please MUST replace the tag in the above command with the latest tag. The latest version is 3.2.2.3

/bin/sh cloud_cx_ctl.sh run -i puteyun/cloud_cx:3.2.2.3

5. Login and configure the CloudFon CX.

Open Browser, input “https://IP_Address:9006/”, the “IP_Address” is the IP address of your Cloudfon CX server (Linux Server). 

Info

IMPORTANT: To complete CloudFon CX initial configuration, please refer to 'System initialization' guide.

6. CX Control Commands

Show cloud-cx services status

Code Block
cd /root/cloud_cx && /bin/sh cloud_cx_ctl.sh status

Restart cloud-cx services

Code Block
cd /root/cloud_cx && /bin/sh cloud_cx_ctl.sh restart

Restart the selected service of cloud-cx

Code Block
cd /root/cloud_cx && /bin/sh cloud_cx_ctl.sh restart -s [Service Name]

Stop cloud-cx Services

Code Block
cd /root/cloud_cx && /bin/sh cloud_cx_ctl.sh stop

Stop the selected service of cloud-cx

Code Block
cd /root/cloud_cx && /bin/sh cloud_cx_ctl.sh stop -s [Service Name]

Start cloud-cx Services

Code Block
cd /root/cloud_cx && /bin/sh cloud_cx_ctl.sh start

Start the selected service of cloud-cx

Code Block
cd /root/cloud_cx && /bin/sh cloud_cx_ctl.sh start -s [Service Name]

Uninstall cloud-cx Services

Code Block
cd /root/cloud_cx && /bin/sh cloud_cx_ctl.sh rm

Uninstall Cloufon CX

Please use the below steps to uninstall the Cloudfon CX for Linux.

Uninstall the CX

Stop and delete the CX Docker instances.

Code Block
cd /root/cloud_cx
/bin/sh cloud_cx_ctl.sh stop
/bin/sh cloud_cx_ctl.sh rm
Note

The below commands will delete the CX data; please be careful.

Code Block
cd /root/
rm -fr cloud_cx

...

Info

This document will guide you how to install CloudCX on your own server.

There are two types of deployment way for you to select.

Easy heading
linkText4
linkText10
linkText3
linkText6
linkText5
relatedLinksLabels
linkText2
linkText1
headingTagsH1,H2,H3
sidebarMaxHeight450
linkType2Page
linkType3Page
linkType1Page
linkType10Page
sidebarTitleON THIS PAGE
linkUrl3
linkUrl4
linkUrl1
linkUrl2
linkUrl10
includedPageModeEnable_Included_Pages
linkText8
linkText7
relatedLinksOrderLabels_First
sidebarModeOpened
headingNumberingModeDisable_Numbering
linkText9
sidebarMarginRight60
relatedLinksTargetNew_Window
relatedLinksTitleRELATED LINKS
linkUrl9
linkUrl7
linkUrl8
numberedHeadingTagsH1,H2,H3
linkUrl5
linkUrl6
linkType8Page
linkType9Page
linkType6Page
headingLinkTextModeWrap
linkType7Page
linkType4Page
linkType5Page
sidebarWidth300
sidebarTop300
headingLinkExpandModeExpand_All_By_Default
headingLinkIndent20

Installation Overview

We recommend that you separate the database from the application service during installation to increase its load. The calculation of the database will reduce the actual performance of the application, which will be described in detail in this article.

...

If you are just a demo deployment for testing, please refer to Testing Environment for additional instructions.

Supported Linux OS

  • Ubuntu 20.04 (LTS) Focal, Ubuntu Impish 21.10, Ubuntu 22.04 (LTS) Jammy

  • Debian Buster 10, Debian Bullseye 11, Debian Bookworm 12

  • It only supports 64bit OS

Installation of CloudCX is possible on most UNIX environments, but not officially supported.

Two Types of Deployment Way

Distributed Deployment

Standalone Deployment