JuggleIM im-server 安装与配置指南

JuggleIM im-server 安装与配置指南

1. 项目基础介绍

JuggleIM im-server 是一个开源的高性能即时通讯（IM）服务器，它支持大规模用户的即时通讯需求，并提供灵活的部署方式。项目主要使用 Go 语言开发，以其高效的性能和并发处理能力，为用户提供稳定的服务。

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

• Go 语言：项目使用 Go 语言开发，利用了 Go 的高效并发处理能力。
• Protobuf + Websocket：采用 Protobuf 作为数据格式，通过 Websocket 实现长连接，减少流量消耗，并提高网络连通性。
• MySQL/MongoDB：支持 MySQL 和 MongoDB 作为数据存储方案，可以根据需要进行配置。
• 集群部署：支持集群部署，可以实现无限横向扩展，满足大规模用户的需求。

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

在开始安装之前，请确保你的系统中已经安装了以下软件：

• Go 语言环境
• MySQL 或 MongoDB 数据库
• Docker（可选，用于运行服务）

详细的安装步骤

步骤 1：安装 MySQL

1. 根据你的操作系统，下载并安装 MySQL。
2. 安装完成后，启动 MySQL 服务。

步骤 2：初始化数据库

1. 创建一个新的数据库实例：

   CREATE SCHEMA `jim_db`;
   

2. 导入表结构：

   下载项目中的 jim.sql 文件，然后使用以下命令导入到 MySQL 中：

   mysql -u{db_user} -p{db_password} jim_db < jim.sql
   

   替换 {db_user} 和 {db_password} 为你的 MySQL 用户名和密码。

步骤 3：安装 MongoDB（可选）

如果选择使用 MongoDB，请根据你的操作系统下载并安装 MongoDB。

步骤 4：获取 im-server 代码

使用 Git 克隆项目代码：

git clone https://github.com/juggleim/im-server.git
cd im-server

步骤 5：配置 im-server

编辑 conf/config.yml 文件，根据你的需求配置以下参数：

• nodeName：节点名称
• nodeHost：节点IP地址
• msgStoreEngine：消息存储引擎（mysql 或 mongo）
• mysql/mongodb 配置：根据选择的存储引擎配置数据库连接信息
• connectManager：长连接端口配置
• apiGateway：服务端 API 端口
• navGateway：导航端口
• adminGateway：管理后台端口

步骤 6：启动 im-server

在 launcher 目录下执行以下命令启动服务：

go run main.go

步骤 7：配置外网访问地址

根据你的网络环境配置外网访问的端口和地址，可能需要配置公网IP、域名、Nginx 反向代理或负载均衡。

步骤 8：将长连接地址配置到 IM 系统中

在数据库中插入一条配置数据：

insert into globalconfs (conf_key, conf_value) values ('connect_address', '{"default":["{你的IP或域名}:9002"]}');

替换 {你的IP或域名} 为实际的外网IP或域名。

步骤 9：创建应用（租户）

通过管理后台或管理API创建应用，获取 app_key 和 app_secret。

步骤 10：业务服务器/客户端集成

根据项目提供的文档配置业务服务器和客户端SDK，确保 app_key 和 app_secret 保持一致。

以上步骤为 JuggleIM im-server 的基础安装和配置流程。安装完成后，你可以根据项目文档进行更详细的定制和优化。