ghcr.io/windmill-labs/windmill:1.820

Windmill - 用于API、后台任务、工作流和UI的开发者平台

Windmill 完全开源（AGPLv3协议），Windmill Labs 提供专用实例以及商业支持和许可。

• Windmill - 用于API、后台任务、工作流和UI的开发者平台
• 核心概念
• 实际脚本代码示例
• 本地开发
• 技术栈
• 最快的可自托管工作流引擎
• 安全性
• 性能
• 架构
• 如何自托管
• Docker Compose
• Kubernetes（Helm图表）
• 云服务提供商
• OAuth、SSO 和 SMTP
• 许可协议
• 集成
• 环境变量
• 运行本地开发环境
• 仅前端
• 后端+前端
• 贡献指南
• 贡献者
• 版权信息

核心概念

2. 脚本参数会被自动解析并生成前端界面。

3. 构建流程！您可以将自己的脚本或社区在WindmillHub上共享的脚本链接起来。

4. 在脚本和流程之上构建复杂UI。

在Windmill之上构建您的整个基础设施！

实际脚本代码示例

//从npm导入任何依赖
import * as wmill from "windmill-client";
import * as cowsay from "cowsay@1.5.0";

// 填写类型，或使用+Resource类型获取资源的类型安全引用
type Postgresql = {
host: string;
port: number;
user: string;
dbname: string;
sslmode: string;
password: string;
};

export async function main(
a: number,
b: "my" | "enum",
c: Postgresql,
d = "从默认参数推断的字符串类型",
e = { nested: "object" }
//f: wmill.Base64
) {
const email = process.env["WM_EMAIL"];
// 变量按路径进行权限控制
let variable = await wmill.getVariable("f/company-folder/my_secret");
const lastTimeRun = await wmill.getState();
// 日志会被打印并始终可查看
console.log(cowsay.say({ text: "hello " + email + " " + lastTimeRun }));
await wmill.setState(Date.now());

// 返回值会序列化为JSON
return { foo: d, variable };
}

本地开发

Windmill支持多种本地开发方式，并可与您的实例同步：

您可以通过传递正确的环境变量，让wmill客户端库从您的实例获取资源和变量，从而在本地运行脚本。请参阅本地开发文档。

技术栈

• 数据库：Postgres（兼容Aurora、Cloud SQL、Neon、Azure PostgreSQL）
• 后端：Rust - 无状态API服务器和从Postgres队列拉取任务的工作节点
• 前端：Svelte 5
• 沙箱隔离：https://github.com/google/nsjail和PID命名空间隔离
• 运行时：
• TypeScript/JavaScript：Bun（默认）和Deno
• Python：python3，使用uv进行依赖管理
• Go、Bash、PowerShell、PHP、Rust、C#、Java、Ansible

最快的可自托管工作流引擎

我们将Windmill与其他可自托管工作流引擎（Airflow、Prefect和Temporal）进行了比较，Windmill在两个基准测试中都是性能最佳的解决方案：一个由40个轻量级任务组成的流程和一个由10个长时间运行任务组成的流程。

所有方法和结果请参见我们的基准测试页面。

安全性

• 沙箱隔离：https://github.com/google/nsjail用于文件系统/资源隔离，PID命名空间隔离（默认启用）防止任务访问工作节点进程内存
• 密钥管理：每个工作区使用一个加密密钥来加密存储在Windmill K/V存储中的凭证。我们还建议对Postgres数据库进行加密。

详情请参见安全文档。

性能

一旦任务启动，与在节点上使用相应的运行器（Deno/Go/Python/Bash）运行相同脚本相比，没有额外开销。任务从队列中被拉取、启动，然后将结果发送回数据库的额外延迟约为50ms。一个典型的轻量级deno任务总共需要约100ms。

架构

如何自托管

有关详细的设置选项，请参见自托管文档。

Docker Compose

使用3个文件部署Windmill（docker-compose.yml、Caddyfile、.env）：

curl https://raw.githubusercontent.com/windmill-labs/windmill/main/docker-compose.yml -o docker-compose.yml
curl https://raw.githubusercontent.com/windmill-labs/windmill/main/Caddyfile -o Caddyfile
curl https://raw.githubusercontent.com/windmill-labs/windmill/main/.env -o .env

docker compose up -d

访问 http://localhost - 默认凭据：admin@windmill.dev / changeme

使用外部数据库：在.env中设置DATABASE_URL以指向您的托管Postgres（AWS RDS、GCP Cloud SQL、Azure、Neon等），并将数据库副本数设置为0。

Kubernetes（Helm图表）

helm repo add windmill https://windmill-labs.github.io/windmill-helm-charts/
helm install windmill-chart windmill/windmill --namespace=windmill --create-namespace

OAuth, SSO & SMTP

直接从超级管理员界面配置 OAuth 和 SSO（Google Workspace、Microsoft/Azure、Okta）。参见文档。

运行本地开发环境

我们建议使用 Nix。有关所有选项，请参见 ./frontend/README_DEV.md。

仅前端

使用后端配合本地前端（热重载）：

cd frontend
npm install
npm run generate-backend-client # 或在 Mac 上使用 generate-backend-client-mac
npm run dev

Windmill 可通过 http://localhost/ 访问

后端 + 前端

有关所有运行选项，请参见 ./frontend/README_DEV.md 文件。

1. 使用例如 start-dev-db.sh 脚本启动本地 Postgres 数据库，该脚本将在 postgres://postgres:changeme@localhost:5432/windmill 提供数据库。然后使用以下命令运行迁移：

cargo install sqlx-cli
   env DATABASE_URL= sqlx migrate run

这也将避免 sqlx 的 query! 宏出现编译时问题。

2. （可选，仅适用于 Linux）安装 https://github.com/google/nsjail 并确保其在 PATH 中可访问

3. 安装 bun、deno 和 python3（以及任何您想要使用的语言），确保二进制文件位于 /usr/bin/bun、/usr/bin/deno 和 /usr/local/bin/python3，或设置相应的环境变量。

4. （可选）安装 https://lld.llvm.org/

5. 进入 frontend/ 目录：

   1. npm install、npm run generate-backend-client，然后 REMOTE=http://localhost:8000 npm run dev
   2. 您可能需要为 node 运行时设置额外的堆空间：export NODE_OPTIONS="--max-old-space-size=4096"
   3. 使用 mkdir frontend/build 创建空的 frontend/build 文件夹

6. 进入 backend/ 目录：

   1. env DATABASE_URL= RUST_LOG=info cargo run
   2. 您可以指定要启用的任何功能标志，例如 cargo run --features python 以启用 python 执行器。

7. Windmill 应可通过 http://localhost:3000 访问

贡献

目前，我们不寻求外部贡献。错误报告和功能请求仍然非常受欢迎，修复问题的小型、易于验证的 PR 仍会被接受。有关完整政策，请参见 CONTRIBUTING.md。

贡献者

版权

© 2023-2026 Windmill Labs, Inc.