Pages

▼

Sunday, 17 October 2021

Open-IM-Server

 开源即时通讯工具：Open-IM

Open-IM是一个基于 Go 实现的即时通讯（IM）开源项目，包含服务端到客户端SDK整体解决方案。社区版遵守Apache2.0开源协议。同时拥有商业版（商业版本是OpenIM服务端和IMSDK基础上，开发带有UI功能完整的IM产品。）

项目特色:

完整组件，一键部署。客户端提炼成方便集成的SDK，服务端通过docker一键部署，运营管理系统展示后台数据；

私有化部署。部署Open-IM在自家服务器上，摆脱对第三方的依赖，数据隐私可控、有保障；

高性能、微服务、集群化。系统具备平行扩展能力，支持服务注册、服务发现。采用“一切皆消息”的通讯模型。

https://github.com/OpenIMSDK/Open-IM-Server

---------------------------------------------------------------------

OpenIM：由前微信技术专家打造的基于Go的即时通讯（IM）项目，从服务端到客户端SDK开源即时通讯（IM）整体解决方案，可以轻松替代第三方IM的云服务，打造具备聊天、社交功能的app。

avatar

LICENSE Language

Open-IM-Server: Open source Instant Messaging Server

Instant messaging server. Backend in pure Golang, wire transport protocol is JSON over websocket.

Everything is a message in Open-IM-Server, so you can extend custom messages easily, there is no need to modify the server code.

Using microservice architectures, Open-IM-Server can be deployed using clusters.

By deployment of the Open-IM-Server on the customer's server, developers can integrate instant messaging and real-time network capabilities into their own applications free of charge and quickly, and ensure the security and privacy of business data.

Features

  • Everything in Free
  • Scalable architecture
  • Easy integration
  • Good scalability
  • High performance
  • Lightweight
  • Supports multiple protocols

Community

Quick start

Installing Open-IM-Server

Open-IM relies on five open source high-performance components: ETCD, MySQL, MongoDB, Redis, and Kafka. Privatization deployment Before Open-IM-Server, please make sure that the above five components have been installed. If your server does not have the above components, you must first install Missing components. If you have the above components, it is recommended to use them directly. If not, it is recommended to use Docker-compose, no To install dependencies, one-click deployment, faster and more convenient.

Source code deployment

  1. Install Go environment. Make sure Go version is at least 1.15.

  2. Clone the Open-IM project to your server.

    git clone https://github.com/OpenIMSDK/Open-IM-Server --recursive

  3. Build and start Service.

    1. Shell authorization

      #cd Open-IM-server/script

chmod +x *.sh

    2. Execute the build shell

      ./build_all_service.sh

    3. Start service

      ./start_all.sh

    4. Check service

      ./check_all.sh

      OpenIMServersonSystempng

Docker deployment

All images are available at https://hub.docker.com/r/lyt1123/open_im_server

  1. Install Docker 1.13 or above.

  2. Install Docker Compose 1.22 or above.

  3. Clone the Open-IM project to your server.

    git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive

  4. Start docker-compose with one click(Docker automatically pulls all images)

    docker-compose up -d

  5. Check service

    ./docker_check_service.sh

    OpenIMServersondockerpng

CONFIGURATION INSTRUCTIONS

Open-IM configuration is divided into basic component configuration and business internal service configuration. Developers need to fill in the address of each component as the address of their server component when using the product, and ensure that the internal service port of the business is not occupied

Basic Component Configuration Instructions

  • ETCD
    • Etcd is used for the discovery and registration of rpc services, etcd Schema is the prefix of the registered name, it is recommended to modify it to your company name, etcd address (ip+port) supports clustered deployment, you can fill in multiple ETCD addresses separated by commas, and also only one etcd address.
  • MySQL
    • mysql is used for full storage of messages and user relationships. Cluster deployment is not supported for the time being. Modify addresses and users, passwords, and database names.
  • Mongo
    • Mongo is used for offline storage of messages. The default storage is 7 days. Cluster deployment is temporarily not supported. Just modify the address and database name.
  • Redis
    • Redis is currently mainly used for message serial number storage and user token information storage. Cluster deployment is temporarily not supported. Just modify the corresponding redis address and password.
  • Kafka
    • Kafka is used as a message transfer storage queue to support cluster deployment, just modify the corresponding address

Internal Service Configuration Instructions

  • credential&&push
    • The Open-IM needs to use the three-party offline push function. Currently, Tencent's three-party push is used. It supports IOS, Android and OSX push. This information is some registration information pushed by Tencent. Developers need to go to Tencent Cloud Mobile Push to register the corresponding information. If you do not fill in the corresponding information, you cannot use the offline message push function
  • api&&rpcport&&longconnsvr&&rpcregistername
    • The api port is the http interface, longconnsvr is the websocket listening port, and rpcport is the internal service startup port. Both support cluster deployment. Make sure that these ports are not used. If you want to open multiple services for a single service, fill in multiple ports separated by commas. rpcregistername is the service name registered by each service to the registry etcd, no need to modify
  • log&&modulename
    • The log configuration includes the storage path of the log file, and the log is sent to elasticsearch for log viewing. Currently, the log is not supported to be sent to elasticsearch. The configuration does not need to be modified for the time being. The modulename is used to split the log according to the name of the service module. The default configuration is fine.
  • multiloginpolicy&&tokenpolicy
    • Open-IM supports multi-terminal login. Currently, there are three multi-terminal login policies. The PC terminal and the mobile terminal are online at the same time by default. When multiple policies are configured to be true, the first policy with true is used by default, and the token policy is the generated token policy. , The developer can customize the expiration time of the token

SCRIPT DESCRIPTION

Open-IM script provides service compilation, start, and stop scripts. There are four Open-IM script start modules, one is the http+rpc service start module, the second is the websocket service start module, then the msg_transfer module, and the last is the push module

  • path_info.cfg&&style_info.cfg&&functions.sh
    • Contains the path information of each module, including the path where the source code is located, the name of the service startup, the shell print font style, and some functions for processing shell strings
  • build_all_service.sh
    • Compile the module, compile all the source code of Open-IM into a binary file and put it into the bin directory
  • start_rpc_api_service.sh&&msg_gateway_start.sh&&msg_transfer_start.sh&&push_start.sh
    • Independent script startup module, followed by api and rpc modules, message gateway module, message transfer module, and push module
  • start_all.sh&&stop_all.sh
    • Total script, start all services and close all services

Authentication Clow Chart

avatar

Architecture

avatar

from https://github.com/OpenIMSDK/Open-IM-Server

------

前微信技术专家打造的开源 IM 系统，一键部署服务端，客户端 SDK全平台支持

谁要开源IM替换IM云服务啊，我帮你找到了。如今IM云服务商收费高企，如何让企业低成本、安全、可靠接入IM服务，希望能帮到你们。

自互联网诞生以来，即时通讯平台就一直存在。从世界范围来看，WhatsApp、Facebook、 微信、Telegram是领先的消息平台，用户主要使用这些平台与家人和朋友保持联系。随着互联网的发展，人与人之间的沟通是刚需，无处不在，几乎所有的APP都集成IM功能，从社交、游戏、到生活中的方方面面，打车、找房等。可以说IM作为一种通讯能力，已经成为互联网上的基础设施，成为许多APP不可或缺的功能。现在绝大多数APP使用IM云服务商的SDK，方便接入的同时，也带来了几个深层次的问题：

（1）成本问题：企业每年额外支付上万乃至数十万的云服务费用，是个不小的成本；

（2）数据隐私问题：企业的用户数据、聊天记录等核心数据存储在IM云服务商，如何保证数据的安全性是个极大挑战

（3）需求定制问题：IM需求多样化，IM功能只能由IM云服务商通过SDK的形式提供给大家使用，对于一些定制化的需求，是否支持，什么时候实现，都是个未知数；

（4）云服务商绑架问题：一旦使用IM云服务，形成捆绑关系，迁移成本高，受制于人。

OpenIM采用和IM云服务相同的接口，提供服务端和客户端SDK，让开发者以免费或低成本接入IMSDK，并私有化部署，完成IM功能接入。

OpenIM：由前微信技术专家打造的基于 Go 实现的即时通讯（IM）项目，从服务端到客户端SDK开源即时通讯（IM）整体解决方案。开发文档完善，代码100%开源，支持Andorid、iOS原生开发，支持Flutter、uni-app跨端开发，支持小程序、React等所有主流web前端技术框架， PC支持Electron，可以轻松替代第三方IM云服务。

服务端由接入层、逻辑层和存储层组成，好处在于各个层次能够依据业务特点专注于自己的事情，提高系统复用性，降低业务间的耦合。

（1）接入层：消息通过 websocket 协议接入，其他通过 http/https 协议接入，消息是高频及核心功能，通过双协议路由，体现了轻重分离的设计思想。

（2）逻辑层：通过 rpc 实现无状态逻辑服务，易于平行扩展，消息通过 MQ 解耦。

（3）存储层：redis 存储 token 和 seq；mongodb 存储离线消息，并定时删除 14 天（可自行配置）前数据；mysql 存储全量历史消息以及用户相关资料。数据分层存储，充分利用不同存储组件的特性。

（4）Etcd：服务注册和发现、以及分布式配置中心。

Open-IM 消息模型采用经典的收件箱模型，并通过全局 seq 做消息对齐，这里带来架构的简化，体现了简单美的架构设计理念。很多开发者通过网络文章，了解到收件箱模型的原理，也知道 seq 的概念，但如何在项目中做权衡和取舍，爱因斯坦曾经说过“事情应该力求简单，不过不能过于简单”，我们看到很多技术文章对收件箱模型和 seq 的滥用，要么系统设计复杂，要么过于简单，最后的结果是系统不稳定，消息可达率无法达到要求。以下我们简单讲解消息如何发送，系统如何简单解耦，接收方如何实时收到消息，并如何利用 seq 做全局消息对齐，确保消息百分百可达。

客户端架构

客户端 SDK 负责和 IM 服务端交互，本地数据存储和同步，消息、事件回调。开发者通过集成 SDK，自行开发聊天界面 UI，设置事件监听回调实现数据和 UI 对接。

Open-IMSDK 分为三层：网络层、逻辑层、存储层。分层治理，各司其职，实现高效、稳定、统一的客户端架构。

SDK集成流程

OpenIM SDK 集成非常简单，由于开发者私有化部署，代码、配置、数据都在自家服务器上，不用向云平台申请 AppKey 和 Secret，相比第三方 IM 云服务，可见 OpenIM 更安全、可控、自由度更高。

开源项目地址：https://github.com/OpenIMSDK/Open-IM-Server

官方文档地址：https://doc.rentsoft.cn/

from https://mp.weixin.qq.com/s/DgzZTfY5vnnp6veEAOEKVw


at

No comments:

Post a Comment