ghcr.io/windmill-labs/windmill-extra:1.693.3

面向内部代码的开源开发者平台：API、后台任务、工作流和 UI。可自托管的替代方案，适用于 Retool、Pipedream、Superblocks，以及简化版 Temporal，提供自动生成的 UI 和自定义 UI，可将工作流和脚本作为内部应用触发。

脚本会自动转换为可共享的 UI，并可组合成工作流，或用于通过低代码构建的更丰富应用中。支持的语言：Python、TypeScript、Go、Bash、SQL、GraphQL、PowerShell、Rust 等。

立即体验 - 网站 - 文档 - *** - 中心 - 贡献者指南

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

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

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

核心概念

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

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

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

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

实际脚本代码示例

//import any dependency from npm
import * as wmill from "windmill-client";
import * as cowsay from "cowsay@1.5.0";

// fill the type, or use the +Resource type to get a type-safe reference to a 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 = "inferred type string from default arg",
e = { nested: "object" }
//f: wmill.Base64
) {
const email = process.env["WM_EMAIL"];
// variables are permissioned and by path
let variable = await wmill.getVariable("f/company-folder/my_secret");
const lastTimeRun = await wmill.getState();
// logs are printed and always inspectable
console.log(cowsay.say({ text: "hello " + email + " " + lastTimeRun }));
await wmill.setState(Date.now());

// return is serialized as 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 键值存储中的凭据。我们建议同时加密 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

许可协议

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

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%E8%AE%B8%E5%8F%AF%E6%9D%A1%E6%AC%BE%EF%BC%8C%E4%B8%BA%E5%BC%80%E6%BA%90%E8%BD%AF%E4%BB%B6%E3%80%82

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

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

运行本地开发环境

我们建议使用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.