Skip to content

Latest commit

 

History

History
153 lines (94 loc) · 5.36 KB

README.zh-CN.md

File metadata and controls

153 lines (94 loc) · 5.36 KB

Nuwax

Nuwax AI - Easily build and deploy your private Agentic AI solutions.

官方网站：https://nuwax.com

在线演示：https://agent.nuwax.com

中文文档|English Doc | Contributing | Documentation

安装部署

借助于官方提供的 nuwax-cli 命令工具，来快速本地部署服务。

快速开始

环境准备

系统要求
  • 系统要求： Ubuntu22.04LTS 或以上版本（其他 linux 版本未充分测试），macOS 10.15+，Windows 10/11（后续支持）
  • 配置要求： 4 核 8G 或以上
  • 环境要求： docker、docker-compose V2 环境 docker 安装指南
支持的平台
  • Linux: x86_64, ARM64
    • Ubuntu 22.04 LTS（推荐）
    • 当前用户需要有 Docker 权限，验证方式docker ps，查看是否有权限问题， 碰到权限问题，可以使用 sudo 权限运行。
    • 推荐使用阿里云镜像加速
  • macOS: Intel, Apple Silicon (M1/M2), Universal
    • macOS 10.15 (Catalina) 及以上版本
    • 推荐使用 OrbStack（个人免费，性能更佳）
    • 确保 OrbStack 或 Docker Desktop 已启动
    • 首次运行可能需要允许未知开发者：系统偏好设置 → 安全性与隐私

本地部署服务指南

有 2 个部署服务:

  • 主体工程服务(必选)
  • 智能体电脑(沙箱)部署指南(可选)。

在主体本地服务中，配置一个或多个智能体电脑部署的部署地址等，就可以使用智能体电脑(沙箱)。因 "智能体电脑(沙箱)"有个人电脑(沙箱)可用，所需资源更多，因此支持分开部署多个服务器上。

部署主体服务

安装文档

智能体电脑(沙箱)部署指南

可以在多个不同的服务器部署智能体电脑服务，通过配置实现分布式智能体沙箱能力。

环境要求：每台服务器需要安装 Docker 和 Docker Compose 环境，参考 Docker 安装文档。

安装文档

常用管理命令

服务管理

  • 启动服务：./nuwax-cli docker-service start
  • 停止服务：./nuwax-cli docker-service stop
  • 重启服务：./nuwax-cli docker-service restart
  • 检查状态：./nuwax-cli docker-service status

备份管理

备份服务需要停止 Docker 应用服务器，建议业务低谷时操作

  • 一键备份（推荐）：
    • 手动执行备份：./nuwax-cli auto-backup run
    • 列出所有备份：./nuwax-cli list-backups
    • 从备份恢复：./nuwax-cli rollback [BACKUP_ID]

升级管理

应用服务升级，使用命令./nuwax-cli auto-upgrade-deploy run 会自动检测下载新版本，自动部署。

完整升级流程：

# 检查运维客户端是否有新版本并更新
./nuwax-cli check-update install
# 更新应用服务
./nuwax-cli auto-upgrade-deploy run

Docker 环境安装

重要说明： Docker 和 Docker Compose 是运行本服务的核心依赖，必须正确安装。

如果你的系统中还没有安装 Docker 环境，请参考详细的 Docker 环境安装指南。

该安装指南包含以下平台的详细安装步骤：

  • Ubuntu 24.04.3 LTS（推荐 Linux 发行版）
  • macOS（支持 OrbStack 和 Docker Desktop）
  • 镜像加速配置（中国大陆用户专用）

推荐方案：一键安装配置 Docker 脚本

社区一键安装配置 Docker 脚本

该脚本支持 13 种 Linux 发行版，包括国产操作系统（openEuler、Anolis OS、OpenCloudOS、Alinux、Kylin Linux），一键安装 docker、docker-compose 并自动配置轩辕镜像加速源。

bash <(wget -qO- https://xuanyuan.cloud/docker.sh)

脚本特性与优势

✅ 支持 13 种主流发行版：openEuler (欧拉)、OpenCloudOS、Anolis OS (龙蜥)、Alinux (阿里云)、Kylin Linux (银河麒麟)、Fedora、Rocky Linux、AlmaLinux、Ubuntu、Debian、CentOS、RHEL、Oracle Linux

✅ 国产操作系统完整支持：深度适配国产操作系统（openEuler、Anolis OS、OpenCloudOS、Alinux、Kylin Linux），支持版本自动识别和最优配置

✅ 多镜像源智能切换：内置阿里云、腾讯云、华为云、中科大、清华等 6+ 国内镜像源，自动检测并选择最快源

✅ 老版本系统特殊处理：支持 Ubuntu 16.04、Debian 9/10 等已过期系统，自动配置兼容的安装方案

✅ 双重安装保障：包管理器安装失败时自动切换到二进制安装，确保安装成功率

✅ macOS/Windows 友好提示：自动检测 macOS 和 Windows 系统，提供适合的 Docker Desktop 安装指引

快速验证 Docker 安装：

# 检查 Docker 版本
docker --version

# 检查 Docker Compose 版本
docker compose version

# 运行测试容器
docker run hello-world

如果上述命令都能正常运行，说明你的 Docker 环境已准备就绪，可以继续部署 Nuwax 服务。

Agent Platform Frontend

中文文档 |English Doc

贡献指南
  1. Fork 项目
  2. 创建功能分支
  3. 提交代码变更
  4. 创建 Pull Request

许可证

Apache 2.0 许可证 - 详见 LICENSE。