Skip to content

Commit 717da04

Browse files
skiffer-gitskiffer-git
authored
Merge pull request #159 from mo3et/docs/ser
docs: upgrade to Server v3.8.1 docs.
2 parents caf62a7 + 0e908f6 commit 717da04

181 files changed

Lines changed: 1503 additions & 1415 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/guides/gettingStarted/imSourceCodeDeployment.mdx‎

Lines changed: 50 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -5,48 +5,52 @@ sidebar_position: 1
55

66
# 🛠 源码部署
77

8-
## 1. 环境及组件要求
8+
## 1. 环境及组件要求
9+
910
对于服务器环境、系统、以及所依赖组件的说明可以参考[此文档](./env-comp)
1011

11-
## 2. 部署 OpenIM Server (IM)
12+
## 2. 部署 OpenIM Server (IM)
13+
14+
### 2.1 clone 仓库 建议切换到 release-v3.8 分支
1215

13-
### 2.1 clone仓库 建议切换到release-v3.8分支
1416
```
1517
git clone https://github.com/openimsdk/open-im-server && cd open-im-server
1618
```
1719

18-
### 2.2 部署组件 (mongodb/redis/zookeeper/kafka/MinIO等)
20+
### 2.2 部署组件 (mongodb/redis/zookeeper/kafka/MinIO 等)
21+
1922
```
2023
docker compose up -d
2124
```
2225

26+
### 2.3 设置外网 IP 或域名[参考 Nginx 配置](./nginxDomainConfig.mdx)
2327

24-
### 2.3 设置外网IP 或域名[参考Nginx配置](./nginxDomainConfig.mdx)
2528
```
26-
修改config/minio.yml中的externalAddress为http://外网IP:port 或 域名
27-
修改config/openim-api.yml中的grafanaURL: http://127.0.0.1:13000/为http://外网IP:port 或 域名
29+
修改 config/minio.yml 中的 externalAddress 为 http://外网IP:port 或 域名
30+
修改 config/openim-api.yml 中的 grafanaURL: http://127.0.0.1:13000/ 为 http://外网IP:port 或 域名
2831
```
2932

30-
3133
### 2.4 🛠️ 初始化
32-
第一次编译前，linux/mac平台下执行：
34+
35+
第一次编译前，linux/mac 平台下执行：
36+
3337
```
3438
bash bootstrap.sh
3539
```
36-
windows执行
40+
41+
windows 执行
42+
3743
```
3844
bootstrap.bat
3945
```
4046

47+
### 2.5 🛠️ 编译(linux/windows/mac 平台均可用)
4148

42-
43-
### 2.5 🛠️ 编译(linux/windows/mac平台均可用)
4449
```
4550
mage
4651
```
4752

48-
49-
### 2.6 🚀 启动/停止/检测(linux/windows/mac平台均可用)
53+
### 2.6 🚀 启动/停止/检测(linux/windows/mac 平台均可用)
5054

5155
```
5256
# 启动
@@ -59,34 +63,39 @@ mage stop
5963
mage check
6064
```
6165

62-
6366
### 2.7 其他配置项修改
67+
6468
[参考链接](https://github.com/openimsdk/open-im-server/blob/main/config/README.md)
6569

70+
## 3. 部署 App Server (Chat)
6671

72+
### 3.1 clone 仓库 建议切换到 release-v1.8 分支
6773

68-
## 3. 部署 App Server (Chat)
69-
### 3.1 clone仓库 建议切换到release-v1.8分支
7074
```
7175
git clone https://github.com/openimsdk/chat&& cd chat
7276
```
77+
7378
### 3.2 🛠️ 初始化
74-
第一次编译前，linux/mac平台下执行：
79+
80+
第一次编译前，linux/mac 平台下执行：
81+
7582
```
7683
bash bootstrap.sh
7784
```
78-
windows执行
85+
86+
windows 执行
87+
7988
```
8089
bootstrap.bat
8190
```
8291

83-
### 3.3 🛠️ 编译(linux/windows/mac平台均可用)
92+
### 3.3 🛠️ 编译(linux/windows/mac 平台均可用)
93+
8494
```
8595
mage
8696
```
8797

88-
89-
### 3.4 🚀 启动/停止/检测(linux/windows/mac平台均可用)
98+
### 3.4 🚀 启动/停止/检测(linux/windows/mac 平台均可用)
9099

91100
```
92101
# 启动
@@ -101,21 +110,20 @@ mage check
101110
```
102111

103112
### 3.5 其他配置项修改
104-
[参考链接](https://github.com/openimsdk/chat/blob/main/config/README.md)
105113

114+
[参考链接](https://github.com/openimsdk/chat/blob/main/config/README.md)
106115

107116
---
117+
108118
---
109119

110-
## 以下是release-v3.6及之前的版本部署流程
120+
## 以下是 release-v3.6 及之前的版本部署流程
121+
111122
## 2. 部署 OpenIM Server (IM)
112123

113124
### 2.1 📡 设置 OPENIM_IP
114125

115-
116-
117-
118-
🔔 **必须要设置OPENIM_IP，且不能是127.0.0.1**
126+
🔔 **必须要设置 OPENIM_IP，且不能是 127.0.0.1**
119127

120128
```
121129
# 如果服务器有外网IP
@@ -125,16 +133,10 @@ export OPENIM_IP="外网IP"
125133
export OPENIM_IP="内网IP"
126134
```
127135

128-
129-
130-
131-
132-
133-
134-
### 2.2 🏗️ 部署组件 (mongodb/redis/zookeeper/kafka/MinIO等)
136+
### 2.2 🏗️ 部署组件 (mongodb/redis/zookeeper/kafka/MinIO 等)
135137

136138
```
137-
git clone https://github.com/OpenIMSDK/open-im-server && cd open-im-server
139+
git clone https://github.com/openimsdk/open-im-server && cd open-im-server
138140
# 建议切换到release-v3.6及以后的release分支
139141
make init && docker compose up -d
140142
@@ -163,12 +165,13 @@ make check
163165

164166
## 3. 部署 App Server (Chat)
165167

166-
### 3.1 🏗️ clone chat仓库
168+
### 3.1 🏗️ clone chat 仓库
169+
167170
```
168171
#返回上一级目录
169172
cd ..
170173
# clone仓库 建议切换到release-v1.6及以后的release分支
171-
git clone https://github.com/OpenIMSDK/chat chat && cd chat
174+
git clone https://github.com/openimsdk/chat chat && cd chat
172175
```
173176

174177
### 3.2 🛠️ 编译
@@ -207,11 +210,11 @@ make check
207210

208211
### 6.1 🛠️ 共用配置项的修改
209212

210-
| 配置项 | 需要修改的文件 | 操作 |
211-
| --- | --- | --- |
212-
| mongo/kafka/minio 相关 | .env, openim-server/config/config.yaml | 需重启组件和 IM |
213-
| redis/zookeeper 相关 | .env, openim-server/config/config.yaml, chat/config/config.yaml | 需重启组件、IM 和 Chat |
214-
| SECRET | openim-server/config/config.yaml, chat/config/config.yaml | 需重启 IM 和 Chat |
213+
| 配置项 | 需要修改的文件 | 操作 |
214+
| ---------------------- | --------------------------------------------------------------- | ---------------------- |
215+
| mongo/kafka/minio 相关 | .env, openim-server/config/config.yaml | 需重启组件和 IM |
216+
| redis/zookeeper 相关 | .env, openim-server/config/config.yaml, chat/config/config.yaml | 需重启组件、IM 和 Chat |
217+
| SECRET | openim-server/config/config.yaml, chat/config/config.yaml | 需重启 IM 和 Chat |
215218

216219
### 6.2 🔄 共用配置项中特殊配置项的修改
217220

@@ -230,25 +233,22 @@ object:
230233
grafanaUrl: http://$OPENIM_IP:$GRAFANA_PORT
231234
```
232235

233-
234236
3. 在 **`chat/config/config.yaml`** 中按照规则修改配置
235237

236238
```jsx
237239
如果IM在Chat不在同一台机器上，则需将127.0.0.1替换成IM所在机器的IP
238240
openIMUrl: "http://127.0.0.1:$API_OPENIM_PORT"
239241
```
240242

241-
242-
243243
4. 重启 IM 和 Chat
244244

245245
### 6.3 🛠️ 其他配置项的修改
246246

247247
对于 **`.env`**、**`chat/config/config.yaml`** 和 **`openim-server/config/config.yaml`** 中的其他配置项，可以单独修改相应文件中的这些配置项。
248248

249-
250249
### 6.4 端口的修改
251-
特别注意的是，对于IM相关任何端口的修改，都需要同步修改open-im-server/scripts/install/environment.sh中的端口
250+
251+
特别注意的是，对于 IM 相关任何端口的修改，都需要同步修改 open-im-server/scripts/install/environment.sh 中的端口
252252

253253
---
254254

@@ -261,20 +261,14 @@ openIMUrl: "http://127.0.0.1:$API_OPENIM_PORT"
261261
- 运行时日志，启动成功后定位问题时查看：`_output/logs/openim-all*`
262262
- 启动时日志，启动有错误时查看：`_output/logs/openim-*.log`
263263

264-
265-
266264
### 7.2 🚀 启动顺序
267265

268266
启动顺序如下：
269267

270-
- IM 依赖的组件：mongo/redis/kafka/zookeeper/minio等
268+
- IM 依赖的组件：mongo/redis/kafka/zookeeper/minio 等
271269
- **IM**
272270
- **Chat**
273271

274272
### 7.3 🐳 Docker 版本
275273

276-
新版 Docker 已经整合了 docker-compose. 老版本的 Docker 可能不支持 gateway 功能❌。我们建议您升级到较新的版本，例如 `23.0.1`🔝
277-
278-
279-
280-
274+
新版 Docker 已经整合了 docker-compose. 老版本的 Docker 可能不支持 gateway 功能 ❌。我们建议您升级到较新的版本，例如 `23.0.1`🔝

‎docs/guides/gettingStarted/k8s-deployment.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ OpenIM支持多种集群部署方法，包括但不限于`helm`、`sealos`、`ku
1212

1313
多个贡献者和之前的官方版本都提供了一些可供参考的解决方案：
1414

15-
+ [k8s-jenkins仓库](https://github.com/OpenIMSDK/k8s-jenkins)
15+
+ [k8s-jenkins仓库](https://github.com/openimsdk/k8s-jenkins)
1616
+ [open-im-server-k8s-deploy仓库](https://github.com/openimsdk/open-im-server-k8s-deploy)
17-
+ [openim-charts仓库](https://github.com/OpenIMSDK/openim-charts)
17+
+ [openim-charts仓库](https://github.com/openimsdk/openim-charts)
1818
+ [deploy-openim仓库](https://github.com/showurl/deploy-openim)
1919

2020
### 依赖性检查

‎docs/guides/introduction/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ sidebar_position: 1
1212

1313
> ⭐️ 我们感谢每一位支持我们的开发者。您的支持是我们力争成为开源IM领域领先者的坚实基石！
1414
15-
[🔗 访问我们的Github仓库了解更多](https://github.com/OpenIMSDK/Open-IM-Server)
15+
[🔗 访问我们的Github仓库了解更多](https://github.com/openimsdk/open-im-server)
1616

1717
# 我们的团队
1818

‎docs/guides/introduction/product.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ sidebar_position: 1
1111
需要注意的是，开发者需要开发客户端UI，而OpenIM的DEMO仅作为参考。
1212

1313

14-
OpenIM 是由两大核心组件构成的即时通讯解决方案：**OpenIMSDK** 和 **OpenIMServer**。以下是其主要特征：
14+
OpenIM 是由两大核心组件构成的即时通讯解决方案：**OpenIM SDK** 和 **OpenIM Server**。以下是其主要特征：
1515

16-
📦 **OpenIMSDK**:
16+
📦 **OpenIM SDK**:
1717
- 作为库文件形式，直接嵌入到应用程序中，便于开发者快速集成。
1818

19-
🖥️ **OpenIMServer**:
19+
🖥️ **OpenIM Server**:
2020
- 作为独立的服务端程序私有化部署，提供强大的消息管理、分发、推送能力。
2121

2222

2323

2424
![关系示意图](./assets/relation.png)
2525

26-
# 📘 详解OpenIMSDK
26+
# 📘 详解OpenIM SDK
2727

28-
**OpenIMSDK** 是为 **OpenIMServer** 设计的IM SDK，嵌入客户端应用中。其主要功能和技术特点如下：
28+
**OpenIM SDK** 是为 **OpenIM Server** 设计的IM SDK，嵌入客户端应用中。其主要功能和技术特点如下：
2929

3030
## 🌟 主要功能：
3131
- 📦 本地存储
@@ -63,23 +63,23 @@ OpenIM 是由两大核心组件构成的即时通讯解决方案：**OpenIMSDK**
6363
| Unity | [open-im-sdk-unity](https://github.com/openimsdk/open-im-sdk-unity) | Unity SDK | [open-im-unity-demo](https://github.com/openimsdk/open-im-unity-demo) | Unity示例 |
6464
| C/C++ | [open-im-sdk-cpp](https://github.com/openimsdk/openim-sdk-cpp) | C/C++ SDK | | |
6565

66-
## 🔍 详解OpenIMServer
66+
## 🔍 详解OpenIM Server
6767

68-
**OpenIMServer** 具有以下特点：
68+
**OpenIM Server** 具有以下特点：
6969

7070
- 🧩 多模块构成，如网关(gateway)和多个rpc服务。
7171
- 🌐 微服务架构，支持集群模式。
7272
- 🚀 部署方式多样，如源代码、kubernetes或docker部署。
7373

74-
[🔗 OpenIMServer 仓库地址](https://github.com/openimsdk/open-im-server)
74+
[🔗 OpenIM Server 仓库地址](https://github.com/openimsdk/open-im-server)
7575

7676
### 🌐 REST API
7777

78-
- OpenIMServer 提供了REST API供业务系统使用，例如通过建立群组、发送推送消息等。REST API以APP管理员身份调用，旨在赋予业务更多功能。
78+
- OpenIM Server 提供了REST API供业务系统使用，例如通过建立群组、发送推送消息等。REST API以APP管理员身份调用，旨在赋予业务更多功能。
7979

8080
### 📞 Webhook
8181

82-
- OpenIMServer提供了回调能力以扩展更多的业务形态，所谓回调，即OpenIMServer会在某一事件发生之前或者之后，向指定的服务器发送请求，如发送消息之前或之后的回调。
82+
- OpenIM Server提供了回调能力以扩展更多的业务形态，所谓回调，即OpenIM Server会在某一事件发生之前或者之后，向指定的服务器发送请求，如发送消息之前或之后的回调。
8383

8484

8585

0 commit comments

Comments
 (0)