wildfirechat / im-server

即时通讯(IM)系统
http://docs.wildfirechat.cn
Other
7.89k stars 1.79k forks source link
im voip

野火IM解决方案

野火IM是专业级的即时通讯和实时音视频整体解决方案,由北京野火无限网络科技有限公司维护和支持。

功能特性

野火开源项目

主要包括以下项目:

GitHub仓库 码云仓库 说明
im-server im-server 野火社区版IM服务,野火IM的核心服务,处理所有IM相关业务。
app-server app-server Demo应用服务,模拟客户的应用服登陆处理逻辑及部分二次开发示例。
robot_server robot_server 机器人服务,演示野火机器人对接其它系统的方法。
push_server push_server 推送服务器,可以对接所有的系统厂商推送服务或者第三方推送服务。
wf-minio wf-minio 私有对象存储服务,用来支持野火IM专业版的文件存储。
wf-janus wf-janus 高级音视频媒体服务。
open-platform open-platform 野火开放平台服务。
daily-report daily-report 野火开放平台日报 demo服务。
channel-platform channel-platform 野火频道(公众号)平台服务。
organization-platform organization-platform 野火组织通讯录服务。
android-chat android-chat 野火IM Android SDK源码和App源码。
ios-chat ios-chat 野火IM iOS SDK源码和App源码。
pc-chat pc-chat 基于Electron的PC 端,支持Windows、Mac、Linux(包括国产化linux系统和CPU)。
web-chat web-chat 野火IM Web 端, 体验地址
wx-chat wx-chat 小程序平台的Demo(支持微信、百度、阿里、字节、QQ 等小程序平台)。
uni-chat uni-chat UniApp平台移动端应用(使用原生插件)。
uni-wfc-client uni-wfc-client UniApp平台原生插件。已商店上架
wfc_flutter_plugins flutter_imclient Flutter平台原生插件,支持IM和音视频通话。
docs docs 野火IM相关文档,包含设计、概念、开发、使用说明,在线查看

野火开发文档

在线文档

野火IM论坛

野火IM论坛

野火性能测试报告及测试方法

Github, 码云

野火Demo

请使用微信扫码下载安装体验野火IM移动客户端

野火IM

Web客户端点击这里

PC客户端点这里下载安装。

小程序客户端请用微信扫码

野火IM

快速开始

可以按照快速开始来部署应用服务和IM服务,然后打包移动端,就可以完成聊天和通话功能。

之后再部署开放平台服务、频道(公众号)服务、机器人服务、推送服务、Turn服务(音视频服务)来实现完整的应用功能,详情可以详细阅读文档。

联系我们

商务合作请微信联系:

问题交流

  1. 如果大家发现bug,请在GitHub或码云提issue;如果有需求也请给我们提issue。
  2. 其他问题,请到野火IM论坛进行交流学习
  3. 关注我们的公众号。我们有新版本发布或者有重大更新会通过公众号通知大家,另外我们也会不定期的发布一些关于野火IM的技术介绍。

我们有核心研发工程师轮流值班处理issue和论坛,会及时处理的,疑难Bug的修改和新需求的开发我们也会尽快解决。

编译

mvn clean package

生成的目标文件在./distribution/target/distribution-xxxx-bundle-tar.tar.gz

配置

解压distribution-xxxx-bundle-tar.tar.gz,修改解压出来的config目录下的wildfirechat.conf,可以阅读配置文件注释和文档,对其它配置项进行调整。

运行

在解压distribution-xxxx-bundle-tar.tar.gz后的目录下运行如下命令:

./bin/wildfirechat.sh

验证

  1. 在浏览器中输入地址 http://${ip}/api/version可以看到返回一个json文件。
  2. 部署应用服务,配置和编译Android客户端iOS客户端进行验证。详情可参考快速开始

打包RPM格式

打包会生成Java包和deb安装包,如果需要rpm安装包,请在distribution/pom.xml中取消注释生成rpm包的plugin。另外还需要本地安装有rpm,在linux或者mac系统中很容易安装,在windows系统需要安装cygwin并安装rpm,具体信息请百度查询。

修改之后运行编译命令mvn clean package,rpm包生成在distribution/target目录下。

Epoll

在linux系统中打开Epoll开关可以提高性能,默认软件包内打包的是x86_64的epoll native sdk。如果是arm64的机器,可以把broker pom文件中修改如下:

<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-transport-native-epoll</artifactId>
    <version>${netty.version}</version>
<!--    <classifier>linux-x86_64</classifier>-->
    <classifier>linux-aarch_64</classifier>
</dependency>

然后重新打包。专业版IM服务软件包中有arm64架构的sdk,可以直接替换。epoll只支持x86_64和arm64两个架构,其他架构不要把epoll开关打开。

升级说明

  1. 从0.42 版本增加了群成员数限制,默认为2000。如果您从之前的版本升级到这个版本或以后,需要注意到群成员数的限制。升级之后超出限制的群不受影响,但不能继续加人,如果您想修改默认值,可以在升级版本之后,修改t_setting表,把默认的大小改为您期望的人数。另外修改t_group表,把已经存在的群组max_member_count改成您期望的,然后重启。
  2. 0.50版本添加了是否允许客户端发送群操作通知的配置。如果您在客户端自定义群通知,需要在服务器端配置允许,没有使用自定义群操作通知的不受影响。***
  3. 0.46和0.47版本升级到0.48及以后版本时,可能会提示flyway migrate 38错误,请执行 修复脚本 进行修复。0.46和0.47版本之外的版本不会出现此问题。
  4. 从0.54之前版本升级到0.54及以后版本时,会提示flyway migrate错误。因为0.54版本删除了sql脚本中默认敏感词的内容,flyway checksum失败。请执行update flyway_schema_history set checksum = 0 where script = 'V17__add_default_sensitive_word.sql';来修复。
  5. 从0.59之前的版本升级到之后的版本执行数据库升级时间比较长,请耐心等待提示运行成功,避免中途中断。
  6. 0.62/0.63 版本有严重的问题,请使用0.64及以后版本,或者0.61版。
  7. 从0.68 版本起添加了pc在线是否默认手机接收推送的开关,默认为开,与以前版本作用相反,请注意兼容(可以关掉与之前保持一致或者升级客户端)
  8. 从0.78 版本起把MySQL数据库中关键字都改为大小写敏感,另外生成id的方法也做了改变,只生成小写的id,避免出现id重复的问题,建议所有客户都升级
  9. 从0.79 版本起把log4j升级到log4j2,因为log4j已经不再维护而且还有已知的漏洞,建议所有客户都升级,升级时注意更新log4j2的配置文件
  10. 0.97版本更改了启动脚本wildfirechat.sh,如果是升级服务,请注意更新启动脚本。

维护说明

野火设计理念当中,IM服务和客户端协议栈构成个管道工具,数据在人和人或者人和服务或者服务和服务之间传递,可以通过Server API和自定义消息来对接和开发业务。业务系统把IM系统当作一个工具来使用,是不需要把任何业务逻辑写在IM服务中的。

如果修改了IM服务可能会引起跟客户端协议栈的不兼容,以后也没有可能从社区版IM服务迁移到专业版IM服务,还有一旦修改就跟我们代码不一样了,如果出了问题我们就无法分析和解决。所以 我们强烈不推荐在IM服务修改代码,如果修改过就不再提供任何技术支持和服务了。除了IM服务以外的所有代码可以任意修改。

现有接口足够对接和二开任何业务了,如果发现无法实现你们的业务需求,可以在论坛来咨询,我们会分析如何实现,如果需要添加新接口,我们会及时免费添加。请切记:不要修改IM服务的代码! 不要修改IM服务的代码! 不要修改IM服务的代码!

详细维护说明请参考 野火维护说明

服务对象

因为野火的使用范围比较广,难免被一些不法分子利用,国内反诈反赌力度很大,所以国内多地警方都跟我们都有过联系。为了预防我们的产品被用于非法目的,试用及购买只能支持境内法人单位,不接受个人或者境外团体。如果我们发现产品被用于非法目的,我们会立即停止技术支持服务并且报警和配合警方调查。请用于非法目的用户绕行!

常见问题

请参考文档常见问题

应用截图

登录界面

会话列表

好友列表

工作台

发现

我的页面

消息聊天

动态表情

语音消息

位置消息

拍摄图片或者小视频

会话设置

朋友圈

新好友

多人视频通话

会议主页

会议详情

会议界面

PC客户端界面

移动客户端、PC客户端和Web客户端三端同框

小程序客户端

公众号管理后台

开放平台管理后台

IM服务管理后台

更多详细信息请下载demo进行体验。

特别感谢

  1. moquette 本项目是基于此项目二次开发而来,处理MQTT相关业务。
  2. loServer 本项目使用loServer处理HTTP相关业务。

对他们表示诚挚的感谢🙏

License

  1. Under the Creative Commons Attribution-NoDerivs 3.0 Unported license. See the LICENSE file for details.