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 в режиме кластера.
На каких системах и архитектурах процессоров работает сервер?Сервер работает в Linux, Windows и Mac, на процессорах с архитектурами ARM и AMD, а для развертываний в контейнерах использует Docker Compose.
Насколько сложно развернуть его на своём сервере?OpenIM построен на микросервисной архитектуре с шлюзом и несколькими RPC-сервисами, поэтому самостоятельный запуск включает больше компонентов, чем запуск одного бинарного файла чат-сервера, хотя руководства по развертыванию в Docker и Kubernetes есть.
Какие клиентские платформы поддерживает OpenIMSDK?SDK на Go предназначен для кроссплатформенной интеграции, а демо-версия в сети работает на iOS, Android, H5 (веб) и PC/Web.
Какой масштаб OpenIM реально может выдержать?Он рассчитан на большие группы с сотнями тысяч или миллионами пользователей и миллиардами сообщений.
Можно ли попробовать OpenIM до самостоятельного развертывания?Да, есть онлайн-демо, которое можно попробовать на iOS, Android, H5, PC и Web без какой-либо настройки.
Что именно OpenIMSDK даёт клиентским приложениям?Он отвечает за локальное хранение, колбэки слушателей, обёртки над API и управление соединением, а также включает модули для входа, управления пользователями, друзьями, группами и сессиями.
Может ли мой бэкенд запускать собственную логику при работе с сообщениями?Да, OpenIM предоставляет REST API для таких задач, как создание групп и отправка сообщений, а также вебхуки, которые вызывают ваш бизнес-сервер до или после определённых событий.
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