@@ -46,21 +46,17 @@ Open-IM-Server并不是一个独立的产品,本身不包含账号的注册和
46
46
47
47
## 快速开始
48
48
49
- ### 安装Open-IM-Server
50
-
51
- > Open-IM-Server依赖于五个开源组件:Zookeeper、MySQL、MongoDB、Redis 和 Kafka。在部署 Open-IM-Server 之前,请确保已安装上述五个组件。如果没有,则建议使用 docker-compose,一键部署,方便快捷。
52
-
53
49
### 使用 docker-compose 部署
54
50
55
- 1 . 隆项目
51
+ 1 . 克隆项目
56
52
57
53
```
58
54
git clone https://github.com/OpenIMSDK/Open-IM-Server
59
55
cd Open-IM-Server
60
56
git checkout release-v3.0 #or other release branch
61
57
```
62
58
63
- 2 . 修改 env
59
+ 2 . 修改 . env
64
60
65
61
```
66
62
此处主要修改相关组件密码
@@ -90,22 +86,7 @@ cd scripts;
90
86
91
87
![ https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png ] ( https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/docker_build.png )
92
88
93
- 5 . 开放 IM 端口
94
-
95
- | TCP 端口 | 说明 | 操作 |
96
- | --------- | ----------------------------------------------------- | --------------------------------------- |
97
- | TCP:10001 | ws 协议,消息端口,如消息发送、推送等,用于客户端 SDK | 端口放行或 nginx 反向代理,并关闭防火墙 |
98
- | TCP:10002 | api 端口,如用户、好友、群组、消息等接口。 | 端口放行或 nginx 反向代理,并关闭防火墙 |
99
- | TCP:10005 | 选择 minio 存储时需要(openIM 默认使用 minio 存储) | 端口放行或 nginx 反向代理,并关闭防火墙 |
100
-
101
- 6 . 开放 Chat 端口
102
-
103
- | TCP 端口 | 说明 | 操作 |
104
- | --------- | ------------------------ | --------------------------------------- |
105
- | TCP:10008 | 业务系统,如注册、登录等 | 端口放行或 nginx 反向代理,并关闭防火墙 |
106
- | TCP:10009 | 管理后台,如统计、封号等 | 端口放行或 nginx 反向代理,并关闭防火墙 |
107
-
108
- ### 使用源代码部署
89
+ ### 使用源码编译
109
90
110
91
1 . Go 1.18或更高版本。
111
92
@@ -129,8 +110,6 @@ cd scripts;
129
110
130
111
![ 编译成功] ( https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/build.png )
131
112
132
- >
133
-
134
113
### 组件配置说明
135
114
136
115
config/config.yaml中针对存储组件有详细的配置说明
@@ -216,6 +195,41 @@ config/config.yaml中针对存储组件有详细的配置说明
216
195
msgToModify: modify
217
196
```
218
197
198
+ ### 启停服务
199
+
200
+ 启动服务
201
+
202
+ ```
203
+ ./start_all.sh;
204
+ ```
205
+
206
+ 检查服务
207
+
208
+ ```
209
+ ./check_all.sh
210
+ ```
211
+
212
+ 停止服务
213
+
214
+ ```
215
+ ./stop_all.sh
216
+ ```
217
+
218
+ ### 开放 IM 端口
219
+
220
+ | TCP 端口 | 说明 | 操作 |
221
+ | --------- | ----------------------------------------------------- | --------------------------------------- |
222
+ | TCP:10001 | ws 协议,消息端口,如消息发送、推送等,用于客户端 SDK | 端口放行或 nginx 反向代理,并关闭防火墙 |
223
+ | TCP:10002 | api 端口,如用户、好友、群组、消息等接口。 | 端口放行或 nginx 反向代理,并关闭防火墙 |
224
+ | TCP:10005 | 选择 minio 存储时需要(openIM 默认使用 minio 存储) | 端口放行或 nginx 反向代理,并关闭防火墙 |
225
+
226
+ ### 开放 Chat 端口
227
+
228
+ | TCP 端口 | 说明 | 操作 |
229
+ | --------- | ------------------------ | --------------------------------------- |
230
+ | TCP:10008 | 业务系统,如注册、登录等 | 端口放行或 nginx 反向代理,并关闭防火墙 |
231
+ | TCP:10009 | 管理后台,如统计、封号等 | 端口放行或 nginx 反向代理,并关闭防火墙 |
232
+
219
233
## APP和OpenIM关系
220
234
221
235
OpenIM 是开源的即时通讯组件,它并不是一个独立的产品,此图展示了AppServer、AppClient、Open-IM-Server以及Open-IM-SDK之间的关系
0 commit comments