Guides
Ports and Network
Configure firewall rules, exposed ports, and SDK access addresses.
Without a domain or TLS certificate
Allow the following ports through the server firewall. Do not expose other ports publicly.
| Module | Port | Purpose | Action |
|---|---|---|---|
| OpenIMServer | TCP 10001 | WebSocket messaging for OpenIMClientSDK | Allow |
| OpenIMServer | TCP 10002 | User, friend, group, message, and other APIs | Allow |
| OpenIMServer | TCP 10005 | MinIO object storage | Allow |
| ChatServer | TCP 10008 | App business APIs such as registration and login | Allow |
| ChatServer | TCP 10009 | App Administrator APIs such as statistics and account suspension | Allow |
| Web frontend (optional) | TCP 11001 | PC Web frontend, required for browser verification | Allow as needed |
| Admin frontend (optional) | TCP 11002 | App Administrator frontend | Allow as needed |
Initialize OpenIMClientSDK with:
apiAddr: http://your_server_ip:10002
wsAddr: ws://your_server_ip:10001With a domain and TLS certificate
Only expose the default HTTPS port, TCP 443; restrict all other service ports to the private network. Configure DNS and bind the IP first, then follow Domain configuration to configure certificates and reverse proxies.
Initialize OpenIMClientSDK with:
apiAddr: https://your_domain.com/api
wsAddr: wss://your_domain.com/msg_gatewayIf you use the browser procedure in Deployment verification to access port 11001 directly, that port must be reachable. Otherwise, do not expose 11001 or 11002 publicly.