/WuKongIM

8年积累,沉淀出来的高性能通用实时通讯服务,支持即时通讯(聊天软件)(IM)(Chat),消息推送,消息中台,音视频信令,直播弹幕,客服系统,AI通讯,即时社区等场景

Primary LanguageGoApache License 2.0Apache-2.0

WuKongIM (Make information transfer easier)

8 years of accumulation, precipitated a high-performance universal communication service,message center, supporting instant messaging, message push, IoT communication, audio and video signaling, live broadcast barrage, customer service system, AI communication, instant community and other scenarios.

(Note: This project is a general underlying instant messaging service. The upper layer needs to dock with its own specific business system (which can be easily docked with its own business system through the webhook and datasource mechanism). The core of this project mainly maintains a large number of long connections of clients and delivers messages according to the message rules of third-party business systems.)

This project needs to be compiled in a go1.20.0 or higher version.

Web chat scene demo: http://imdemo.githubim.com

Backend monitoring demo: http://monitor.githubim.com/web

中文文档

Demo

Practical Project

TangSengDaoDao (communication layer based on WuKongIM): https://github.com/TangSengDaoDao/TangSengDaoDaoServer

Chat Demo

image

Features

  • 📚 Fully self-developed: WuKongIM uses a self-developed message database, binary protocol, and network library, and supports custom protocols.
  • 🚀 High performance: WuKongIM can handle millions of online users and has a throughput of 160,000 messages per second (including database operations).
  • 🔔 Zero dependencies: WuKongIM has no third-party dependencies and is easy to deploy.
  • 🔐 Security: WuKongIM encrypts both message channels and message content to prevent man-in-the-middle attacks and message tampering.
  • 🧱 Highly extensible: WuKongIM uses a channel-based design and currently supports group and point-to-point channels. It can be extended to support custom channels for use cases such as chatbots and customer service.

TODO

  • Supports custom messages
  • Supports subscription/publisher mode
  • Supports personal/group chat/customer service/community news channels
  • Supports channel blacklists
  • Supports channel whitelists
  • Supports permanent message storage, device switching, and message retention
  • Supports online status and multiple devices logged in simultaneously with the same account
  • Supports real-time synchronization of messages across multiple devices
  • Supports server-side maintenance of user's recent conversation list
  • Supports command messages
  • Supports offline command interface
  • Supports Webhook, easy integration with your own business system
  • Supports Datasoure, seamless integration with your own business system data source
  • Supports WebSocket connections
  • Supports TLS 1.3
  • Development of monitoring system
  • Support for Windows system (For development use only)
  • Supports streaming messages, similar to the output stream of chatgpt results.
  • Supports distributed systems

Quick Start

# install
curl -sSL https://gitee.com/WuKongDev/WuKongIMCli/raw/main/install.sh | sudo bash 

# run
wk run 

The configuration file is located at ~/wukongim/wk.yaml (restart the service after modifying the configuration).

By default, it uses a local area network address. If you need external access, you need to modify the external.ip in the configuration file to the server's external IP. As follows:

external:
  ip: 'xxx.xxx.xx.xxx'

View System information: http://127.0.0.1:5001/varz

View Monitor information: http://127.0.0.1:5300/web

Demo: http://127.0.0.1:5172/chatdemo

For more deployment options, see the documentation.

Port explanation:

5001: API port
5100: TCP long connection port
5172: Demo port
5200: WebSocket long connection port
5300: Monitoring system port

SDK source code and demos

Project Name Github Address Gitee Address Open Source License Description
WuKongIM Github Gitee Apache2.0 WuKongIM communication end, responsible for long connection maintenance, message delivery, etc.
WuKongIMAndroidSDK Github Gitee Apache2.0 WuKongIM's Android SDK
WuKongIMiOSSDK Github Gitee Apache2.0 WuKongIM's iOS SDK
WuKongIMUniappSDK Github Gitee Apache2.0 WuKongIM's Uniapp SDK
WuKongIMJSSDK Github Gitee Apache2.0 WuKongIM's JS SDK
WuKongIMReactNativeDemo Github None Apache2.0 WuKongIM's React Native Demo (provided by contributor wengqianshan)
WuKongIMFlutterSDK None None Apache2.0 WuKongIM's Flutter SDK (under development)

Illustration

Architecture

image

Business System Integration

image

Webhook

image

Applicable Scenarios

Instant Messaging

  • Supports group channels
  • Supports personal channels
  • Supports permanent message storage
  • Supports offline message push
  • Supports recent conversation maintenance

Message Push/Site Message

  • Supports group channels
  • Supports personal channels
  • Supports offline message push

IoT Communication

  • Supports MQTT protocol (to be developed)
  • Supports publish and subscribe

Audio and Video Signaling Server

  • Supports temporary command message delivery

Live Broadcast Bullet Screens

  • Supports temporary message delivery
  • Supports temporary subscriber support

Customer Service System

  • Supports customer service channels
  • Messages can be delivered to third-party servers
  • Third-party servers can decide to allocate designated subscribers to deliver messages in groups

Real-time AI Feedback

  • Supports pushing messages sent by clients to third-party servers, and the results returned by AI after being fed back by third-party servers are pushed back to clients

Instant Community

  • Supports community channels
  • Supports message delivery in topic mode

Monitor

image image image image image

Star

Our team has been committed to the research and development of instant messaging. We need your encouragement. If you find this project helpful, please give it a star. Your support is our greatest motivation.

Wechat

If necessary, add me and I will invite you to the group. My WeChat ID is wukongimgo.

image

License

WuKongIM is licensed under the Apache License 2.0.