Skip to content

Commit 34d6985

Browse files
committed
feat: faq doc
1 parent 17420ee commit 34d6985

2 files changed

Lines changed: 53 additions & 6 deletions

File tree

docs/guides/gettingStarted/cluster.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ sidebar_position: 5
1616
- **Kafka 集群地址**: `kafkaAddr1`, `kafkaAddr2`, `kafkaAddr3`
1717
- **Etcd 集群地址**: `etcdAddr1`, `etcdAddr2`, `etcdAddr3`
1818

19-
本文假设以上组件都部署在三台机器上,实际上不限于三台,您可根据需求自行选择多台或者一台。
19+
本文假设以上组件都部署在三台机器上,实际上不限于三台,**您可根据需求自行选择多台或者一台**
2020

2121
此外,MinIO 的内部服务访问地址配置为 `your_minio_internal_address`,外部访问地址配置为 `your_minio_external_address`
2222
A 和 B 两台机器以及组件集群内网互通,且A、B两台机器都有外网IP。
@@ -199,7 +199,6 @@ mage start
199199

200200

201201

202-
203202
## **常见问题/注意事项**
204203

205204
1. 部署`kafka`时,需要修改`kafka`广播的端口。如果使用`open-im-server`中的`docker-compose.yml`部署,修改`service.kafka.environment.KAFKA_CFG_ADVERTISED_LISTENERS`中的`EXTERNAL`为访问`kafka`组件的地址。其他部署方式请自行修改。

docs/guides/gettingStarted/faq.mdx

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,11 @@ sidebar_position: 20
3636
### 源码部署
3737

3838
1. **进入已有的 `open-im-server` 目录:**
39+
3940
```bash
4041
cd open-im-server
4142
```
42-
43+
4344
2. **停止当前服务:**
4445
```bash
4546
mage stop
@@ -56,21 +57,67 @@ sidebar_position: 20
5657
mage start
5758
```
5859

60+
5961
---
62+
## 二、 如何迁移数据
6063

64+
在使用`docker compose up -d`命令启动`OpenIM`依赖的各个组件之后,`open-im-server`根目录下会生成一个`components`的文件夹,`open-im-server`运行后产生的数据(如用户、群聊、消息等等)都保存在这个文件夹中。如果需要迁移数据,需要先关闭服务和组件:
6165

66+
`docker`部署:
6267

68+
```sh
69+
docker compose down
70+
```
6371

64-
---
65-
## 二、 如何迁移数据
72+
源码部署:
73+
74+
```sh
75+
mage stop # 关闭服务
76+
docker compose down # 关闭组件
77+
```
78+
79+
然后移动整个文件夹到新的位置,再启动服务和组件:
80+
81+
`docker`部署:
82+
83+
```sh
84+
docker compose up -d # 启动组
85+
```
86+
87+
源码部署:
6688

89+
```sh
90+
docker compose up -d # 启动组件
91+
mage start # 启动服务
92+
```
6793

6894
---
6995
## 三、 如何清除数据
7096

97+
如需要清除数据,需要先关闭服务和组件:
98+
99+
`docker`部署:
100+
101+
```sh
102+
docker compose down
103+
```
104+
105+
源码部署:
106+
107+
```sh
108+
mage stop # 关闭服务
109+
docker compose down # 关闭组件
110+
```
111+
112+
然后删除`open-im-server`下的`components`文件夹。
113+
114+
客户端方面需要重新卸载重装`app`
115+
71116
---
72117
## 四、 发送文本消息正常,但发送图片失败
73118

119+
一般发送图片失败是由于没有配置第三方存储的原因。默认使用的第三方存储为`minio`,需要修改`open-im-server`下的`config/minio.yml`文件,将其中`externalAddress`字段中的`external_ip`替换为机器的外网`ip`,然后重新启动服务即可。
120+
74121
---
75122

76123
## 五、 减少Mongo、Kafka内存占用
@@ -95,4 +142,5 @@ sidebar_position: 20
95142

96143

97144

98-
---
145+
---
146+

0 commit comments

Comments
 (0)