im/README.md

193 lines
7.8 KiB
Markdown
Executable File
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# IM即时聊天
#### 介绍
Raingad-IM是一个开源的即时通信demo需要前后端配合使用主要用于学习交流为大家提供即时通讯的开发思路许多功能需要自行开发开发的初衷旨在快速建立企业内部通讯系统、内网交流、社区交流。
| 类型 | 链接 |
| --------- | ---- |
| 前端源码 | https://gitee.com/raingad/im-chat-front |
| 后端源码 | https://gitee.com/raingad/im-instant-chat |
| web端演示 | http://im.raingad.com/index.html |
| 移动端H5演示 | http://im.raingad.com/h5 |
| 安卓APP演示 | https://emoji.raingad.com/file/raingad.apk |
体验账号13800000002 密码123456
尾号2、3、4......18、19、20 都是
体验账号13800000020 密码123456
#### 支持功能
1. 支持单聊和群聊,支持发送表情、图片、语音、视频和文件消息
2. 单聊支持消息已读未读的状态显示,在线状态显示
3. 群聊创建、删除和群成员管理、群公告、群禁言等
4. 支持置顶联系人,消息免打扰;支持设置新消息声音提醒,浏览器通知
5. 支持一对一音视频通话已打通web端和移动端
6. 支持文件、图片和绝大部分媒体文件在线预览
7. 支持移动端H5、APP和小程序部分功能不兼容支持简易后台管理
8. 全新支持企业模式和社区模式,社区模式支持注册、添加好友功能
#### 最新更新
**v-3.0.0** (2023年9月4日)
<font color="red">不兼容之前的版本!!!</font>
1. 全新升级,不兼容之前版本.
2. 修改登录方式新增JWT token登录不再服务器缓存登录信息节约服务器资源。
3. 新增聊天内容加密,聊天数据更安全,请仔细阅读 `.example.env` 里面的配置.
4. 消息推送服务可以自定义端口,已集成到环境配置文件中 `.example.env` 仅支持linuxwindow请按照原来的方式操作。
5. 新增websocket连接认证未认证会被断开连接。
6. 新增群二维码,移动端可以扫码加群。暂未实现聊天中长按图片识别二维码加群。
7. 修复聊天记录重复加载的情况。
8. 修复历史消息不会实时置为已读的情况。
9. 优化若干样式和bug
**v-2.8.25** (2023年8月25日)
1. 优化移动端的websocket连接
2. 移动端新增记住密码
3. 优化消息接收的处理以及上下线状态
4. 移动端完善用户资料修改,密码修改等
5. 打通移动端和web端的音视频互通有bug但是可以忽略已开源web端音视频源码
6. 新增音视频通话消息类型
**v-2.8.1** (2023年8月1日)
1. 移动端新增消息撤回、复制消息的发送状态1对1消息已读、未读状态
2. 移动端修复聊天页面中,消息不能滚动到底部的情况
3. 移动端新增音视频通话引导用户获取音视频权限
4. web端新增截屏功能功能用的第三方插件虽然有瑕疵但是很强大
5. 优化websocket掉线问题增加客户端主动心跳
6. 优化web端浏览器通知
7. 移动端支持社区模式,加好友等功能
8. 新增邮件加密方式选择
9. 兼容php7.4
10. 修复element-ui图标有时候加载乱码
**v-2.7.14** (2023年7月14日)
1. 支持简易后台管理
2. 全新支持企业模式和社区模式,可自由切换
3. 新增阿里云、七牛云、腾讯云等对象储存
4. 新增群头像自动生成
5. 新增人员资料查看
6. 新增文件管理,可以快速发送到聊天。
7. 新增移动端1对1音视频通话不和web端互通
**v-2.5.30** (2023年5月20日)
1. 新增windows系统的支持建议windows仅用于开发环境正式环境请使用linux。
2. 新增企业模式下全局发送消息的演示页面。
**v-1.10.30** (2022年10月30日)
1. 升级vue-cli2到vue-cli3
2. 优化发送按键和换行键
3. 新增语音消息、视频消息
4. 新增支持音视频通话peerjs
5. 使用sass依赖替代node-sass这东西太坑了
**v-0.1.0** (2021年04月24日)
1. 项目建立,只是有项目需要,才开发了这个应用
#### 软件架构
后端技术栈:`thinkphp6+workerman+redis`
前端技术栈:`vue2+Lemon-IMUI+element-UI`
#### 安装教程
##### 源码下载
- 克隆代码到本地:
```
git clone https://gitee.com/raingad/im-instant-chat.git
```
- 进入项目目录,执行:
```
composer install
```
或者
- 下载完整源码放到自己的服务器上。请注意看gitee项目主页顶部 `右侧的发行版`,请在发行版中下载最新发布的版本。
##### 开始安装
1. 开启伪静态下面只展示nginx的Apache的已内置
```
location ~* (runtime|application)/{
return 403;
}
location / {
if (!-e $request_filename){
rewrite ^(.*)$ /index.php?s=$1 last; break;
}
}
```
3. 访问你的ip或者域名即可进入自定义安装向导。
4. 先参考下一章“启动消息推送服务”,再来安装程序最佳。
ps必须要取消禁用的函数 `shell_exec` `proc_open` `pcntl_exec`。其它的根据调试情况来取消禁用
##### 如果安装失败
1. 进入 `public\sql\database.sql` 将数据库导入自己的数据库。
2. 进入项目根目录,修改 `example.env``.env` ,并修改数据库相应的参数,**请仔细阅读env中的配置说明**。
PS如需开启聊天文件存入oss需要在后台中进行配置配置后不要再对环境配置文件进行修改。
#### 启动消息推送服务
因为是聊天软件需要用到websockt所以我们需要启动workerman系统已经内置了相应的服务可以在后台管理首页进行运行服务但是首次使用需要先进行调试。
1. 进入项目根目录 运行 `php think worker:gateway start -d`,或者运行 `php start.php start -d` 即可运行消息服务,测试时不要`-d`。windows下请直接运行根目录下的`start_for_win.bat`文件由于Workerman在Windows下有诸多使用限制所以正式环境建议用Linux系统windows系统仅建议用于开发环境。
2. 消息服务需要放行 8282 端口,如需修改,请修改环境噢配置文件中`WORKEER` 板块的相应参数。windows用户请修改 [ `app\worker\start_gateway.php`] 中的 8282 端口。端口号根据情况需改如果修改了端口号需要将前端的程序修改并重新打包上传到项目的public目录下。
3. 系统采用直接用域名作为websocket服务的地址所以监听端口需要在网站的nginx中配置代理并监听8282端口。
```
location /wss
{
proxy_pass http://127.0.0.1:8282;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header X-Real-IP $remote_addr;
}
```
4. 更多关于workerman的使用请进入[workerman官网](https://www.workerman.net/)官网进行查阅。
5. 部署完成之后管理员账号密码为:`administrator` `123456`,管理入口在聊天界面的左下角。
#### 安装部署服务
服务器要求:
| 所需环境 | 版本 | 备注 |
| --------- | ---- | ---- |
| linux | >= 7.0 | 以下的版本未做测试 |
| php | >= 7.1 | 不兼容8 |
| mysql | >= 5.7 | 必须要5.7及以上 |
| redis | >= 5.0 | |
| workerman | >= 4.0 | 用于消息服务部署 |
作者提供本系统的安装服务包括后端和前端部署到线上保证项目的完美运行200元/次安装服务可赠送web端音视频通话源码如有需要可以进群联系作者
#### 交流群
如果有什么问题请留言或者加入我们的QQ群
创作不易点个star吧
[QQ 交流群336921267](https://jq.qq.com/?_wv=1027&k=jMQAt9lh)