feat: doc

icey-yu · icey-yu · commit 95ae488de6f7 · 2024-12-18T15:24:25.000+08:00
diff --git a/docs/guides/gettingStarted/admin.mdx b/docs/guides/gettingStarted/admin.mdx
@@ -179,7 +179,11 @@ docker compose --profile m up -d
 
 在浏览器中输入 `http://ip:11002` 来访问管理后台。此 IP 为服务端 OPENIM_IP，确保您的浏览器能访问。默认账号和密码均为 chatAdmin
 
-![PC Web Interface](admin.assets/admin.jpg)
+import Image4 from './assets/admin.jpg';
+
+<img src={Image4} width="700" alt="admin " />
+
+
 
 ## 登录grafana
 
diff --git a/docs/guides/gettingStarted/dockerCompose.mdx b/docs/guides/gettingStarted/dockerCompose.mdx
@@ -22,6 +22,8 @@ git clone https://github.com/openimsdk/openim-docker
   MINIO_EXTERNAL_ADDRESS="http://external_ip:10005"
   ```
 
+  >注意：docker部署不采用配置挂载的模式，在config目录下面修改配置文件无效！请采用环境变量的方式修改配置。
+  >
   >配置格式说明：docker方式部署如果需要修改配置，则需要通过修改docker-compose.yaml中的环境变量来实现。例如修改`openim-server`的配置文件`openim-api.yml`中的`prometheus.grafanaURL`字段，则应在`docker-compose.yaml`文件中的`openim-server`的`environment`下添加：`- IMENV_OPENIM_API_PROMETHEUS_GRAFANAURL=${GRAFANA_URL}`。`IMENV`为`openim-server`配置的固定前缀，文件名和字段之间的分隔符全部为`_`，并且全部改为大写。
 
 - 其他配置请参考 .env 中的注释
@@ -59,127 +61,9 @@ docker logs -f openim-chat
 
 ---
 
+## ❓ 常见问题
 
-## 以下是release-v3.6及之前的版本部署流程
-
-
----
-# 🛠 docker部署
-
-
-## 1. 环境及组件要求
-对于服务器环境、系统、以及存储组件可以参考[此文档](./env-comp)
-
----
-## 2. docker部署
-
-## 2.1 克隆仓库并初始化
-
-```jsx
-git clone https://github.com/openimsdk/openim-docker openim-docker && cd openim-docker && make init
-
-```
-💡 **Tips**
-> 如果不是本机clone，而是通过下载压缩包获取的 **openim-docker**，执行命令 **find ./ -name "*.sh" | xargs chmod +x**，以赋予脚本执行权限
-
----
-
-
-
-
-
-## 2.2 设置OPENIM_IP
-
-🔔 **必须要设置OPENIM_IP，且不能是127.0.0.1**
-
-```jsx
-# 如果服务器有外网IP
-export OPENIM_IP="外网IP"
-
-# 如果仅提供内网服务
-export OPENIM_IP="内网IP"
-```
-
-
-
-## 2.3 启动服务及查看日志
-
-```jsx
-docker compose up -d
-docker ps
-docker compose logs -f openim-chat
-docker compose logs -f openim-server
-```
-
----
-
-## 3. 快速验证
-
-请参考[快速验证](./quickTestServer)文档
-
----
-
-## 4. 管理后台和监控系统
-请参考 [管理后台和监控系统](./admin) 文档。
-
----
-
-## 5. 关于配置项的修改
-
-此项目配置项较为复杂，主要是某些配置项涉及到**`.env`**、**`openim-chat/config/config.yaml`** 和 **`openim-server/config/config.yaml`**多个文件，配置项的修改说明分为两个部分，分别是共用配置项的修改和其他配置项的修改。
-
-### 5.1 共用配置项
-
-**`.env`**、**`openim-chat/config/config.yaml`** 和 **`openim-server/config/config.yaml`** 共用的配置项：
-
-1. mysql/mongo/redis/kafka/zookeeper/minio 端口及密码；
-2. SECRET；
-3.  API_OPENIM_PORT；
-4.  OPENIM_IP；
-5. MINIO_PORT;
-6. GRAFANA_PORT
-
-### 5.2 修改方法
-
-对于5.1共用配置项的修改，以下两种方式二选一。
-
-方式一：所有配置重新生成
-
-如果需要全面更新配置，可以采用以下步骤：
-
-1. 删除现有配置文件：删除 **`openim-server/config/config.yaml`** 和 **`openim-chat/config/config.yaml`** 文件。
-2. 修改 `.env` 文件：更新 **`.env`** 文件中的相关配置项。
-3. 重新生成配置并重启服务：执行 **`docker compose down ; docker compose up -d`**，这将基于 **`.env`** 文件中的新设置重新生成配置文件，并重启服务。
-
-方式二：分别修改多个配置文件
-
-如果只需部分更新配置，可以按照以下步骤操作：
-
-1. 修改 `.env` 文件：更新 **`.env`** 文件中的相关配置项。
-2. 手动更新配置文件：根据 **`.env`** 文件的修改，相应地更新 **`openim-server/config/config.yaml`** 和 **`openim-chat/config/config.yaml`** 文件中的配置项。
-3. 特殊变量的额外处理：如果修改了 **`OPENIM_IP`**、**`API_OPENIM_PORT`**、**`MINIO_PORT`**、**`GRAFANA_PORT`**，则需要在 **`openim-server/config/config.yaml`** 中更新以下配置项：
-   
-    ```yaml
-    object:
-      apiURL: "http://$OPENIM_IP:$API_OPENIM_PORT"
-      minio:
-        endpoint: "http://$DOCKER_BRIDGE_GATEWAY:$MINIO_PORT"
-        signEndpoint: "http://$OPENIM_IP:$MINIO_PORT"
-    
-    grafanaUrl: http://$OPENIM_IP:$GRAFANA_PORT
-    ```
-    
-4. 重启服务：执行 **`docker compose down ; docker compose up -d`** 以应用更改并重启服务。
-
-### 5.3 其他配置项的修改
-
-对于 **`.env`**、**`openim-chat/config/config.yaml`** 和 **`openim-server/config/config.yaml`** 中的非共用变量，可以单独修改相应文件中的这些配置项。执行 **`docker compose down ; docker compose up -d`** 以应用更改并重启服务。
-
----
-
-## ❓ 6. 常见问题 
-
-### 6.1 能正常发送文本消息，但发送图片失败 😕
+### 1.能正常发送文本消息，但发送图片失败 😕
 
 可能是因为没有在执行 `docker compose up -d` 命令之前设置 `OPENIM_IP` 环境变量。可以通过查看启动时日志，或使用以下命令搜索日志中的 "127.0.0.1" 地址来确认：
 
@@ -213,6 +97,5 @@ grep "127.0.0.1" openim-server/_output/logs/openim-docker.log
 
 日志位置：
 
-- 运行时日志：`{openim-server, openim-chat}/_output/logs/openim-all.*`
-- 启动时日志：`{openim-server, openim-chat}/_output/logs/openim-docker.log`
+- `{openim-server, openim-chat}/_output/logs/openim-service-log.*`
 
diff --git a/docs/guides/gettingStarted/imSourceCodeDeployment.mdx b/docs/guides/gettingStarted/imSourceCodeDeployment.mdx
@@ -138,17 +138,45 @@ mage check
 
 日志位置：
 
-- 运行时日志，启动成功后定位问题时查看：`_output/logs/openim-all*`
-- 启动时日志，启动有错误时查看：`_output/logs/openim-*.log`
+- IM：`_output/logs/openim-service-log.*`
+- Chat：`_output/logs/openim-chat-log.*`
 
 ### 7.2 🚀 启动顺序
 
 启动顺序如下：
 
-- IM 依赖的组件：mongo/redis/kafka/zookeeper/minio 等
+- IM 依赖的组件：mongo/redis/kafka/minio 等
 - **IM**
 - **Chat**
 
 ### 7.3 🐳 Docker 版本
 
 新版 Docker 已经整合了 docker-compose. 老版本的 Docker 可能不支持 gateway 功能 ❌。我们建议您升级到较新的版本，例如 `23.0.1`🔝
+
+## ❓ 8.常见问题
+
+### 1.能正常发送文本消息，但发送图片失败 😕
+
+可能是因为没有在执行 `docker compose up -d` 命令之前设置 `OPENIM_IP` 环境变量。可以通过查看启动时日志，或使用以下命令搜索日志中的 "127.0.0.1" 地址来确认：
+
+```bash
+grep "127.0.0.1" openim-server/_output/logs/openim-docker.log
+```
+
+#### 解决方案：
+
+1. 设置 `OPENIM_IP` 环境变量为你的公网IP地址，如仅提供内网服务则为内网IP地址：
+
+   ```bash
+   export OPENIM_IP="<Public-IP>"
+   ```
+
+2. 使用 `sed` 命令更新 `config.yaml` 文件中的 `apiURL` 和 `signEndpoint` 配置项，将地址改为使用 `OPENIM_IP` 环境变量指定的IP地址：
+
+   ```bash
+   sed -i -e "s/apiURL: \"http:\/\/127\.0\.0\.1/apiURL: \"http:\/\/${OPENIM_IP}/" \
+          -e "s/signEndpoint: \"http:\/\/127\.0\.0\.1/signEndpoint: \"http:\/\/${OPENIM_IP}/" \
+          openim-server/config/config.yaml
+   ```
+
+通过上述步骤修改配置并重启服务后，应能正常发送图片消息。
diff --git a/docs/guides/gettingStarted/quickTestServer.mdx b/docs/guides/gettingStarted/quickTestServer.mdx
@@ -43,7 +43,7 @@ sidebar_position: 5
 ### PC Web 验证
 
 :::tip
-在浏览器中输入 `http://ip:11001` 来访问 PC Web。此 IP 为服务端 OPENIM_IP，确保浏览器能访问。首次使用请通过手机号注册，验证码默认为 `666666`。
+在浏览器中输入 `http://your_server_ip:11001` 来访问 PC Web。`your_server_ip` 为服务端部署机器`ip`地址，确保浏览器能访问。注册时验证码默认为 `666666`。
 :::
 
 
@@ -55,28 +55,9 @@ import Image3 from './assets/pc-web.png';
 
 
 
-### App 验证
-
-扫描以下二维码或点击 [这里](https://www.pgyer.com/IM-FCER) 进行下载。
-
-<img src="https://www.openim.io/_next/image?url=https%3A%2F%2Fwww.pgyer.com%2Fapp%2Fqrcode%2FIM-FCER&w=256&q=75" width="300" alt="Download App" />
-
-:::tip 
-双击 OpenIM 后修改 IP 为服务端 OPENIM_IP 再重启 App
-请确保开放相关端口，并在修改后重启 App。首次使用请先通过手机号注册，验证码默认为 `666666`。
-:::
-
-import Image1 from './assets/1688095532548.jpg';
-
-<img src={Image1} width="400" alt="Server Address Modification - Step 1" />
-
-import Image2 from './assets/1688095537589.jpg';
-
-<img src={Image2} width="400" alt="Server Address Modification - Step 2" />
-
 ### 管理后台验证
 
-在浏览器中输入 `http://ip:11002` 来访问管理后台。此 IP 为服务端 OPENIM_IP，确保您的浏览器能访问。默认账号和密码均为 chatAdmin
+在浏览器中输入 `http://your_server_ip:11002` 来访问管理后台。`your_server_ip` 为服务端部署机器`ip`地址，确保您的浏览器能访问。默认账号和密码均为 chatAdmin
 
 
 import Image4 from './assets/admin.jpg';
