OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse OpenIMSDK Guides
GUIDESOpenIMSDK Guides

OpenIMSDK guides organized by implementation stage, from product concepts and deployment to integration, extension, operations, and reliability.

Guides

Deploy OpenIMServer and ChatServer

From environment planning through production verification for single-node, air-gapped, and cluster deployments.

Deployment

Deploy OpenIMServer and ChatServer

From environment planning through production verification for single-node, air-gapped, and cluster deployments.

EnvEnvironment and Components

Review server, operating system, and dependency requirements.

DockerDocker Compose Deployment

Start OpenIMServer, ChatServer, and dependencies with openim-docker.

SourceSource Deployment

Build and run OpenIMServer and ChatServer from stable release tags.

OfflineAir-Gapped Deployment

Export deployment artifacts on an online builder and run them offline.

ClusterCluster Deployment

Deploy OpenIMServer across multiple nodes behind Nginx.

PortsPorts and Network

Configure firewall rules, exposed ports, and SDK access addresses.

DomainDomain Configuration

Route API and WebSocket traffic through production domains and TLS.

ProdProduction Checks

Understand runtime failures, recovery order, and post-recovery checks.

VerifyDeployment Verification

Verify APIs, WebSocket, admin console, and basic message delivery.