diff --git a/docker-setup.sh b/docker-setup.sh index 04ea547a..825dc60f 100755 --- a/docker-setup.sh +++ b/docker-setup.sh @@ -1,105 +1,369 @@ #!/bin/sh +# 脚本作者@VanillaNahida # 本文件是用于一键自动下载本项目所需文件,自动创建好目录 -# 所需条件(否则无法使用): -# 1、请确保你的环境可以正常访问 GitHub 否则无法下载脚本 -# -# 检测操作系统类型 -case "$(uname -s)" in - Linux*) OS=Linux;; - Darwin*) OS=Mac;; - CYGWIN*) OS=Windows;; - MINGW*) OS=Windows;; - MSYS*) OS=Windows;; - *) OS=UNKNOWN;; -esac +# 暂且只支持X86版本的Ubuntu系统,其他系统未测试 -# 设置颜色(Windows CMD 不支持,但不影响使用) -if [ "$OS" = "Windows" ]; then - GREEN="" - RED="" - NC="" -else - GREEN='\033[0;32m' - RED='\033[0;31m' - NC='\033[0m' -fi +# 定义中断处理函数 +handle_interrupt() { + echo "" + echo "安装已被用户中断(Ctrl+C或Esc)" + echo "如需重新安装,请再次运行脚本" + exit 1 +} -echo "${GREEN}开始安装小智服务端...${NC}" +# 设置信号捕获,处理Ctrl+C +trap handle_interrupt SIGINT -# 创建必要的目录 -echo "创建目录结构..." -mkdir -p xiaozhi-server/data xiaozhi-server/models/SenseVoiceSmall -cd xiaozhi-server || exit +# 处理Esc键 +# 保存终端设置 +old_stty_settings=$(stty -g) +# 设置终端立即响应,不回显 +stty -icanon -echo min 1 time 0 -# 根据操作系统选择下载命令 -if [ "$OS" = "Windows" ]; then - DOWNLOAD_CMD="curl -L -o" - if ! command -v curl >/dev/null 2>&1; then - DOWNLOAD_CMD="powershell -Command Invoke-WebRequest -Uri" - DOWNLOAD_CMD_SUFFIX="-OutFile" +# 后台进程检测Esc键 +(while true; do + read -r key + if [[ $key == $'\e' ]]; then + # 检测到Esc键,触发中断处理 + kill -SIGINT $$ + break fi -else - if command -v curl >/dev/null 2>&1; then - DOWNLOAD_CMD="curl -L -o" - elif command -v wget >/dev/null 2>&1; then - DOWNLOAD_CMD="wget -O" - else - echo "${RED}错误: 需要安装 curl 或 wget${NC}" - exit 1 +done) & + +# 脚本结束时恢复终端设置 +trap 'stty "$old_stty_settings"' EXIT + + +# 打印彩色字符画 +echo -e "\e[1;32m" # 设置颜色为亮绿色 +cat << "EOF" +脚本作者:@Bilibili 香草味的纳西妲喵 + __ __ _ _ _ _ _ _ _ _ + \ \ / / (_)| || | | \ | | | | (_) | | + \ \ / /__ _ _ __ _ | || | __ _ | \| | __ _ | |__ _ __| | __ _ + \ \/ // _` || '_ \ | || || | / _` | | . ` | / _` || '_ \ | | / _` | / _` | + \ /| (_| || | | || || || || (_| | | |\ || (_| || | | || || (_| || (_| | + \/ \__,_||_| |_||_||_||_| \__,_| |_| \_| \__,_||_| |_||_| \__,_| \__,_| +EOF +echo -e "\e[0m" # 重置颜色 +echo -e "\e[1;36m 小智服务端全量部署一键安装脚本 Ver 0.2 \e[0m\n" +sleep 1 + + + +# 检查并安装whiptail +check_whiptail() { + if ! command -v whiptail &> /dev/null; then + echo "正在安装whiptail..." + apt update + apt install -y whiptail fi -fi +} -# 下载语音识别模型 -echo "下载语音识别模型..." -if [ "$DOWNLOAD_CMD" = "powershell -Command Invoke-WebRequest -Uri" ]; then - $DOWNLOAD_CMD "https://modelscope.cn/models/iic/SenseVoiceSmall/resolve/master/model.pt" $DOWNLOAD_CMD_SUFFIX "models/SenseVoiceSmall/model.pt" -else - $DOWNLOAD_CMD "models/SenseVoiceSmall/model.pt" "https://modelscope.cn/models/iic/SenseVoiceSmall/resolve/master/model.pt" -fi +check_whiptail -if [ $? -ne 0 ]; then - echo "${RED}模型下载失败。请手动从以下地址下载:${NC}" - echo "1. https://modelscope.cn/models/iic/SenseVoiceSmall/resolve/master/model.pt" - echo "2. 百度网盘: https://pan.baidu.com/share/init?surl=QlgM58FHhYv1tFnUT_A8Sg (提取码: qvna)" - echo "下载后请将文件放置在 models/SenseVoiceSmall/model.pt" -fi - -# 下载配置文件 -echo "下载配置文件..." -if [ "$DOWNLOAD_CMD" = "powershell -Command Invoke-WebRequest -Uri" ]; then - $DOWNLOAD_CMD "https://raw.githubusercontent.com/xinnan-tech/xiaozhi-esp32-server/main/main/xiaozhi-server/docker-compose.yml" $DOWNLOAD_CMD_SUFFIX "docker-compose.yml" - $DOWNLOAD_CMD "https://raw.githubusercontent.com/xinnan-tech/xiaozhi-esp32-server/main/main/xiaozhi-server/config.yaml" $DOWNLOAD_CMD_SUFFIX "data/.config.yaml" -else - $DOWNLOAD_CMD "docker-compose.yml" "https://raw.githubusercontent.com/xinnan-tech/xiaozhi-esp32-server/main/main/xiaozhi-server/docker-compose.yml" - $DOWNLOAD_CMD "data/.config.yaml" "https://raw.githubusercontent.com/xinnan-tech/xiaozhi-esp32-server/main/main/xiaozhi-server/config.yaml" -fi - -# 检查文件是否存在 -echo "检查文件完整性..." -FILES_TO_CHECK="docker-compose.yml data/.config.yaml models/SenseVoiceSmall/model.pt" -ALL_FILES_EXIST=true - -for FILE in $FILES_TO_CHECK; do - if [ ! -f "$FILE" ]; then - echo "${RED}错误: $FILE 不存在${NC}" - ALL_FILES_EXIST=false - fi -done - -if [ "$ALL_FILES_EXIST" = false ]; then - echo "${RED}某些文件下载失败,请检查上述错误信息并手动下载缺失的文件。${NC}" +# 检查root权限 +if [ $EUID -ne 0 ]; then + whiptail --title "权限错误" --msgbox "请使用root权限运行本脚本" 10 50 exit 1 fi -echo "${GREEN}文件下载完成!${NC}" -echo "请编辑 data/.config.yaml 文件配置你的API密钥。" -echo "配置完成后,运行以下命令启动服务:" -echo "${GREEN}docker-compose up -d${NC}" -echo "查看日志请运行:" -echo "${GREEN}docker logs -f xiaozhi-esp32-server${NC}" +# 检查系统版本 +if [ -f /etc/os-release ]; then + . /etc/os-release + if [ "$ID" != "debian" ] && [ "$ID" != "ubuntu" ]; then + whiptail --title "系统错误" --msgbox "该脚本只支持Debian/Ubuntu系统执行" 10 60 + exit 1 + fi +else + whiptail --title "系统错误" --msgbox "无法确定系统版本,该脚本只支持Debian/Ubuntu系统执行" 10 60 + exit 1 +fi -# 提示用户编辑配置文件 -echo "\n${RED}重要提示:${NC}" -echo "1. 请确保编辑 data/.config.yaml 文件,配置必要的API密钥" -echo "2. 特别是 ChatGLM 和 mem0ai 的密钥必须配置" -echo "3. 配置完成后再启动 docker 服务" +# 下载配置文件函数 +check_and_download() { + local filepath=$1 + local url=$2 + if [ ! -f "$filepath" ]; then + if ! curl -fL --progress-bar "$url" -o "$filepath"; then + whiptail --title "错误" --msgbox "${filepath}文件下载失败" 10 50 + exit 1 + fi + else + echo "${filepath}文件已存在,跳过下载" + fi +} + +# 检查是否已安装 +check_installed() { + # 检查目录是否存在且非空 + if [ -d "/opt/xiaozhi-server/" ] && [ "$(ls -A /opt/xiaozhi-server/)" ]; then + DIR_CHECK=1 + else + DIR_CHECK=0 + fi + + # 检查容器是否存在 + if docker inspect xiaozhi-esp32-server > /dev/null 2>&1; then + CONTAINER_CHECK=1 + else + CONTAINER_CHECK=0 + fi + + # 两次检查都通过 + if [ $DIR_CHECK -eq 1 ] && [ $CONTAINER_CHECK -eq 1 ]; then + return 0 # 已安装 + else + return 1 # 未安装 + fi +} + +# 更新相关 +if check_installed; then + if whiptail --title "已安装检测" --yesno "检测到小智服务端已安装,是否进行升级?" 10 60; then + # 用户选择升级,执行清理操作 + echo "开始升级操作..." + + # 停止并移除所有docker-compose服务 + docker compose -f /opt/xiaozhi-server/docker-compose_all.yml down + + # 停止并删除特定容器(考虑容器可能不存在的情况) + containers=( + "xiaozhi-esp32-server" + "xiaozhi-esp32-server-web" + "xiaozhi-esp32-server-db" + "xiaozhi-esp32-server-redis" + ) + + for container in "${containers[@]}"; do + if docker ps -a --format '{{.Names}}' | grep -q "^${container}$"; then + docker stop "$container" >/dev/null 2>&1 && \ + docker rm "$container" >/dev/null 2>&1 && \ + echo "成功移除容器: $container" + else + echo "容器不存在,跳过: $container" + fi + done + + # 删除特定镜像(考虑镜像可能不存在的情况) + images=( + "ghcr.nju.edu.cn/xinnan-tech/xiaozhi-esp32-server:server_latest" + "ghcr.nju.edu.cn/xinnan-tech/xiaozhi-esp32-server:web_latest" + ) + + for image in "${images[@]}"; do + if docker images --format '{{.Repository}}:{{.Tag}}' | grep -q "^${image}$"; then + docker rmi "$image" >/dev/null 2>&1 && \ + echo "成功删除镜像: $image" + else + echo "镜像不存在,跳过: $image" + fi + done + + echo "所有清理操作完成" + + # 备份原有配置文件 + mkdir -p /opt/xiaozhi-server/backup/ + if [ -f /opt/xiaozhi-server/data/.config.yaml ]; then + cp /opt/xiaozhi-server/data/.config.yaml /opt/xiaozhi-server/backup/.config.yaml + echo "已备份原有配置文件到 /opt/xiaozhi-server/backup/.config.yaml" + fi + + # 下载最新版配置文件 + check_and_download "/opt/xiaozhi-server/docker-compose_all.yml" "https://ghfast.top/https://raw.githubusercontent.com/xinnan-tech/xiaozhi-esp32-server/refs/heads/main/main/xiaozhi-server/docker-compose_all.yml" + check_and_download "/opt/xiaozhi-server/data/.config.yaml" "https://ghfast.top/https://raw.githubusercontent.com/xinnan-tech/xiaozhi-esp32-server/refs/heads/main/main/xiaozhi-server/config_from_api.yaml" + + # 启动Docker服务 + echo "开始启动最新版本服务..." + # 升级完成后标记,跳过后续下载步骤 + UPGRADE_COMPLETED=1 + docker compose -f /opt/xiaozhi-server/docker-compose_all.yml up -d + else + whiptail --title "跳过升级" --msgbox "已取消升级,将继续使用当前版本。" 10 50 + # 跳过升级,继续执行后续安装流程 + fi +fi + + +# 检查curl安装 +if ! command -v curl &> /dev/null; then + whiptail --title "安装curl" --msgbox "未检测到curl,开始安装..." 10 50 + apt update + apt install -y curl +else + echo "curl已安装,跳过安装步骤" +fi + +# 检查Docker安装 +if ! command -v docker &> /dev/null; then + whiptail --title "安装Docker" --msgbox "未检测到Docker,开始安装..." 10 50 + apt update + apt install -y apt-transport-https ca-certificates curl software-properties-common + curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add - + add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" + apt update + apt install -y docker-ce + systemctl start docker + systemctl enable docker +else + echo "Docker已安装,跳过安装步骤" +fi + +# Docker镜像源配置 +MIRROR_OPTIONS=( + "1" "轩辕镜像 (推荐)" + "2" "腾讯云镜像源" + "3" "中科大镜像源" + "4" "网易163镜像源" + "5" "华为云镜像源" + "6" "阿里云镜像源" + "7" "自定义镜像源" + "8" "跳过配置" +) + +MIRROR_CHOICE=$(whiptail --title "选择Docker镜像源" --menu "请选择要使用的Docker镜像源" 20 60 10 \ +"${MIRROR_OPTIONS[@]}" 3>&1 1>&2 2>&3) || { + echo "用户取消选择,退出脚本" + exit 1 +} + +case $MIRROR_CHOICE in + 1) MIRROR_URL="https://docker.xuanyuan.me" ;; + 2) MIRROR_URL="https://mirror.ccs.tencentyun.com" ;; + 3) MIRROR_URL="https://docker.mirrors.ustc.edu.cn" ;; + 4) MIRROR_URL="https://hub-mirror.c.163.com" ;; + 5) MIRROR_URL="https://05f073ad3c0010ea0f4bc00b7105ec20.mirror.swr.myhuaweicloud.com" ;; + 6) MIRROR_URL="https://registry.aliyuncs.com" ;; + 7) MIRROR_URL=$(whiptail --title "自定义镜像源" --inputbox "请输入完整的镜像源URL:" 10 60 3>&1 1>&2 2>&3) ;; + 8) MIRROR_URL="" ;; +esac + +if [ -n "$MIRROR_URL" ]; then + mkdir -p /etc/docker + if [ -f /etc/docker/daemon.json ]; then + cp /etc/docker/daemon.json /etc/docker/daemon.json.bak + fi + cat > /etc/docker/daemon.json <&1 | grep -q "Started AdminApplication in"; then + break + fi + sleep 1 +done + + echo "服务端启动成功!正在完成配置..." + echo "正在启动服务..." + docker compose -f docker-compose_all.yml up -d + echo "服务启动完成!" +) + +# 密钥配置 + +# 获取服务器公网地址 +PUBLIC_IP=$(hostname -I | awk '{print $1}') +whiptail --title "设置服务器密钥" --msgbox "请使用浏览器,访问下方链接,打开智控台并注册账号: \n\n内网地址:http://127.0.0.1:8002/\n公网地址:http://$PUBLIC_IP:8002/ (若是云服务器请在服务器安全组放行端口 8000 8001 8002)。\n\n注册的第一个用户即是超级管理员,以后注册的用户都是普通用户。普通用户只能绑定设备和配置智能体; 超级管理员可以进行模型管理、用户管理、参数配置等功能。\n\n注册好后请按Enter键继续" 18 70 + +SECRET_KEY=$(whiptail --title "服务器密钥配置" --inputbox "请使用超级管理员账号登录智控台 (http://127.0.0.1:8002)\n在顶部菜单 参数字典 → 参数管理 找到参数编码: server.secret (服务器密钥) \n复制该参数值并输入到下面输入框\n\n请输入密钥(留空则跳过配置):" 15 60 3>&1 1>&2 2>&3) + +if [ -n "$SECRET_KEY" ]; then + python3 -c " +import sys, yaml; +config_path = '/opt/xiaozhi-server/data/.config.yaml'; +with open(config_path, 'r') as f: + config = yaml.safe_load(f) or {}; +config['manager-api'] = {'url': 'http://xiaozhi-esp32-server-web:8002/xiaozhi', 'secret': '$SECRET_KEY'}; +with open(config_path, 'w') as f: + yaml.dump(config, f); +" + docker restart xiaozhi-esp32-server +fi + +# 获取并显示地址信息 +LOCAL_IP=$(hostname -I | awk '{print $1}') +WEBSOCKET_ADDR=$(docker logs xiaozhi-esp32-server 2>&1 | tac | grep -m 1 -E -o "ws://[^ ]+") +VISION_ADDR=$(docker logs xiaozhi-esp32-server 2>&1 | tac | grep -m 1 "视觉" | grep -m 1 -E -o "http://[^ ]+") + +whiptail --title "安装完成!" --msgbox "\ +服务端相关地址如下:\n\ +管理后台访问地址: http://$LOCAL_IP:8002\n\ +OTA 地址: http://$LOCAL_IP:8002/xiaozhi/ota/\n\ +视觉分析接口地址: $VISION_ADDR\n\ +WebSocket 地址: $WEBSOCKET_ADDR\n\ +\n安装完毕!感谢您的使用!\n按Enter键退出..." 16 70 \ No newline at end of file diff --git a/docs/Deployment.md b/docs/Deployment.md index 99aa8682..13f54aa6 100644 --- a/docs/Deployment.md +++ b/docs/Deployment.md @@ -12,33 +12,27 @@ docker镜像已支持x86架构、arm64架构的CPU,支持在国产操作系统 ### 1.1 懒人脚本 -你可以使用以下命令一键下载并执行部署脚本: -请确保你的环境可以正常访问 GitHub 否则无法下载脚本。 -```bash -curl -L -o docker-setup.sh https://raw.githubusercontent.com/xinnan-tech/xiaozhi-esp32-server/main/docker-setup.sh -``` +脚本作者[@VanillaNahida](https://github.com/VanillaNahida) -如果您的电脑是windows系统,请使用使用 Git Bash、WSL、PowerShell 或 CMD 运行以下命令: -```bash -# Git Bash 或 WSL -sh docker-setup.sh -# PowerShell 或 CMD -.\docker-setup.sh -``` +你可以使用以下命令一键安装全模块版小智服务端: +~~请确保你的环境可以正常访问 GitHub 否则会出现一些奇奇怪怪的问题。(脚本已内置镜像源无须担心网络问题,但不排除会有拉取失败的可能)~~ +> [!NOTE] +> 暂且只支持Ubuntu服务器一键部署,其他系统未尝试,可能会有一些奇怪的bug -如果您的电脑是linux 或者 macos 系统,请使用终端运行以下命令: +使用SSH工具连接到服务器,以root权限执行如下脚本 ```bash -chmod +x docker-setup.sh -./docker-setup.sh +sudo bash -c "$(wget -qO- https://ghfast.top/https://raw.githubusercontent.com/xinnan-tech/xiaozhi-esp32-server/main/docker-setup.sh)" ``` 脚本会自动完成以下操作: -> 1. 创建必要的目录结构 -> 2. 下载语音识别模型 -> 3. 下载配置文件 -> 4. 检查文件完整性 +> 1. 安装Docker +> 2. 配置镜像源 +> 3. 下载/拉取镜像 +> 4. 下载语音识别模型文件 +> 5. 引导配置服务端 > -> 执行完成后,请按照提示配置 API 密钥。 + +执行完成后简单配置即可直接食用满血版服务端 当你一切顺利完成以上操作后,继续操作[配置项目文件](#2-配置项目文件)