From 768b9fb7c1dd477b6602f09eec0f76d81a9bb5f5 Mon Sep 17 00:00:00 2001 From: hrz <1710360675@qq.com> Date: Sun, 13 Apr 2025 00:32:32 +0800 Subject: [PATCH] Update readme (#754) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * update:更新文档 * update:优化文档路径 * update:优化文档 --- README.md | 11 +++++------ docs/Deployment_all.md | 22 +++++++++++++++++----- 2 files changed, 22 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f5ac9f79..6feb1fc7 100644 --- a/README.md +++ b/README.md @@ -151,16 +151,15 @@ server: ### 部署文档 -本项目支持`最简化`安装和`全模块`。 +本项目支持`最简化`安装和`全模块`安装。请根据具体需求选择安装方式。 -`最简化`适合在较低资源配置中运行，无需数据库。[请参考-最简化架构图](./docs/images/deploy1.png) - -`全模块`适合想体验完整功能，请根据具体需求选择安装方式。[请参考-全模块安装架构图](./docs/images/deploy2.png) +`最简化`适合在较低资源配置中运行，无需数据库。[请参考-最简化安装架构图](./docs/images/deploy1.png) +`全模块`适合想体验完整功能，过程复杂。[请参考-全模块安装架构图](./docs/images/deploy2.png) #### 1、 最简化安装 -`最简化`安装包含：智能对话、IOT等功能，数据存储在`配置文件`。 +`最简化`安装包含：智能对话、IOT等功能，数据存储在`配置文件`。我们提供了两种安装教程，如果你决定使用最简化安装，可选择`Docker只运行Server`或`本地源码只运行Server`任意一种方式。 ##### 1.1. Docker只运行Server @@ -172,7 +171,7 @@ server: #### 2、 全模块安装 -`全模块`安装包含：智能对话、IOT、OTA、智控台，数据存储在`数据库`中。 +`全模块`安装包含：智能对话、IOT、OTA、智控台，数据存储在`数据库`中。我们提供了两种安装教程，如果你决定使用全模块安装，可选择`Docker运行全模块`或`本地源码运行全模块`任意一种方式。 ##### 2.1. Docker运行全模块 diff --git a/docs/Deployment_all.md b/docs/Deployment_all.md index 8c3d1c15..e4ac4ff9 100644 --- a/docs/Deployment_all.md +++ b/docs/Deployment_all.md @@ -189,9 +189,15 @@ docker logs -f xiaozhi-esp32-server 由于你是全模块部署，因此你有两个重要的接口需要写入到esp32中。 -OTA接口：http://你电脑局域网的ip:8002/xiaozhi/ota/ +OTA接口： +``` +http://你电脑局域网的ip:8002/xiaozhi/ota/ +``` -Websocket接口：ws://你电脑局域网的ip:8000/xiaozhi/v1/ +Websocket接口： +``` +ws://你电脑局域网的ip:8000/xiaozhi/v1/ +``` 接下来，你就可以开始 [编译esp32固件](firmware-build.md)了。 @@ -378,7 +384,7 @@ pip install -r requirements.txt ## 8.配置项目文件 -使用超级管理员账号，登录智控台http://127.0.0.1:8001，在顶部菜单找到`参数管理`，找到列表中第三条数据，参数编码是`server.secret`，复制它到`参数值`。 +使用超级管理员账号，登录智控台 http://127.0.0.1:8001 ，在顶部菜单找到`参数管理`，找到列表中第三条数据，参数编码是`server.secret`，复制它到`参数值`。 `server.secret`需要说明一下，这个`参数值`很重要，作用是让我们的`Server`端连接`manager-api`。`server.secret`是每次从零部署manager模块时，会自动随机生成的密钥。 @@ -418,9 +424,15 @@ python app.py 由于你是全模块部署，因此你有两个重要的接口需要写入到esp32中。 -OTA接口：http://你电脑局域网的ip:8002/xiaozhi/ota/ +OTA接口： +``` +http://你电脑局域网的ip:8002/xiaozhi/ota/ +``` -Websocket接口：ws://你电脑局域网的ip:8000/xiaozhi/v1/ +Websocket接口： +``` +ws://你电脑局域网的ip:8000/xiaozhi/v1/ +``` 接下来，你就可以开始 [编译esp32固件](firmware-build.md)了。