elliothux/open-compute

一个二进制。一个 daemon。多个隔离 instance。
在一台自己的机器上运行兼容 Cloudflare Workers 的完整平台。

官网 · 文档 · 兼容性 · 架构设计

English · 简体中文

如果你已经会写 Cloudflare Workers，就可以直接使用 open-compute。标准 module Worker、常用 binding 配合当前 cf 工作流，只是运行位置换成了你自己的机器。

一个二进制。一个共享 daemon。每个 instance 一份对象 authority。 默认直接使用 Local 文件系统，也可显式选择 S3-compatible 存储。

不需要 Kubernetes、Redis、服务网格或分布式控制面，也不会把数据锁在托管平台里。

   别人的方案                            open-compute
   ─────────────                        ────────────
   gateway + router                     ┌──────────────┐
   control plane                        │              │
   scheduler service          ═══>      │  ocd（1 个）  │
   Redis / Valkey 集群                   │              │
   Postgres                             └──────────────┘
   K8s + operators                       + SQLite + Local/S3 objects

workerd 是运行时，不是完整的平台。 它负责隔离执行 Worker，但不提供多租户路由、持久状态、调度、部署生命周期或控制 API。要在自己的基础设施上运行 Workers，这一层仍然需要有人来实现。

open-compute 补上了这一层，并把它交付为一个文件。

• 一个二进制，组件都在里面。 运行时、控制面、调度器和产品 binding 随同一个文件交付。把它复制到主机并指定数据目录，就可以开始运行。
• 使用 workerd 执行 Worker。 Worker 运行在固定版本、校验摘要的 workerd fork 中。isolate 可在毫秒级启动，不必为每个请求创建进程或容器。
• 不需要配套服务。 SQLite 保存平台元数据；对象默认写入本地文件系统，也可以切换到 S3-compatible 存储。两种方式都不需要额外的数据库或缓存 sidecar。
• 运行时固定且可验证。 runtime 及其资源会在构建和启动时校验，生产环境启动时不需要联网。
• 代码和数据留在自己的机器上。 外部服务都是可选项，只有显式配置后才会使用。

兼容性以测试结果为准。只要 Cloudflare 托管 API 允许直接对照，同一组请求就会分别发送到 open-compute 和真实 Cloudflare 环境。

编写标准 module worker（export default { fetch }），使用你熟悉的 binding。准确行为和单机差异见兼容性指南。

依赖这些能力的上传或配置会 fail closed。

Cloudflare 的 API 非常纷繁复杂。99% ✅ 表示文档列出的 public API 已完全对齐，但不承诺所有细节行为都与 Cloudflare 完全一致。 open-compute 仍处于早期阶段；如果遇到未与 Cloudflare 对齐的行为，欢迎提交 issue。单机差异见兼容性指南。运行中能力：ocd capabilities --json。

把下面这段提示复制到 Codex、Claude Code 或其他 coding agent：

阅读 https://open-compute.dev/llms.txt，在这台机器上安装 open-compute 当前正式版本并配置一个本机 instance。先检查已有安装，默认保留现有配置和 instance 数据；使用 sudo 或执行破坏性操作前先询问我。最后运行 ocd status，并报告结果。

llms.txt 提供最简安装和使用说明，并在需要时链接到详细文档。

为当前用户安装正式版本，创建默认的用户级 instance，并启动随登录会话运行的 service：

curl -fsSL https://open-compute.dev/install.sh | sh
ocd setup --yes
ocd status
ocd dashboard

需要登录前启动的整机 service 时，显式选择 system scope：

curl -fsSL https://open-compute.dev/install.sh | sudo sh
sudo ocd setup --system --yes

应用使用 cloudflare.config.ts 和官方 cf + Vite 插件 v2，由 Node.js 22.18+ 执行 cf，ocd cf 选择部署目标。内部 CI 固定 cf 1.0.0-beta.12；用户的非 1.0.x 版本仅警告：

npm install --save-dev cf@1.0.0-beta.12 @cloudflare/vite-plugin@beta vite typescript
npm run dev
npm run build
ocd cf deploy --prebuilt --mode production

生产环境仍然只需要一个发布二进制和一个共享 daemon，每个 instance 显式拥有自己的配置与数据目录。runtime payload 已内嵌并经过校验；daemon 启动时不会下载 workerd，也不会在 PATH 中查找它。

完整安装流程以及 remote target、CI、environment、tail 和 rollback 见快速开始与开发应用。

租户只能访问部署中明确声明的能力。SQLite 和本地对象路径、S3 凭据、内部 token 以及其他租户都不会进入 Worker 环境。这些限制由能力层执行，不依赖使用约定。

宿主是一个异步 Rust 进程。请求从 socket 到 Worker 之间不经过解释器，也不需要额外的 sidecar 转发。

• 全链路异步。 tokio 多线程 runtime，axum + hyper 同时承载两个平面。请求体以 bytes 流式穿过，不缓冲整个 payload。
• unsafe_code = "forbid"。 全 workspace 生效——整个平台是 safe Rust。外加 missing_docs = "deny"、unused_must_use = "deny"，以及全 target/全 feature 的 Clippy -D warnings。
• release 为速度而编。 完整 LTO、codegen-units = 1、panic = "abort"、strip 符号表——一个致密的静态链接产物。
• 进程内状态。 rusqlite 将 SQLite 内嵌到 ocd；事务是函数调用，不是网络往返。外键保持开启，WAL 由本机持有。
• 该省的拷贝都省掉。 校验过的运行时 payload 按内容寻址、只物化一次，跨重启复用。

CI 会校验 crate 的依赖方向：

core ── storage ── artifacts ── runtime      （同级，底层）
                    └── workers              （可用 core/storage/artifacts，绝不用 runtime）
                          └── service        （组装根：CLI、HTTP、workerd bridge）

ocd 编译 runtime config，把 workerd 作为受监督 child 拉起，并通过仅监听回环的通道通信。它负责 readiness、 优雅停止、重启退避与恢复。

部署内容不可变，并按内容寻址。workerLoader 的 key 就是部署身份，因此 promote 和 rollback 只会移动指针，不会修改已经运行的内容。

Dashboard 用于管理 /client/v4 已开放的计算、存储、AI 和平台资源，也可以在当前 ocd daemon 登记的 instance 之间切换。

当 Worker 需要访问本机硬件、私有库或内部 daemon 时，运维人员可以注册一个原生扩展。每个扩展由一个原生 Provider 进程和一层轻量 JavaScript facade 组成，并通过cf Service Binding（bindings.worker + props） 暴露给 Worker。

• 不增加新的 Binding 类型。 Worker 看到的仍然是标准 Service Binding；每个 binding 的配置放在 props 中。
• 数据直接传输。 ocd 完成 session 认证后，由 workerd 和 Provider 通过 Cap'n Proto 直接通信。
• 默认拒绝越界访问。 session identity、Provider 路径和平台句柄不会进入租户代码、argv 或日志。

扩展教程介绍了完整实现过程。仓库中也提供了一个小型 Rust 参考 Provider。

• 不提供 Cloudflare 的全球边缘网络。 open-compute 运行在你自己的单节点基础设施上，没有 Anycast、跨地域复制或 POP 网络。对应的好处是本机状态保持强一致。
• 并非所有 Cloudflare 产品都可以直接替换。 兼容性按 surface 跟踪，已知差异会明确记录在文档中。
• 不是多副本 HA 集群。 一个 daemon、一台机器和相互隔离的 instance authority 是当前明确的部署模型。

发现安全漏洞，请通过 SECURITY.md 中的私密渠道报告。

• 每个 user 或 system 作用域只允许一个 ocd，每个 instance 数据目录都有独占锁。
• 内部 token 永不出现在 argv、环境变量、日志、status 或 metrics 中。
• 租户出站可访问宿主可路由的公网、私网、loopback、link-local 与 metadata IP；operator 通过宿主 firewall、namespace、容器或 VM 负责目标过滤。

本项目由 Lynx AI 赞助。

Apache-2.0。打包的 open-compute workerd fork 仍遵循适用的 upstream Cloudflare workerd 许可证。