...

...

...

...

1. Application Server Installation

1.1 Application Server Hardware requirements

Storage

• Applications Services basic storage

...

For file storage, we support two methods: local storage and object storage. The necessary hard drive space largely depends on your usage, the size, and number of attachments that you receive through your conversations etc.

Consider using a an object storage option provided by AWS, Azure etc., if you want to stay flexible and accomodate accommodate the growing storage requirements. CloudCX also supports other s3 api S3 API compatible services, for example: Minio.

...

CPU requirements are dependent on the usage and expected workload. Your workload is influenced by factors such as - — but not limited to - — how active your users are, how many conversations do you recieve receive and the conversation channels which you are using.

...

Memory requirements are dependent on the usage and expected workload. Your workload is influenced by factors such as - — but not limited to - — How active your users are, how many conversations do you recieve receive and the conversation channels which you are using.

The following is the recommended minimum Memory hardware guidance for a handful of example CloudCX conversation base sizes.

• 8GB 8 GB RAM is the required minimum memory size and supports up to 10,000 conversations a day.

  • We are always working to reduce the memory requirement.

• 16GB 16 GB RAM supports up to 20,000 conversations a day.

• More conversations? Consider scaling horizontally by adding more application servers.

1.2 Preparing the Linux Host Machine

...

Tasks that MUST be completed before installing CloudCX application

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

• Install all available updates & service packs before installing CloudCX.

• Do not install PostgreSQL on your CloudCX 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.

• CloudCX must NOT be installed on a host that is a DNS or DHCP server.

• Port must be permitted by your firewall: TCP: 9006, 9001, 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 the server must have at least 8G of memory.

• Please reserve 50G space to install & use the CloudCX application.

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

Note: If the CloudfCX CloudCX 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.

1.3 Installation Steps of Application Server

...

Panel
panelIconId atlassian-note panelIcon :note: bgColor #FFFAE6
NOTE: Before install Application Server, please reference https://cloudfon.atlassian.net/wiki/spaces/CCSD/pages/edit-v2/48857403#Install-CloudCX-Midware-Server to install Midware services(DB&Redis) first

1.3.1 Make directory and change directory

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

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

1.3.2 Download install scripts

Code Block
language bash
curl https://raw.githubusercontent.com/cloud-cx/cloudfon-cx-install/main/v3v4.30.x0/cloud_cx_ctl.sh -o cloud_cx_ctl.sh

Code Block
curl https://raw.githubusercontent.com/cloud-cx/cloudfon-cx-install/main/v3v4.20.x0/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.

1.3.3 Install docker environment and configure firewall.

Code Block
/bin/sh install_docker_cx.sh

1.3.4 Install CX Application Service

Code Block
sh cloud_cx_ctl.sh run -i puteyun/cloud_cx:${tag} -t api -w ${db_addr} -m ${db_passwd} -r ${redis_passwd}

Note: Please MUST replace the Variables in the above command with the correctly correct value

• ${tag} is the release version of CloudCX, for example: 35.2.31

• ${db_addr} is the Database Server address of CX (Midware Services Address). It is recommended to keep the Midware in the same LAN for local installations or on the same switch for cloud installations to ensure better performance and connectivity.

• ${db_passwd} is the password of the database

• ${redis_passwd} is the password of the Redis

1.3.5 Login and configure the

...

CloudCX.

Open Browser, input “https://host:9006/”, the “host” is the IP address or domain name of your CloudCX server (Linux Server). 

Info
IMPORTANT: To complete CloudCX initial configuration, please refer to 'System initialization ' guide.

1.3.6 CX Control Commands

• Show CloudCX services status

...

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

Install CloudCX Midware Server

...

2. Midware Server (MariaDB & Redis) Installation

2.1 Midware Server Hardware requirements

Midware Server includes database and caching services，default services, default database is MariaDB and the caching service is Redis. Normally, they will be deployed on the same server. You can install it with one click according to our Midware Service installation script.

...

The server running MariaDB & Redis should have at least 8 GB of RAM, though the exact requirements depend on the usage of your CloudCX Instance.

2.2 Preparing the Linux Host Machine

...

Tasks that MUST be completed before installing CloudCX Midware:

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

• Install all available updates & service packs before installing Midware.

• Do not install PostgreSQL on your Midware 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.

• Midware must NOT be installed on a host that is a DNS or DHCP server.

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

• Ensure the server must have at least 8G of memory.

• Please reserve at least 10G space to install the Midware application.

• Midware recommends deploying on the same LAN as the CloudCX application server(It's best to use the same switch in the cloud)

• Mideware can also be deployed under different switches in the cloud, which requires exposing the ports of the database and Redis. Firewall policies can be added to control that only CloudCX application servers are allowed to access.

2.3 Midware Server Installation Steps

• Make directory and change directory

...

• Download install scripts

curl https://raw.githubusercontent.com/cloud-cx/cloudfon-cx-install/main/v3v4.30.x0/cloud_cx_ctl.sh -o cloud_cx_ctl.sh

curl https://raw.githubusercontent.com/cloud-cx/cloudfon-cx-install/main/v3v4.20.x0/install_docker_cx.sh -o install_docker_cx.sh

...

• Install docker environment and configure firewalfirewall.

/bin/sh install_docker_cx.sh

...

...

3. Uninstall

...

CloudCX

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

Uninstall the CX

...