Docs/Start Here

START HERE

OrbitMesh 项目概览

OrbitMesh 是一站式网络基础设施控制平面。

View source

1. 项目定位

OrbitMesh 是一站式网络基础设施控制平面。

它面向 AI 开发者、远程 Agent、独立开发者、研发团队和企业，用统一控制面管理不同主机上的网络能力。

一句话定义：

OrbitMesh 是围绕 Traffic、Mesh、Gateway、Tunnel 四大 Capability 构建的网络基础设施控制平面。

OrbitMesh 不是 sing-box 面板，也不是传统机场订阅系统。sing-box、Xray、EasyTier、Traefik、frp、NGINX、Envoy、WireGuard 等都只是 Runtime Plugin。

2. 背景

AI 开发工作流正在从“人访问网站”变成“人、工具、Agent、远程工作区持续访问开发者服务”。

典型访问目标包括：

GitHub / Git LFS / GitHub Releases。
Docker Hub / GHCR。
npm / PyPI / Crates.io / Homebrew。
Claude / OpenAI / Gemini。
Claude Code / Codex / Hermes Agent。
SSH / cloud APIs / MCP services。

这些目标不是简单网页浏览。它们有不同的连接特征：

API 请求需要低失败率。
Git / Docker 需要稳定吞吐。
SSH / Agent 需要长连接。
企业账号需要固定或可解释出口。
团队需要权限、审计和策略。

3. 核心问题

传统代理产品通常用以下维度描述价值：

节点数量。
月流量。
价格。
流媒体解锁。

专业开发者真正关心：

GitHub 是否快。
Docker pull 是否稳定。
Claude Code 是否断连。
SSH 是否掉线。
OpenAI / Anthropic API 是否可达。
出口 IP 是否稳定。
节点故障后是否自动切换。
是否能清楚知道问题发生在哪里。

OrbitMesh 的目标是将这些开发者体验变成可管理、可观测、可计费、可交付的基础设施能力。

4. 产品边界

OrbitMesh 负责：

Control Plane。
Node enrollment。
Edge Runtime 管理。
Capability Binding 编排。
Runtime Binding 编排。
Endpoint、DNS、证书和 TLS 资源。
Traffic 策略路由。
Desired State 生成。
Runtime configuration 编译。
Subscription 分发。
健康引擎。
指标与日志。
多租户。
计费与套餐。
企业治理。

OrbitMesh 不负责：

AI 模型推理。
Git 托管。
CI/CD。
Kubernetes 集群编排。
云资源账单托管。
大流量娱乐网站。

5. 核心 Capability

Capability	作用
Traffic	流量代理、订阅、Entry / Exit / Relay、策略路由、流量统计和配额
Mesh	设备组网、私有网络、P2P、NAT 穿透、Subnet Route
Gateway	HTTP/TCP/UDP 入口、反向代理、TLS、负载均衡
Tunnel	内网穿透、内网服务公网暴露、临时公网访问

Entry、Exit、Relay 是 Traffic Capability 的角色，不是软件，也不是顶层产品资源。

6. 目标用户

6.1 个人开发者

目标：

自带 VPS、NAS、OpenWrt 或 Linux Server。
一键 enroll 自己的 Node。
自动生成 Traffic subscription。

6.2 AI 重度用户

目标：

Claude Code / Codex 长时间在线。
OpenAI / Anthropic API 稳定访问。
故障时自动切换 Traffic Exit。

6.3 小型团队

目标：

多成员。
共享 Node。
固定出口。
团队订阅。
基础审计。

6.4 企业

目标：

SSO / RBAC。
审计日志。
私有化部署。
固定出口 IP。
SLA。

7. 总体架构

Console / CLI / API
      |
      v
Control Plane
      |
      +-- Tenant / User / Billing
      +-- Node Manager
      +-- Capability Manager
      +-- Runtime Manager
      +-- Endpoint Manager
      +-- Deployment Service
      +-- Traffic Policy Engine
      +-- Configuration Compiler
      +-- Health Engine
      +-- Observability
      |
      v
Edge Runtime
      |
      +-- Runtime Plugins
      +-- Capability Endpoints
      |
      v
Developer Services / Private Services / Mesh Peers

8. 核心抽象

User Intent
        |
        v
Capability Binding
        |
        v
Runtime Binding
        |
        v
Endpoint
        |
        v
Desired State
        |
        v
Runtime Configuration
        |
        v
Edge Runtime Reconcile

MVP 使用 sing-box，但 sing-box 只是第一个 Traffic Runtime Plugin。

9. MVP 闭环

MVP 必须打通 Traffic 流程：

用户创建租户。
用户生成 Node enrollment token。
用户在主机上执行安装命令。
Node 自动安装 Edge Runtime 并注册。
用户在 Node 上启用 traffic.entry 和 traffic.exit。
Control Plane 生成 Desired State。
Configuration Compiler 编译 sing-box runtime configuration。
Edge Runtime 拉取并应用配置。
用户获取 Traffic subscription。
客户端通过 Traffic Entry endpoint 接入。
流量经 Traffic Exit role 访问目标服务。

10. 非功能目标

控制面与数据面分离。
Node 断开控制平面后仍可保持最后一次有效配置。
配置变更可回滚。
Node 注册不依赖控制平面 SSH。
所有租户数据必须隔离。
所有 token 必须哈希存储。
控制平面 API 可水平扩展。
Edge Runtime 协议可版本化。

11. 开发优先级

当前暂停新增功能开发，先完成现有功能对齐。

对齐优先级：

文档和术语对齐。
数据库 SQL 迁移方案。
Control Plane 模型对齐。
Edge Runtime 协议对齐。
Console 菜单和路由对齐。
Traffic MVP smoke test。

功能恢复后优先级：

Traffic subscription。
Traffic policy。
Usage and quota。
Domains and certificates。
Runtime plugin model。
Mesh / Gateway / Tunnel capability expansion。

12. 验收标准

现有功能对齐完成后应满足：

能创建租户和用户。
能 enroll Node。
能在 Node 上启用 traffic.entry 和 traffic.exit。
能为 Node 绑定 sing-box runtime。
控制平面能生成 Desired State。
Edge Runtime 能应用配置并上报状态。
用户能获取 Traffic subscription。
客户端能通过 Traffic Entry -> Traffic Exit 访问 GitHub。
Node 离线后 Console 状态变化。
配置失败时 Edge Runtime 能保留 last known good config。