更新全模块部署文档 (#753)

* update:更新文档 * update:优化文档路径
2026-07-26 09:03:54 +08:00 · 2025-04-13 00:21:13 +08:00
parent db5159bd5e
commit db4f028955
13 changed files with 572 additions and 485 deletions
@@ -1,8 +1,6 @@
-本文档是开发类文档，如需部署小智服务端，[点击这里查看部署教程](./FAQ.md#%E4%BD%BF%E7%94%A8%E6%96%B9%E5%BC%8F-)
+本文档是开发类文档，如需部署小智服务端，[点击这里查看部署教程](../README.md#%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A3)

 # 项目目录介绍
-当你看到这份文件的时候，这个这个项目还没完善好。我们还有很多东西要做。
-
 如果你是一名软件开发者，这里有一份[《致开发者的公开信》](../docs/contributor_open_letter.md)，欢迎归队！

 ```
@@ -12,9 +10,9 @@ xiaozhi-esp32-server
  ├─ manager-api 8002 端口 Java语言开发 负责提供控制台的api
 ```

-# xiaozhi-server 接口协议
+# xiaozhi-server 和ESP32通讯协议

-[虾哥团队通信协议：Websocket 连接](https://ccnphfhqs21z.feishu.cn/wiki/M0XiwldO9iJwHikpXD5cEx71nKh)
+https://ccnphfhqs21z.feishu.cn/wiki/M0XiwldO9iJwHikpXD5cEx71nKh

 # manager-web 、manager-api接口协议

@@ -1,4 +1,5 @@
-本文档是开发类文档，如需部署小智服务端，[点击这里查看部署教程](../../../docs/Deployment.md)
+本文档是开发类文档，如需部署小智服务端，[点击这里查看部署教程](../../README.md#%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A3)
+
 # 项目介绍

 manager-api 该项目基于SpringBoot框架开发。
@@ -12,80 +13,6 @@ MySQL 8.0+
 Redis 5.0+
 Vue 3.x

-# 创建数据库
-
-如果本机已经安装了MySQL，可以直接在数据库中创建名为`xiaozhi_esp32_server`的数据库。
-
-```sql
-CREATE DATABASE xiaozhi_esp32_server CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
-```
-
-如果还没有MySQL，你可以通过docker安装mysql
-
-```
-docker run --name xiaozhi-esp32-server-db -e MYSQL_ROOT_PASSWORD=123456 -p 3306:3306 -e MYSQL_DATABASE=xiaozhi_esp32_server -e MYSQL_INITDB_ARGS="--character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci" -d mysql:latest
-```
-
-# 确认项目数据库连接信息
-
-在`src/main/resources/application-dev.yml`中配置数据库连接信息
-
-```
-spring:
-  datasource:
-    username: root
-    password: 123456
-```
-
-
-# 连接Redis
-
-如果还没有Redis，你可以通过docker安装redis
-
-```
-docker run --name xiaozhi-esp32-server-redis -d -p 6379:6379 redis
-```
-
-# 确认项目Redis连接信息
-
-在`src/main/resources/application-dev.yml`中配置Redis连接信息
-
-```
-spring:
-    data:
-      redis:
-        host: localhost
-        port: 6379
-        password:
-        database: 0
-```
-
-
-# 测试启动
-
-本项目为SpringBoot项目，启动方式为：
-打开`Application.java`运行`Main`方法启动
-
-```
-路径地址：
-src/main/java/xiaozhi/AdminApplication.java
-```
-
-# 打包编译
-
-执行以下命令生产jar包
-
-```
-mvn clean install
-```
-
-把jar包放在服务器上，执行
-
-```
-nohup java -jar xiaozhi-esp32-api.jar --spring.profiles.activate=dev
-```
-
-
 # 接口文档
 启动后打开：http://localhost:8002/xiaozhi/doc.html

@@ -1,4 +1,4 @@
-本文档是开发类文档，如需部署小智服务端，[点击这里查看部署教程](../../../docs/Deployment.md)
+本文档是开发类文档，如需部署小智服务端，[点击这里查看部署教程](../../README.md#%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A3)

 # xiaozhi

@@ -1,16 +1,4 @@
-# 1、安装mysql
-# |- 如果本机已经安装了MySQL，可以直接在数据库中创建名为`xiaozhi_esp32_server`的数据库。
-# |- 如果还没有MySQL，你可以通过docker安装mysql,执行以下一句话
-# |- docker run --name xiaozhi-esp32-server-db -e MYSQL_ROOT_PASSWORD=123456 -p 3306:3306 -e MYSQL_DATABASE=xiaozhi_esp32_server -e MYSQL_INITDB_ARGS="--character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci" -d mysql:latest
-# |- 如果你的mysql账号和密码有修改过，记得修改下方数据库的账号和密码
-# |- 记得修改下方SPRING_DATASOURCE_DRUID_URL的IP，ip不能写127.0.0.1或localhost，否则容器无法访问，要写你电脑局域网ip
-
-# 2、安装redis
-# |- 如果本机已经安装了Redis，看一下你安装的redis端口、密码，然后修改下方redis的地址和端口
-# |- 如果还没有Redis，你可以通过docker安装redis,执行以下一句话
-# |- docker run --name xiaozhi-esp32-server-redis -d -p 6379:6379 redis
-# |- 记得修改SPRING_DATA_REDIS_HOST的IP，ip不能写127.0.0.1或localhost，否则容器无法访问，要写你电脑局域网ip
-
+# Docker安装Server

 version: '3'
 services:
@@ -29,20 +17,4 @@ services:
      # 配置文件目录
      - ./data:/opt/xiaozhi-esp32-server/data
      # 模型文件挂接，很重要
-      - ./models/SenseVoiceSmall/model.pt:/opt/xiaozhi-esp32-server/models/SenseVoiceSmall/model.pt
-
-#  #智控台还没开发好，还不能完全使用，会报很多错误，如果是非技术人员，请不要启用智控台服务
-#  xiaozhi-esp32-server-web:
-#    image: ghcr.nju.edu.cn/xinnan-tech/xiaozhi-esp32-server:web_latest
-#    container_name: xiaozhi-esp32-server-web
-#    restart: always
-#    ports:
-#      - "8002:8002"
-#    environment:
-#      - TZ=Asia/Shanghai
-#      ##记得改mysql和redis IP 密码
-#      - SPRING_DATASOURCE_DRUID_URL=jdbc:mysql://192.168.1.20:3306/xiaozhi_esp32_server?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
-#      - SPRING_DATASOURCE_DRUID_USERNAME=root
-#      - SPRING_DATASOURCE_DRUID_PASSWORD=123456
-#      - SPRING_DATA_REDIS_HOST=192.168.1.20
-#      - SPRING_DATA_REDIS_PORT=6379
+      - ./models/SenseVoiceSmall/model.pt:/opt/xiaozhi-esp32-server/models/SenseVoiceSmall/model.pt
@@ -0,0 +1,51 @@
+# Docker安装全模块
+
+# 1、安装mysql
+# |- 如果本机已经安装了MySQL，可以直接在数据库中创建名为`xiaozhi_esp32_server`的数据库。
+# |- 如果还没有MySQL，你可以通过docker安装mysql,执行以下一句话
+# |- docker run --name xiaozhi-esp32-server-db -e MYSQL_ROOT_PASSWORD=123456 -p 3306:3306 -e MYSQL_DATABASE=xiaozhi_esp32_server -e MYSQL_INITDB_ARGS="--character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci" -d mysql:latest
+# |- 记得修改下方SPRING_DATASOURCE_DRUID_URL的IP，ip不能写127.0.0.1或localhost，否则容器无法访问，要写你电脑局域网ip
+
+# 2、安装redis
+# |- 如果本机已经安装了Redis，看一下你安装的redis端口、密码，然后修改下方redis的地址和端口
+# |- 如果还没有Redis，你可以通过docker安装redis,执行以下一句话
+# |- docker run --name xiaozhi-esp32-server-redis -d -p 6379:6379 redis
+# |- 记得修改SPRING_DATA_REDIS_HOST的IP，ip不能写127.0.0.1或localhost，否则容器无法访问，要写你电脑局域网ip
+
+
+version: '3'
+services:
+  # Server模块
+  xiaozhi-esp32-server:
+    image: ghcr.nju.edu.cn/xinnan-tech/xiaozhi-esp32-server:server_latest
+    container_name: xiaozhi-esp32-server
+    restart: always
+    ports:
+      # ws服务端
+      - "8000:8000"
+    security_opt:
+      - seccomp:unconfined
+    environment:
+      - TZ=Asia/Shanghai
+    volumes:
+      # 配置文件目录
+      - ./data:/opt/xiaozhi-esp32-server/data
+      # 模型文件挂接，很重要
+      - ./models/SenseVoiceSmall/model.pt:/opt/xiaozhi-esp32-server/models/SenseVoiceSmall/model.pt
+
+  # manager-api和manager-web模块
+  xiaozhi-esp32-server-web:
+    image: ghcr.nju.edu.cn/xinnan-tech/xiaozhi-esp32-server:web_latest
+    container_name: xiaozhi-esp32-server-web
+    restart: always
+    ports:
+      # 智控台
+      - "8002:8002"
+    environment:
+      - TZ=Asia/Shanghai
+      ##记得改mysql和redis IP 密码
+      - SPRING_DATASOURCE_DRUID_URL=jdbc:mysql://192.168.1.25:3306/xiaozhi_esp32_server?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
+      - SPRING_DATASOURCE_DRUID_USERNAME=root
+      - SPRING_DATASOURCE_DRUID_PASSWORD=123456
+      - SPRING_DATA_REDIS_HOST=192.168.1.25
+      - SPRING_DATA_REDIS_PORT=6379