WindChat/README.md

155 lines
5.5 KiB
Markdown
Raw Normal View History

2019-07-29 23:42:16 +08:00
2019-11-26 10:57:14 +08:00
[WindChat-风信](https://gitee.com/wind-chat/wind-im/blob/master/README.md)
2019-07-29 23:42:16 +08:00
====
2020-10-30 00:57:13 +08:00
<img src="https://images.gitee.com/uploads/images/2020/1030/003214_2ce45893_1566564.png" alt="WindChat.png" width=200>
2019-11-26 11:58:56 +08:00
2019-07-29 23:42:16 +08:00
[![License](https://img.shields.io/badge/license-apache2-blue.svg)](LICENSE)
**源码仓库**
2020-05-11 22:18:35 +08:00
> * **GitHub地址** : https://github.com/WindChat/wind-im.git
> * **Gitee地址** : https://gitee.com/wind-chat/wind-im.git
2019-07-29 23:42:16 +08:00
简介
----
2020-10-21 13:33:17 +08:00
WindChat 是一款开源免费私有IM聊天软件由核心开发者SAM2O2O等维护主要面向企业定制IM开源、免费。
2019-07-29 23:42:16 +08:00
特性:
* 单聊、群聊(含文字、图片、语音等)
* 端到端的加密消息(服务端不可解密,服务器可通过配置关闭此特性)
* 匿名注册、实名注册,以及注册邀请码机制(只允许特定用户注册)
* 扩展机制
*
<p align="center">
2019-11-26 10:49:27 +08:00
<img align="center" src="https://images.gitee.com/uploads/images/2019/1126/104318_e96d4636_1566564.jpeg" width="200" /> &nbsp; <img align="center" src="https://images.gitee.com/uploads/images/2019/1126/104318_3d9b5edb_1566564.jpeg" width="200" /> &nbsp; <img align="center" src="https://images.gitee.com/uploads/images/2019/1126/104318_3751606d_1566564.jpeg" width="200" /> &nbsp;
2019-07-29 23:42:16 +08:00
</p>
一、快速体验
----
**1. 启动服务器**
2019-11-26 10:57:14 +08:00
* git clone https://gitee.com/wind-chat/wind-im.git
2019-07-29 23:42:16 +08:00
2019-12-31 17:28:53 +08:00
WindChat 开始支持personal个人版与team版默认状态下使用personal
2019-07-29 23:42:16 +08:00
2019-11-27 23:48:34 +08:00
支持的启动参数:`java -jar windchat-server.jar -h`
2019-07-29 23:42:16 +08:00
2019-12-31 17:28:53 +08:00
WindChat Personal版本 命令:
2019-07-29 23:42:16 +08:00
2019-11-27 23:48:34 +08:00
* 版本升级:`java -jar windchat-server.jar -upgrade` 此命令在服务与sqlite数据库版本不一致时执行正常情况无需执行
2019-07-29 23:42:16 +08:00
2019-11-27 23:48:34 +08:00
* 启动命令:`java -jar windchat-server.jar`
2019-07-29 23:42:16 +08:00
2019-12-31 17:28:53 +08:00
WindChat Team版本 命令:
2019-07-29 23:42:16 +08:00
2019-11-27 23:48:34 +08:00
* 生成Team版本所需配置模版`java -jar windchat-server.jar -team`
2019-07-29 23:42:16 +08:00
2019-12-31 17:28:53 +08:00
* 修改配置文件: 上一步会生成 windchat-server.config 使用mysql数据库需在[windchat-server.config]配置文件中配置mysql参数
2019-07-29 23:42:16 +08:00
主库数据库编码需要设置utf8mb4
2019-12-31 17:28:53 +08:00
windchat.mysql.host=localhost //数据库的地址
windchat.mysql.port=3306 //数据库端口
windchat.mysql.database=openzaly //数据库名称
windchat.mysql.username=root //mysql数据库访问用户
windchat.mysql.password=1234567890 //mysql数据库密码
2019-07-29 23:42:16 +08:00
从库如果需要使用主从模式配置这里不需要从库则不需要配置数据库编码需要设置utf8mb4
2019-12-31 17:28:53 +08:00
windchat.mysql.slave.host=localhost
windchat.mysql.slave.port=3306
windchat.mysql.slave.database=openzaly
windchat.mysql.slave.username=root
windchat.mysql.slave.password=1234567890
2019-07-29 23:42:16 +08:00
其他mysql参数为使用mysql连接池的配置参数如若涉及性能优化可开启配置项。
2019-12-31 17:28:53 +08:00
* 迁移数据库命令WindChat支持使用者把Personal版本的sqlite中的数据迁移到Team版本的mysql数据库
如果执行这一步需要在windchat-server.config配置文件中配置
`windchat.sqlite.url=openzalyDB.sqlite3` 这里指定sqlite数据库文件的位置
2019-07-29 23:42:16 +08:00
继续执行迁移命令:
2019-11-27 23:48:34 +08:00
`java -jar windchat-server.jar -migrate`
2019-07-29 23:42:16 +08:00
2019-11-27 23:48:34 +08:00
* 启动命令:`java -jar windchat-server.jar`
2019-07-29 23:42:16 +08:00
**2. 下载客户端**
2020-05-11 22:18:35 +08:00
Android 客户端:
2020-10-21 13:33:17 +08:00
> Android 端暂未开源,敬请期待
2020-05-11 22:18:35 +08:00
iOS 客户端:
2020-10-21 13:33:17 +08:00
> iOS 端暂未开源,敬请期待
2019-12-31 17:28:53 +08:00
2019-07-29 23:42:16 +08:00
**3. 访问站点**
> * 生成账号(手机账号与匿名均可)
> * 输入站点服务器
> * 首次登陆为管理员邀请码000000
> * 别的用户登陆后可以互加好友,开始聊天。
* 匿名账号,账号保存在设备本地,用户不会填写手机信息,任何地方都获取不到。
> **站点注册方式默认为匿名,进入站点后,请根据情况第一时间修改为 实名 或者 开启邀请码,防止恶意用户进入**
二、源码编译安装
----
2019-11-26 10:57:14 +08:00
- 本地安装Java1.8+
- 需要本地有mvn直接使用mvn编译即可。
2019-07-29 23:42:16 +08:00
三、扩展开发
----
2019-11-26 10:57:14 +08:00
WindChat 具有灵活、强大的扩展机制 `(“管理平台” 就是一个扩展)`。通过嵌入WEB页面与后端的扩展API进行交互 可以很轻松的构建丰富的业务功能,如:
2019-07-29 23:42:16 +08:00
* 附近交友
2020-10-21 13:33:17 +08:00
* 线上打卡
2019-07-29 23:42:16 +08:00
* 店铺点评
* 在线游戏
* 等等等等
你的聊天服务器,将摇身一变,成为一个强大的社交软件平台。
2019-12-31 17:28:53 +08:00
> 扩展机制处于技术预览阶段,如果你希望在自己的业务中开发自己的扩展,可以联系我们( mail: an.guoyue254@gmail.com ),我们将免费提供文档与技术答疑。
2019-07-29 23:42:16 +08:00
四、技术贡献者
----
> 以加入时间排序
2019-11-26 10:57:14 +08:00
* sisishiliuAkaxin/DuckChat创始人
2019-07-29 23:42:16 +08:00
* SAM2O2O
* childeYin
2019-11-26 10:50:02 +08:00
**向我们提问**
2020-10-30 00:55:40 +08:00
>官方微信:<img src="https://images.gitee.com/uploads/images/2020/1030/003752_de901b73_1566564.jpeg" width=200>
2020-02-15 21:33:14 +08:00
2020-02-15 21:32:17 +08:00
> 联系邮件an.guoyue254@gmail.com
2020-05-11 22:33:46 +08:00
**打赏**
开源本不易,如果你觉得对你有帮助,请捐赠以表示支持,感谢!
2020-10-30 00:55:40 +08:00
<img src="https://images.gitee.com/uploads/images/2020/1030/003539_1f1b9765_1566564.jpeg" width=200>
2020-05-11 22:33:46 +08:00
<img src="https://images.gitee.com/uploads/images/2020/0511/223222_9ac22d03_1566564.png" width=200>