Skip to content

Server Database Requirements

Rox.Chat Server places the content accumulated during operation in four types of storage:

  • In the file system (on the file server). Files sent by users and agents, as well as files uploaded by administrators (e.g., agent avatars, button-images, etc.) are stored here.

  • In the analytical relational database (on the relational DBMS server). All information necessary for the service operation is stored here - agents, chats, categories, surveys, dialogs, etc.

  • In a columnar DBMS (on the columnar DBMS server) - optional. The columnar DBMS (currently only available on ClickHouse) stores information used by the Statistics v2 module.

  • In the search engine (on the search engine server) - optional. The search engine is used for quick search in Dialog History.

What kind of content do we accumulate? This is information about your visitors, agents, supervisors, and administrators, system settings, history of dialogs with them, files transferred between agents and visitors, statistics, etc.

Rox.Chat Server stores basic system settings, certificates, enhancements, avatars, and transferred files (images uploaded by clients and agents, etc.) in the file system.

All other data is stored in databases. In particular, each Rox.Chat account in a relational DBMS stores information in two schemas: if the customer is hosted in the cloud, these are the roxchat_site and roxchat_service_pro_<account> schemas. If the client is hosted on the customer's facilities, they are roxchat_hosted_meta and roxchat_service_pro_<account>. The columnar DBMS stores the statistics data.

All server functions (file storage, relational DBMS, columnar DBMS, search engine, Rox.Chat Server) can formally run on a single host, but this configuration is not recommended. Maximum performance is achieved when they are distributed on multiple servers.

Requirements for relational DBMSs in case of hosted installation:

Parameter Value Features
DBMS MySQL 5.7, MariaDB 10.2 or PostgreSQL 14.2 Microsoft SQL Server by special request
DBMS user
  • MySQL: roxchat_site (for roxchat_site/roxchat_hosted_meta)
    roxchat_service in cloud and roxchat_hosted_pro in hosted mode (for roxchat_hosted_pro)
  • PostgreSQL: roxchat_service
 Create the specified technical accounts in the database. The created accounts must have all privileges within the working database.
TCP/IP port 3306 (default for MySQL и MariaDB), 5432 (default for PostgreSQL) Any other port can be used. Reconfiguration of the DBMS, Rox.Chat and firewalls will be required. Check that there are no conflicts on the new port.
DB access driver InnoDB or MyISAM (if MySQL is selected) Different drivers apply to different tables.
DB storage volume 100GB (up to 20 agents)
500GB (up to 100 agents)		 Depends on work intensity and data storage period
Other hardware options Same as application server parameters See Server hardware requirements

It is necessary to configure the DBMS server to accept queries from Rox.Chat Server over the network and not to accept anonymous queries. For PosgreSQL, you must additionally specify the IP address where the Rox.Chat Server is hosted.

Storage requirements related to hard disk can be found in Hard Disk Requirements.

Rox.Chat databases are created automatically when Rox.Chat Server is installed. You only need to ensure that the environment parameters described in the table.

Rox.Chat recommends that you configure automatic backup of your database. For highly loaded systems it is advisable to configure replication to a second DBMS server to increase uptime.

Requirements for columnar DBMSs when deploying the service at the customer's facilities (hosted installation):

Parameter Value Features
DBMS ClickHouse 22.2.2
DBMS Users default The default user has root privileges by default. You can use it with full access or create a new user with full access.
TCP/IP port 8123, 9000 Any other port can be used. DBMS, Rox.Chat and firewalls will need to be reconfigured. Verify that there are no conflicts on the new port.
Database access driver JDBC There is an official JDBC driver and third-party drivers (see ClickHouse documentation).
Database space 100GB (up to 20 agents)
500GB (up to 100 agents)		 Depends on work intensity and data retention period
Other hardware parameters Same as Application Server See Application Server Hardware Requirements

Requirements for resident DBMSs when the service is hosted installation:

Parameter Value Features
DBMS Redis Used to run the delta-proxy server.
DBMS Users default DBMS user by default.
TCP/IP port 6379 Default port.
Database space At least 4 GB of RAM per instance, at least 10 GB of ROM per instance

Requirements to the search system when the service is hosted installation:

Parameter Value Features
DBMS Elasticsearch 8.5.3 The version of Elasticsearch on which the service is tested is specified.
DBMS Users elastic The elastic user has root privileges by default. You can use it with full access or create a new user with full access.
TCP/IP port 9200 Any other port can be used. The DBMS, Rox.Chat Server and firewalls will need to be reconfigured. Make sure there are no conflicts on the new port.
Database space At least 4 times the amount of RAM in use See Elasticsearch documentation.
Other hardware parameters Match those of the application server See Server hardware requirements.