更新readme
This commit is contained in:
heavyrian2012
@@ -73,6 +73,59 @@ PC客户端点[这里](https://github.com/wildfirechat/vue-pc-chat/releases)下
|
||||
|
||||
之后再部署开放平台服务、频道（公众号）服务、机器人服务、推送服务、Turn服务（音视频服务）来实现完整的应用功能，详情可以详细阅读文档。
|
||||
|
||||
## 联系我们
|
||||
商务合作请微信联系：
|
||||
|
||||
* 微信1：wildfirechat
|
||||
* 微信2：wfchat
|
||||
|
||||
## 问题交流
|
||||
|
||||
1. 如果大家发现bug，请在GitHub或码云提issue；如果有需求也请给我们提issue。
|
||||
2. 其他问题，请到[野火IM论坛](http://bbs.wildfirechat.cn/)进行交流学习
|
||||
3. 关注我们的公众号。我们有新版本发布或者有重大更新会通过公众号通知大家，另外我们也会不定期的发布一些关于野火IM的技术介绍。
|
||||
|
||||
<img src="http://static.wildfirechat.cn/wx_wfc_qrcode.jpg" width = 50% height = 50% />
|
||||
|
||||
我们有核心研发工程师轮流值班处理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. 部署[应用服务](https://github.com/wildfirechat/app-server)，配置和编译[Android客户端](https://github.com/wildfirechat/android-chat)和[iOS客户端](https://github.com/wildfirechat/ios-chat)进行验证。详情可参考[快速开始](https://docs.wildfirechat.cn/quick_start/)。
|
||||
|
||||
## 打包RPM格式
|
||||
打包会生成Java包和deb安装包，如果需要rpm安装包，请在```distribution/pom.xml```中取消注释生成rpm包的plugin。另外还需要本地安装有rpm，在linux或者mac系统中很容易安装，在windows系统需要安装cygwin并安装rpm，具体信息请百度查询。
|
||||
|
||||
修改之后运行编译命令```mvn clean package```，rpm包生成在```distribution/target```目录下。
|
||||
|
||||
## 升级说明
|
||||
1. 从0.42 版本增加了群成员数限制，默认为2000。如果您从之前的版本升级到这个版本或以后，需要注意到群成员数的限制。升级之后超出限制的群不受影响，但不能继续加人，如果您想修改默认值，可以在升级版本之后，修改t_setting表，把默认的大小改为您期望的人数。另外修改t_group表，把已经存在的群组max_member_count改成您期望的，然后重启。
|
||||
2. 0.50版本添加了是否允许客户端发送群操作通知的配置。如果您在客户端自定义群通知，需要在服务器端配置允许，没有使用自定义群操作通知的不受影响。***
|
||||
3. 0.46和0.47版本升级到0.48及以后版本时，可能会提示flyway migrate 38错误，请执行 [修复脚本](https://github.com/wildfirechat/server/blob/wildfirechat/flyway_repaire_migrate_38.sql) 进行修复。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```，如果是升级服务，请注意更新启动脚本。
|
||||
|
||||
## 应用截图
|
||||
登录界面
|
||||
|
||||
@@ -172,58 +225,6 @@ IM服务管理后台
|
||||
|
||||
> 更多详细信息请下载demo进行体验。
|
||||
|
||||
## 编译
|
||||
由于```distribution/pom.xml```中使用了生成RPM包的plugin，所以需要本地安装有rpm。如果不需要RPM包，可以删除掉```distribution/pom.xml```文件中的RPM plugin。
|
||||
|
||||
在安装RPM后或者删除```distribution/pom.xml```文件中的RPM plugin后，执行下面命令：
|
||||
```
|
||||
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. 部署[应用服务](https://github.com/wildfirechat/app-server)，配置和编译[Android客户端](https://github.com/wildfirechat/android-chat)和[iOS客户端](https://github.com/wildfirechat/ios-chat)进行验证。详情可参考[快速开始](https://docs.wildfirechat.cn/quick_start/)。
|
||||
|
||||
## 升级说明
|
||||
1. 从0.42 版本增加了群成员数限制，默认为2000。如果您从之前的版本升级到这个版本或以后，需要注意到群成员数的限制。升级之后超出限制的群不受影响，但不能继续加人，如果您想修改默认值，可以在升级版本之后，修改t_setting表，把默认的大小改为您期望的人数。另外修改t_group表，把已经存在的群组max_member_count改成您期望的，然后重启。
|
||||
2. 0.50版本添加了是否允许客户端发送群操作通知的配置。如果您在客户端自定义群通知，需要在服务器端配置允许，没有使用自定义群操作通知的不受影响。***
|
||||
3. 0.46和0.47版本升级到0.48及以后版本时，可能会提示flyway migrate 38错误，请执行 [修复脚本](https://github.com/wildfirechat/server/blob/wildfirechat/flyway_repaire_migrate_38.sql) 进行修复。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```，如果是升级服务，请注意更新启动脚本。
|
||||
|
||||
|
||||
## 联系我们
|
||||
|
||||
商务合作请微信联系：
|
||||
|
||||
* 微信1：wildfirechat
|
||||
* 微信2：wfchat
|
||||
|
||||
## 问题交流
|
||||
|
||||
1. 如果大家发现bug，请在GitHub或码云提issue；如果有需求也请给我们提issue。
|
||||
2. 其他问题，请到[野火IM论坛](http://bbs.wildfirechat.cn/)进行交流学习
|
||||
3. 关注我们的公众号。我们有新版本发布或者有重大更新会通过公众号通知大家，另外我们也会不定期的发布一些关于野火IM的技术介绍。
|
||||
|
||||
<img src="http://static.wildfirechat.cn/wx_wfc_qrcode.jpg" width = 50% height = 50% />
|
||||
|
||||
我们有核心研发工程师轮流值班处理issue和论坛，会及时处理的，疑难Bug的修改和新需求的开发我们也会尽快解决。
|
||||
|
||||
## 特别感谢
|
||||
1. [moquette](https://github.com/moquette-io/moquette) 本项目是基于此项目二次开发而来，处理MQTT相关业务。
|
||||
2. [loServer](https://github.com/looly/loServer) 本项目使用loServer处理HTTP相关业务。
|
||||
|
||||
+63
-66
@@ -130,73 +130,70 @@
|
||||
</executions>
|
||||
</plugin>
|
||||
|
||||
<!-- 打包RPM 开始-->
|
||||
<!-- 打包RPM 包需要本地有rpm命令才可以，linux和mac都可以安装rpm。如果是windows需要cygwin安装rpm才可以，如果不需要rpm包，可以把这个plugin注释掉-->
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>rpm-maven-plugin</artifactId>
|
||||
<version>2.2.0</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-rpm</id>
|
||||
<goals>
|
||||
<goal>rpm</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
|
||||
<configuration>
|
||||
<group>Applications/Chat</group>
|
||||
<name>im-server</name>
|
||||
<needarch>noarch</needarch>
|
||||
<targetOS>linux</targetOS>
|
||||
<prefix>/opt/im-server</prefix>
|
||||
<defineStatements>
|
||||
<defineStatement>_unpackaged_files_terminate_build 0</defineStatement>
|
||||
</defineStatements>
|
||||
<copyTo>
|
||||
target/im-server-${project.version}.rpm
|
||||
</copyTo>
|
||||
<requires>
|
||||
<require>java-1.8.0-openjdk-headless</require>
|
||||
</requires>
|
||||
|
||||
<mappings>
|
||||
<mapping>
|
||||
<directory>/opt/im-server</directory>
|
||||
<filemode>755</filemode>
|
||||
<sources>
|
||||
<source>
|
||||
<location>${project.build.directory}/distribution-${project.version}-bundle-tar.tar.gz</location>
|
||||
</source>
|
||||
</sources>
|
||||
</mapping>
|
||||
|
||||
<mapping>
|
||||
<directory>/usr/lib/systemd/system</directory>
|
||||
<filemode>644</filemode>
|
||||
<username>root</username>
|
||||
<groupname>root</groupname>
|
||||
<directoryIncluded>false</directoryIncluded>
|
||||
<sources>
|
||||
<source>
|
||||
<location>${project.basedir}/../systemd/im-server.service</location>
|
||||
</source>
|
||||
</sources>
|
||||
</mapping>
|
||||
</mappings>
|
||||
<postinstallScriptlet>
|
||||
<scriptFile>${project.basedir}/src/main/rpm/install.sh</scriptFile>
|
||||
<fileEncoding>utf-8</fileEncoding>
|
||||
<filter>true</filter>
|
||||
</postinstallScriptlet>
|
||||
<postremoveScriptlet>
|
||||
<scriptFile>${project.basedir}/src/main/rpm/uninstall.sh</scriptFile>
|
||||
<fileEncoding>utf-8</fileEncoding>
|
||||
<filter>true</filter>
|
||||
</postremoveScriptlet>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<!-- 打包RPM插件，如果需要打包RPM格式请打开下面注释 -->
|
||||
<!-- <plugin>-->
|
||||
<!-- <groupId>org.codehaus.mojo</groupId>-->
|
||||
<!-- <artifactId>rpm-maven-plugin</artifactId>-->
|
||||
<!-- <version>2.2.0</version>-->
|
||||
<!-- <executions>-->
|
||||
<!-- <execution>-->
|
||||
<!-- <id>generate-rpm</id>-->
|
||||
<!-- <goals>-->
|
||||
<!-- <goal>rpm</goal>-->
|
||||
<!-- </goals>-->
|
||||
<!-- </execution>-->
|
||||
<!-- </executions>-->
|
||||
<!-- <configuration>-->
|
||||
<!-- <group>Applications/Chat</group>-->
|
||||
<!-- <name>im-server</name>-->
|
||||
<!-- <needarch>noarch</needarch>-->
|
||||
<!-- <targetOS>linux</targetOS>-->
|
||||
<!-- <prefix>/opt/im-server</prefix>-->
|
||||
<!-- <defineStatements>-->
|
||||
<!-- <defineStatement>_unpackaged_files_terminate_build 0</defineStatement>-->
|
||||
<!-- </defineStatements>-->
|
||||
<!-- <copyTo>-->
|
||||
<!-- target/im-server-${project.version}.rpm-->
|
||||
<!-- </copyTo>-->
|
||||
<!-- <requires>-->
|
||||
<!-- <require>java-1.8.0-openjdk-headless</require>-->
|
||||
<!-- </requires>-->
|
||||
<!-- <mappings>-->
|
||||
<!-- <mapping>-->
|
||||
<!-- <directory>/opt/im-server</directory>-->
|
||||
<!-- <filemode>755</filemode>-->
|
||||
<!-- <sources>-->
|
||||
<!-- <source>-->
|
||||
<!-- <location>${project.build.directory}/distribution-${project.version}-bundle-tar.tar.gz</location>-->
|
||||
<!-- </source>-->
|
||||
<!-- </sources>-->
|
||||
<!-- </mapping>-->
|
||||
<!-- <mapping>-->
|
||||
<!-- <directory>/usr/lib/systemd/system</directory>-->
|
||||
<!-- <filemode>644</filemode>-->
|
||||
<!-- <username>root</username>-->
|
||||
<!-- <groupname>root</groupname>-->
|
||||
<!-- <directoryIncluded>false</directoryIncluded>-->
|
||||
<!-- <sources>-->
|
||||
<!-- <source>-->
|
||||
<!-- <location>${project.basedir}/../systemd/im-server.service</location>-->
|
||||
<!-- </source>-->
|
||||
<!-- </sources>-->
|
||||
<!-- </mapping>-->
|
||||
<!-- </mappings>-->
|
||||
<!-- <postinstallScriptlet>-->
|
||||
<!-- <scriptFile>${project.basedir}/src/main/rpm/install.sh</scriptFile>-->
|
||||
<!-- <fileEncoding>utf-8</fileEncoding>-->
|
||||
<!-- <filter>true</filter>-->
|
||||
<!-- </postinstallScriptlet>-->
|
||||
<!-- <postremoveScriptlet>-->
|
||||
<!-- <scriptFile>${project.basedir}/src/main/rpm/uninstall.sh</scriptFile>-->
|
||||
<!-- <fileEncoding>utf-8</fileEncoding>-->
|
||||
<!-- <filter>true</filter>-->
|
||||
<!-- </postremoveScriptlet>-->
|
||||
<!-- </configuration>-->
|
||||
<!-- </plugin>-->
|
||||
<!-- 打包RPM 结束-->
|
||||
|
||||
</plugins>
|
||||
|
||||
Reference in New Issue
Block a user