悟空IM安装和配置指南

悟空IM安装和配置指南

WuKongIM 8年积累，沉淀出来的高性能通用实时通讯服务，支持即时通讯（聊天软件）(IM)(Chat)，消息推送，消息中台，音视频信令，直播弹幕，客服系统，AI通讯，即时社区等场景 项目地址: https://gitcode.com/gh_mirrors/wu/WuKongIM

1. 项目基础介绍

悟空IM是一个开源的高性能通用通讯服务项目，支持即时通讯、站内/系统消息、消息中台、物联网通讯、音视频信令、直播弹幕、客服系统、AI通讯和即时社区等多种场景。它经过了多年的积累和沉淀，具有高性能、高可用性和易用性等特点。

主要编程语言

• Go：项目的主要开发语言，用于实现后端服务。
• Vue：用于前端页面的开发。
• TypeScript：用于前端页面的逻辑处理。

2. 项目使用的关键技术和框架

• 自定义协议：悟空IM使用自研的二进制协议，提高了数据传输的效率。
• 分布式Raft协议：通过魔改的Raft协议实现数据的分布式存储和一致性保证。
• 关系数据库：项目采用关系数据库底层原理，确保数据的可靠存储。
• 分布式数据库设计：针对IM服务的特性，研发了特有的分布式数据库。
• Reactor模式：通过Reactor模式处理网络I/O，提高系统的响应性能。
• 分布式多层领导机制：独创的分布式领导机制，用于集群管理。

3. 项目安装和配置的准备工作

在开始安装之前，请确保您的系统满足以下要求：

• 操作系统：Linux或MacOS（项目不再支持Windows系统）。
• Go版本：1.20.0或更高版本。
• Docker：用于容器化部署。

详细安装步骤

步骤一：克隆项目

首先，您需要从GitHub上克隆项目到本地：

git clone https://github.com/WuKongIM/WuKongIM.git
cd WuKongIM

步骤二：构建和运行Docker容器

项目提供了Docker容器来简化部署流程。以下是启动集群的命令：

cd docker/cluster
sudo docker-compose up -d

这将启动所有必要的服务，并使其在后台运行。

步骤三：访问后台管理系统和聊天演示

启动后，您可以通过以下地址访问后台管理系统和聊天演示：

• 后台管理系统：http://127.0.0.1:15300/web
• 聊天演示地址：http://127.0.0.1:15172/login

步骤四：单机快速启动（可选）

如果您想快速在单机上测试，可以使用以下命令：

go run main.go --config config/wk.yaml

或者如果您有配置文件，可以使用：

go run main.go --config ./exampleconfig/cluster1.yaml

这将启动IM服务的单个实例。

请注意，这只是一个简单的安装和配置指南。实际部署时，您可能需要调整配置文件、设置环境变量、配置存储和监控等高级选项。更多详细信息，请参考项目官方文档。

WuKongIM 8年积累，沉淀出来的高性能通用实时通讯服务，支持即时通讯（聊天软件）(IM)(Chat)，消息推送，消息中台，音视频信令，直播弹幕，客服系统，AI通讯，即时社区等场景 项目地址: https://gitcode.com/gh_mirrors/wu/WuKongIM