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 客户端库传递正确的环境变量，从实例中获取资源和变量，从而在本地运行脚本。详见 本地开发文档。

云服务提供商

Windmill 可在 AWS (EKS/ECS)、GCP、Azure、Ubicloud、Fly.io、Render.com、Hetzner、Digital Ocean 等平台运行。经验法则：每 1vCPU 和 1-2 GB RAM 配置 1 个工作节点。

OAuth、SSO 和 SMTP

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

许可协议

社区版可免费在内部使用。如需商业再分发或托管服务，请联系 。详情参见 LICENSE 和 定价。

托管于 ghcr.io/windmill-labs/windmill 的 Docker 镜像以及 GitHub 二进制发行版中提供的 Windmill“社区版”包含 AGPLv3 和 Apache 2 许可下的源代码文件，但也包含专有和非公开的代码及功能，这些代码和功能并非开源，且受以下条款约束：Windmill Labs, Inc. 授予免费使用“社区版”所有功能的权利，除软件中设置的限制和配额外无其他限制；授予按原样分发社区版的权利，但未经明确协议，不得销售、转售、将 Windmill 作为托管服务提供、修改或以任何形式包装。

从本仓库源代码（未启用“enterprise”功能标志）编译的二进制文件基于 https://github.com/windmill-labs/windmill/blob/main/LICENSE-AGPL 许可条款开源。

如需将 Windmill 的任何部分作为产品功能直接重新暴露给用户（嵌入的公共 Windmill“应用”除外），或在“Windmill 社区版”基础上构建商业销售或嵌入可分发产品/二进制文件的功能，必须获取商业许可。如有疑问，请联系 。对于从本仓库源代码（未启用“enterprise”功能标志）编译的二进制文件执行上述操作，必须遵守 AGPLv3 许可条款，或从 Windmill Labs, Inc. 获取商业许可。

如需在组织内部按原样使用 Windmill“社区版”，或按原样使用其 API，则无需商业许可。

集成

在 Windmill 中，集成被称为资源和资源类型。每个资源都有一个资源类型，该类型定义了资源需要实现的 schema。

在自托管实例上，您可能需要从 WindmillHub 导入所有已批准的资源类型。安装脚本会提示您将其设置为每天自动同步。

运行本地开发环境

我们推荐使用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%E5%B9%B6%E7%A1%AE%E4%BF%9D%E5%85%B6%E5%9C%A8PATH%E4%B8%AD%E5%8F%AF%E8%AE%BF%E9%97%AE 3. 安装bun、deno和python3（以及任何你想使用的语言），确保二进制文件位于/usr/bin/bun、/usr/bin/deno和/usr/local/bin/python3，或设置相应的环境变量。 4.（可选）安装lld链接器 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文件夹
4. 进入backend/目录：
   1. 执行env DATABASE_URL= RUST_LOG=info cargo run
   2. 可指定任何要启用的特性标志，例如cargo run --features python以启用Python执行器。
5. Windmill 应可通过http://localhost:3000访问

贡献者

版权

© 2023-2026 Windmill Labs, Inc.