Documentation

部署说明

HarnessHub CN 开发机、Docker、生产与企业私有化完整指南。仓库内 Markdown 版:docs/DEPLOYMENT.md

一键初始化

Windows / macOS / Linux 开发机推荐流程:

# 克隆后进入仓库
cp .env.example .env

# 一键(Windows)
pnpm dev:setup

# 或 macOS / Linux
bash scripts/dev-setup.sh

# 另开终端
pnpm dev:panel    # 本地监控 → http://127.0.0.1:6002
pnpm dev          # Web 站点 → http://127.0.0.1:6006
pnpm cli install  # Cursor 插件

部署模式

模式命令场景
推荐pnpm docker:dev + pnpm devPostgres + ClickHouse + Web 热更新
API 热重载stop api + pnpm dev:api开发 FastAPI Python 代码
轻量pnpm dev:api无 Docker,metrics 内存模式
全容器docker compose up -dWeb + API 均容器化

端口规划(6000–6009)

6006
Web Dashboard
/
6001
FastAPI
/dashboard
6002
本地监控面板
pnpm dev:panel
6003
PostgreSQL
Docker
6004
ClickHouse HTTP
Docker
6005
ClickHouse Native
Docker

环境变量(.env)

.env.example 复制。开发机最小配置:

DATABASE_URL=postgresql://agent_harness:devpassword@localhost:6003/agent_harness
CLICKHOUSE_URL=http://localhost:6004
API_URL=http://localhost:6001
AGENT_HARNESS_API_URL=http://localhost:6001
WEB_BASE_URL=http://localhost:6006
ENV=development
ALLOW_DEV_MOCK_LOGIN=true

Cursor 云同步:在用户环境变量中设置 AGENT_HARNESS_API_URL=http://localhost:6001

生产 / 企业部署

  • 复制 .env.example.env.prod,填写密钥与域名
  • TLS 证书放入 deploy/certs/
  • 启动:docker compose -f docker-compose.prod.yml up -d
  • 企业 SSO / Helm / 定制技能:见仓库 deploy/enterprise.md

验证

curl http://localhost:6001/health
curl http://localhost:6001/api/v1/marketplace/skills
pnpm test

故障排查

端口 6006 被占用

运行 pnpm dev:kill,或停止 docker compose 中的 web 容器

监控面板无数据

设置 AGENT_HARNESS_API_URL,安装 Cursor 插件并结束 Agent 会话

API 数据不持久化

确认 DATABASE_URL 指向 localhost:6003 且 Postgres 容器已启动

仓库完整文档

以下内容在 Git 仓库中维护,包含 Helm、Marketplace 打包、ECC 子模块等:

  • docs/DEPLOYMENT.md — 完整部署说明(主文档)
  • docs/RELEASE-NOTES.md — 更新说明与时间线(仓库内)
  • deploy/enterprise.md — 企业私有化
  • deploy/helm/README.md — Kubernetes
  • docs/marketplace/release.md — 插件 Release
← 返回首页