• 简体中文

      • 部署

      应用开发完成后，需要部署到服务器上运行。本章说明三件事：可选的部署方式及其适用场景，如何将部署交给 AI Agent 执行，以及手动部署时需要执行的命令。

      部署方式

      方式适用场景服务器要求
      Hub需要专业版授权。团队维护多个应用，希望在管理界面中统一管理版本、运行配置、部署记录和启停状态已安装的 Hub，安装方式见手动部署：Hub
      app-installer单个应用直接运行在服务器上，不使用容器；由 app-installer 负责 pm2 进程管理、升级前备份和失败回滚Node.js 24 和全局安装的 pm2
      Docker已有容器平台，或以 Compose 管理服务Docker 和 Compose

      三种部署方式使用同一个部署包。在应用项目根目录执行 pnpm build --tar，生成 storage/exports/dist.tar.gz；Docker 部署在镜像构建阶段从源码执行同一构建过程。部署包仅包含构建产物和生产依赖，不包含运行配置和业务数据，也不绑定挂载路径：同一个部署包既可以独立挂载在 /crm 等任意路径下，也可以交由 Hub 挂载在 /<应用 ID> 下。

      Hub 是 NocoBase 专业版提供的应用发布与管理平台，开源版不包含该功能；未持有专业版授权时，请使用 app-installer 或 Docker 部署。Hub 本身也是一个 NocoBase 应用。开发者将部署包上传至 Hub，运维人员在管理界面中选择版本、填写运行配置、发起部署并查看日志，业务用户通过各应用自身的地址访问业务功能。一台服务器可以同时提供管理平台地址（如 https://apps.example.com/hub/）和业务应用地址（如 https://apps.example.com/crm/）。

      执行方式

      • 由 AI Agent 执行。 说明部署目标、数据库和本次操作类型后，由 Agent 完成构建、上传、安装和验收。应用自带的部署 Skill 包含每一步的操作规范，无需记忆具体命令。详见用 AI Agent 部署。
      • 手动执行。 每种部署方式只需少量命令，详见手动部署：Hub和手动部署：独立运行。

      两种执行方式使用相同的命令。手动部署页面同时也是核对 Agent 操作内容的依据。

      准备事项

      无论采用哪种执行方式，以下内容都需要在开始前准备。Agent 无法自行获取这些信息和资源。

      项目说明
      服务器Linux x64 或 ARM64。记录其 CPU 架构和 Node 大版本，构建部署包时需要与运行环境一致；Hub 以 Docker 运行时，以容器环境为准
      访问地址域名和挂载路径，例如 https://apps.example.com/crm/，以及 HTTPS 证书和反向代理
      数据库默认的 SQLite 无需准备。使用 PostgreSQL、MySQL 等数据库时，需要预先创建数据库和账号，并在项目中安装驱动，例如 pnpm add @nocobase/db-postgres
      凭据数据库密码等凭据保存在 .env 或环境变量中，Hub API Key 通过 pnpm nocobase hub auth login 保存；均不写入对话、命令参数和代码仓库

      运行目录的组成

      内容说明更新应用时
      dist/构建产物和生产依赖替换
      config.yml当前环境的运行配置和密钥保留
      storage/数据库文件、上传文件和日志保留并定期备份

      区分这三部分内容，可以确保升级和回滚不影响数据。备份范围即 config.yml 和 storage/；使用外部数据库或对象存储时，其中的数据需要用各自的工具单独备份。Hub 的持久目录 APP_STORAGE_DIR 包含平台数据库、上传的 Release 以及各托管应用的配置和数据，应整体备份。运行配置的字段说明见运行配置，故障处理见排障。