Go to file
xuzhijvn c208c3789f
fix: searchMessage method has potential NPE bug (#3287) (#3289)
2025-07-29 08:16:30 +00:00
.github docs: update slack link. (#3479) 2025-07-28 02:46:23 +00:00
CHANGELOG Update CHANGELOG for release v3.8.3-patch.6 (#3473) 2025-07-28 07:33:05 +00:00
assets feat: Enhance Script Details and Add MacOS Compatibility with Documentation Updates (#1794) 2024-01-21 02:49:08 +00:00
build build: update kubernetes deployment Run. (#2919) 2024-12-13 03:02:45 +00:00
cmd fix: prometheus discovery (#3408) 2025-06-11 08:29:44 +00:00
config docs: update readme of config file. (#3356) 2025-07-28 07:51:26 +00:00
deployments docs: improve deployment docs in kubernetes. (#2973) 2024-12-26 09:53:14 +00:00
docs docs: update slack link. (#3479) 2025-07-28 02:46:23 +00:00
internal fix: performance issues with Kafka caused by encapsulating the MQ interface (#3485) 2025-07-28 09:10:38 +00:00
pkg fix: searchMessage method has potential NPE bug (#3287) (#3289) 2025-07-29 08:16:30 +00:00
scripts/template build: update mongo and kafka start logic. (#2858) 2024-11-18 03:32:47 +00:00
test feat: add nickname for adminUser (#3435) 2025-06-25 03:33:19 +00:00
tools feat: support redis sentinel. (#3423) 2025-06-18 06:31:09 +00:00
version fix: oss specifies content-type when uploading (#3267) 2025-04-01 09:13:32 +00:00
.dockerignore 3.6.1 code conventions (#2202) 2024-04-24 12:11:24 +08:00
.env feat: Implement etcd and kafka auth. (#3394) 2025-06-17 07:33:25 +00:00
.gitattributes remove \r 2024-04-22 16:31:11 +08:00
.gitignore feat: new features merged (#2409) 2024-07-16 02:46:21 +00:00
.golangci.yml License (#3293) 2025-04-22 16:48:12 +08:00
CHANGELOG.md feat: add link file 2023-07-10 18:19:25 +08:00
CODE_OF_CONDUCT.md Feat/add test scripts (#1341) 2023-11-05 10:36:37 +00:00
CONTRIBUTING-zh_CN.md Fix: solve conversation blocking in private chat when non friendship. (#2542) 2024-08-21 07:23:43 +00:00
CONTRIBUTING.md Fix: solve conversation blocking in private chat when non friendship. (#2542) 2024-08-21 07:23:43 +00:00
Dockerfile build: implement services image build and CI release. (#2920) 2024-12-07 09:35:42 +00:00
LICENSE Update LICENSE 2025-04-22 21:47:13 +08:00
README.md docs: update slack link. (#3479) 2025-07-28 02:46:23 +00:00
README_zh_CN.md docs: update slack link. (#3479) 2025-07-28 02:46:23 +00:00
bootstrap.bat refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
bootstrap.sh 3.6.1 code conventions (#2202) 2024-04-24 12:11:24 +08:00
docker-compose.yml fix: correctly aggregate read seqs by conversation and user before DB update. (#3442) 2025-07-28 04:11:38 +00:00
go.mod fix: performance issues with Kafka caused by encapsulating the MQ interface (#3485) 2025-07-28 09:10:38 +00:00
go.sum fix: performance issues with Kafka caused by encapsulating the MQ interface (#3485) 2025-07-28 09:10:38 +00:00
install.sh docs: update slack link. (#3479) 2025-07-28 02:46:23 +00:00
magefile.go refactor: support modified config and args in mage. (#3466) 2025-07-22 02:24:01 +00:00
magefile_unix.go build: update kubernetes deployment Run. (#2919) 2024-12-13 03:02:45 +00:00
magefile_windows.go refactor: 3.7.0 code conventions. (#2148) 2024-04-19 22:23:08 +08:00
start-config.yml feat: support distributed lock in crontask. (#3401) 2025-06-06 06:25:58 +00:00

README.md

👥 Join Our Community

Ⓜ️ About OpenIM

Unlike standalone chat applications such as Telegram, Signal, and Rocket.Chat, OpenIM offers an open-source instant messaging solution designed specifically for developers rather than as a directly installable standalone chat app. Comprising OpenIM SDK and OpenIM Server, it provides developers with a complete set of tools and services to integrate instant messaging functions into their applications, including message sending and receiving, user management, and group management. Overall, OpenIM aims to provide developers with the necessary tools and framework to implement efficient instant messaging solutions in their applications.

App-OpenIM Relationship

🚀 Introduction to OpenIMSDK

OpenIMSDK, designed for OpenIMServer, is an IM SDK created specifically for integration into client applications. It supports various functionalities and modules:

  • 🌟 Main Features:

    • 📦 Local Storage
    • 🔔 Listener Callbacks
    • 🛡️ API Wrapping
    • 🌐 Connection Management
  • 📚 Main Modules:

    1. 🚀 Initialization and Login
    2. 👤 User Management
    3. 👫 Friends Management
    4. 🤖 Group Functions
    5. 💬 Session Handling

Built with Golang and supports cross-platform deployment to ensure a consistent integration experience across all platforms.

👉 Explore the GO SDK

🌐 Introduction to OpenIMServer

  • OpenIMServer features include:
    • 🌐 Microservices Architecture: Supports cluster mode, including a gateway and multiple rpc services.
    • 🚀 Diverse Deployment Options: Supports source code, Kubernetes, or Docker deployment.
    • Massive User Support: Supports large-scale groups with hundreds of thousands, millions of users, and billions of messages.

Enhanced Business Functions:

  • REST API: Provides a REST API for business systems to enhance functionality, such as group creation and message pushing through backend interfaces.

  • Webhooks: Expands business forms through callbacks, sending requests to business servers before or after certain events.

    Overall Architecture

🚀 Quick Start

Experience online for iOS/Android/H5/PC/Web:

👉 OpenIM Online Demo

To facilitate user experience, we offer various deployment solutions. You can choose your preferred deployment method from the list below:

System Support

Supports Linux, Windows, Mac systems, and ARM and AMD CPU architectures.

✍️ How to Contribute

We welcome contributions of any kind! Please make sure to read our Contributor Documentation before submitting a Pull Request.

Thank you for contributing to building a powerful instant messaging solution!

📕 License

This software is licensed under the Apache License 2.0

🔮 Thanks to our contributors!