ghcr.io/windmill-labs/windmill-cli:1.705

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 个文件（docker-compose.yml、Caddyfile、.env）部署 Windmill：

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

云服务提供商

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 和 定价。

Windmill“社区版”可通过 ghcr.io/windmill-labs/windmill 托管的 Docker 镜像和 GitHub 二进制发行版获取，包含 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 并确保其在 PATH 中可访问 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.