Guides
Environment and Components
Review server, operating system, and dependency requirements.
Terminology
- OpenIMSDK: The umbrella project name, including OpenIMClientSDK and OpenIMServer.
- OpenIMClientSDK: The client SDK.
- OpenIMServer: The core IM server.
- ChatServer: The business extension server. This documentation no longer uses
Chatas a standalone product name. - App Administrator: The backend management role that calls administrative APIs such as
10009.
Version and branch strategy
main: The development branch for continuously integrated, unreleased changes. It is not recommended for production.vX.Y.Z...: The naming convention for stable releases.- For production, prefer the latest official release marked with the green Latest badge on GitHub Releases.
- Pin an explicit stable release tag when you need reproducible troubleshooting, staged rollback, or consistency across environments.
Environment requirements
| Item | Requirement | Notes |
|---|---|---|
| Operating system | Linux | Official deployments use Ubuntu 22.04; Debian 13 has also been verified |
| Hardware | 8 CPU cores, 16 GB RAM, 10 Mbps bandwidth, 1 TB disk | Estimated for 100,000 registered users, 10% daily online users, a 50,000-member group, and 600 messages per second; requires a public IP |
| CPU architecture | x86_64, arm64 | Test other architectures separately |
| Go | v1.22.7 or later | Installation guide |
| Docker | v24.0.5 or later | Includes Docker Compose |
| Git | v2.17.1 or later | Downloads |
External component requirements
| Component | Recommended version | Supported modes | Cloud support and notes |
|---|---|---|---|
| MongoDB | v7.0 | standalone, replicaSet, sharded | Supported; prefer uri for a replica set or sharded cluster |
| 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; when deploying it yourself, create the required topics first |
| MinIO | RELEASE.2024-01-11T07-46-16Z | Single node | Can be replaced by S3-compatible storage such as COS, OSS, Kodo, or AWS S3 |