diff --git a/docs/guides/gettingStarted/cluster.mdx b/docs/guides/gettingStarted/cluster.mdx index 1e0a92092b..93d8a191e1 100644 --- a/docs/guides/gettingStarted/cluster.mdx +++ b/docs/guides/gettingStarted/cluster.mdx @@ -16,7 +16,7 @@ sidebar_position: 5 - **Kafka 集群地址**: `kafkaAddr1`, `kafkaAddr2`, `kafkaAddr3` - **Etcd 集群地址**: `etcdAddr1`, `etcdAddr2`, `etcdAddr3` -本文假设以上组件都部署在三台机器上,实际上不限于三台,您可根据需求自行选择多台或者一台。 +本文假设以上组件都部署在三台机器上,实际上不限于三台,**您可根据需求自行选择多台或者一台**。 此外,MinIO 的内部服务访问地址配置为 `your_minio_internal_address`,外部访问地址配置为 `your_minio_external_address`。 A 和 B 两台机器以及组件集群内网互通,且A、B两台机器都有外网IP。 @@ -199,7 +199,6 @@ mage start - ## **常见问题/注意事项** 1. 部署`kafka`时,需要修改`kafka`广播的端口。如果使用`open-im-server`中的`docker-compose.yml`部署,修改`service.kafka.environment.KAFKA_CFG_ADVERTISED_LISTENERS`中的`EXTERNAL`为访问`kafka`组件的地址。其他部署方式请自行修改。 diff --git a/docs/guides/gettingStarted/faq.mdx b/docs/guides/gettingStarted/faq.mdx index 70033f2bae..aeb8767463 100644 --- a/docs/guides/gettingStarted/faq.mdx +++ b/docs/guides/gettingStarted/faq.mdx @@ -36,10 +36,11 @@ sidebar_position: 20 ### 源码部署 1. **进入已有的 `open-im-server` 目录:** + ```bash cd open-im-server ``` - + 2. **停止当前服务:** ```bash mage stop @@ -56,21 +57,67 @@ sidebar_position: 20 mage start ``` + --- +## 二、 如何迁移数据 +在使用`docker compose up -d`命令启动`OpenIM`依赖的各个组件之后,`open-im-server`根目录下会生成一个`components`的文件夹,`open-im-server`运行后产生的数据(如用户、群聊、消息等等)都保存在这个文件夹中。如果需要迁移数据,需要先关闭服务和组件: +`docker`部署: +```sh +docker compose down +``` ---- -## 二、 如何迁移数据 +源码部署: + +```sh +mage stop # 关闭服务 +docker compose down # 关闭组件 +``` + +然后移动整个文件夹到新的位置,再启动服务和组件: + +`docker`部署: + +```sh +docker compose up -d # 启动组 +``` + +源码部署: +```sh +docker compose up -d # 启动组件 +mage start # 启动服务 +``` --- ## 三、 如何清除数据 +如需要清除数据,需要先关闭服务和组件: + +`docker`部署: + +```sh +docker compose down +``` + +源码部署: + +```sh +mage stop # 关闭服务 +docker compose down # 关闭组件 +``` + +然后删除`open-im-server`下的`components`文件夹。 + +客户端方面需要重新卸载重装`app`。 + --- ## 四、 发送文本消息正常,但发送图片失败 +一般发送图片失败是由于没有配置第三方存储的原因。默认使用的第三方存储为`minio`,需要修改`open-im-server`下的`config/minio.yml`文件,将其中`externalAddress`字段中的`external_ip`替换为机器的外网`ip`,然后重新启动服务即可。 + --- ## 五、 减少Mongo、Kafka内存占用 @@ -95,4 +142,5 @@ sidebar_position: 20 ---- \ No newline at end of file +--- +