open-im-server README

The project's README from github.com/openimsdk/open-im-server. As one markdown file: README.md.

Stars Forks Codecov Go Report Card Go Reference License Slack Best Practices Good First Issues Language Gurubase

English · 中文 · Українська · Česky · Magyar · Español · فارسی · Français · Deutsch · Polski · Indonesian · Suomi · മലയാളം · 日本語 · Nederlands · Italiano · Русский · Português (Brasil) · Esperanto · 한국어 · العربي · Tiếng Việt · Dansk · Ελληνικά · Türkçe

:busts_in_silhouette: 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:

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

👉 Explore the GO SDK

🌐 Introduction to OpenIMServer

Enhanced Business Functions:

:rocket: 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.

:writing_hand: 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!

:closed_book: License

This software is licensed under the Apache License 2.0

🔮 Thanks to our contributors!

open-im-server (openimsdk/open-im-server)

Searching Database…

这是什么?OpenIM 是一个开源即时通讯解决方案,由 OpenIMServer(后端)和 OpenIMSDK(客户端库)组成,为开发者提供为自有应用添加聊天、用户管理和群组管理所需的全部功能。
这是可以直接使用的聊天应用,还是面向开发者的工具包?它不是 Telegram、Signal 或 Rocket.Chat 那样的独立聊天应用,而是一套开发者工具包,即 OpenIMServer 加 OpenIMSDK,需要集成到你自己的应用中。
如何部署 OpenIMServer?可以通过源代码或 Docker 进行部署,分别参阅 Source Code Deployment Guide 或 Docker Deployment Guide;如需集群模式,也可以在 Kubernetes 上运行。
服务器运行在哪些操作系统和 CPU 架构上?可运行于 Linux、Windows 和 Mac,同时支持 ARM 和 AMD 两种 CPU 架构,并使用 Docker Compose 进行容器化部署。
自行托管的难度有多大?OpenIM 采用微服务架构,包含一个网关和多个 RPC 服务,因此自行运行时的组成部分比单一可执行文件的聊天服务器多得多,尽管提供了 Docker 和 Kubernetes 部署指南。
OpenIMSDK 支持哪些客户端平台?基于 Go 语言的 SDK 可用于跨平台集成,在线演示涵盖 iOS、Android、H5(网页)以及 PC/Web。
OpenIM 实际能支撑多大的规模?它设计用于支持大规模群组,可容纳数十万乃至数百万用户以及数十亿条消息。
在自行部署之前,我能先试用 OpenIM 吗?可以,有一个在线演示,可在 iOS、Android、H5、PC 和 Web 上直接体验,无需任何设置。
OpenIMSDK 究竟为客户端应用提供了什么?它负责本地存储、监听器回调、API 封装和连接管理,并包含登录、用户管理、好友、群组和会话管理等模块。
我的后端能否在消息相关的环节触发自定义逻辑?可以,OpenIM 提供 REST API,用于创建群组、推送消息等操作,还提供 webhook,可在某些事件发生之前或之后调用你的业务服务器。
What are similar projects?chat, centrifugo, nsq, hyperswitch, casdoor, encore, appwrite, orleans
Creator
openimsdk
Size
35.2 MB
Stars
16.7K
Age
5y
Commits · 90 Days