Guides

Environment and Components

Review server, operating system, and dependency requirements.

Terminology conventions

OpenIMSDK: The umbrella project name, encompassing OpenIMClientSDK and OpenIMServer.
OpenIMClientSDK: The client-side SDK.
OpenIMServer: The core instant messaging server.
ChatServer: The business extension server. The documentation no longer uses Chat as an isolated standalone product name.
App Administrator: The backend administrative role that invokes management APIs (such as 10009).

Version and branch strategy

main: The active development branch containing unreleased changes; not recommended for production environments.
vX.Y.Z...: Stable release tag naming convention.
For production environments, always prefer the latest official release designated by the green Latest badge on GitHub Releases.
Pin an explicit stable release tag whenever you need reproducible troubleshooting, canary rollbacks, or consistent environments.

Environment requirements

Item	Specification	Additional notes
Operating system	Linux	Official deployments run on `Ubuntu 22.04`; verified on `Debian 13` as well
Hardware resources	8 CPU cores, 16 GB RAM, 10 Mbps bandwidth, 1 TB disk	Sized for 100,000 registered users, 10% daily active users, a 50,000-member group, and 600 messages per second; public IP required
CPU architecture	`x86_64`, `arm64`	Other architectures require independent validation
Go	`v1.22.7` or later	Installation guide
Docker	`v24.0.5` or later	Includes built-in Compose functionality
Git	`v2.17.1` or later	Installation guide

External component requirements

Component	Recommended version	Supported modes	Cloud services / Notes
MongoDB	`v7.0`	`standalone`, `replicaSet`, `sharded`	Supported; prefer using `uri` when connecting to replica sets or sharded clusters
Redis	`v7.0.0`	`standalone`, `cluster`, `sentinel`	Supported
Etcd	`v3.5.13`	Single-node, multi-node cluster	Managed cloud services are not supported
Kafka	`v3.5.1`	Single-node, distributed cluster	Supported; pre-create topics according to Source deployment
MinIO	`RELEASE.2024-01-11T07-46-16Z`	Single-node	Can be replaced with S3-compatible object storage (Tencent Cloud COS, Alibaba Cloud OSS, Qiniu Kodo, AWS S3)