如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具,协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题,请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可:
请先完整阅读并严格遵守以下文档中的全部规则与要求:
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前,不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式,不推荐豆包 AI;Cursor 等编辑器可在对话 @ 该链接,或加入 User Rules。 若 AI 无法访问外链,可 打开说明文档 复制全文粘贴。文档会随站点更新,复制内容可能过期,建议定期检查。
面向内部代码的开源开发者平台:API、后台任务、工作流和UI。可自托管的替代方案,适用于Retool、Pipedream、Superblocks,以及简化版的Temporal,提供自动生成的UI和自定义UI,可将工作流和脚本作为内部应用触发。
脚本会自动转换为可共享的UI,并且可以组合成工作流,或用于通过低代码构建的更丰富的应用中。支持的语言:Python、TypeScript、Go、Bash、SQL、GraphQL、PowerShell、Rust等。
立即尝试 - 网站 - 文档 - *** - 中心 - 贡献者指南
Windmill 完全开源(AGPLv3 许可),Windmill Labs 提供专用实例以及商业支持和许可。
脚本参数会被自动解析并生成前端界面。
构建工作流!您可以将自己的脚本或社区在WindmillHub上共享的脚本链接起来。
在脚本和工作流之上构建复杂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 支持多种本地开发方式,并可与您的实例同步:
| 工具 | 描述 |
|---|---|
| 命令行工具(CLI) | 从本地文件或GitHub同步脚本,通过命令行运行脚本/工作流 |
| VS Code 扩展 | 直接在VS Code / Cursor中编辑和测试脚本及工作流,提供完整IDE支持 |
| Git 同步 | Windmill与Git仓库之间的双向同步 |
| Claude Code | 借助Claude进行AI辅助开发,支持脚本、工作流和应用 |
您可以通过为wmill客户端库传递正确的环境变量,从您的实例获取资源和变量,从而在本地运行脚本。参见本地开发文档。
我们将Windmill与其他可自托管工作流引擎(Airflow、Prefect和Temporal)进行了比较,Windmill在两个基准测试中都是性能最佳的解决方案:一个由40个轻量级任务组成的工作流,以及一个由10个长时间运行任务组成的工作流。
所有方法和结果详见我们的基准测试页面。
详见安全文档。
任务启动后,与在节点上使用相应的运行器(Deno/Go/Python/Bash)运行相同脚本相比,没有额外开销。任务从队列中拉取、启动,然后将结果发送回数据库的额外延迟约为50ms。一个典型的轻量级Deno任务总共需要约100ms。
有关详细的设置选项,请参见自托管文档。
使用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。
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 个工作节点。
可直接从超级管理员 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 导入所有已批准的资源类型。安装脚本会提示您将其设置为每天自动同步。
| 环境变量名称 | 默认值 | 描述 | 适用组件(API服务器/工作节点/全部) |
|---|---|---|---|
| DATABASE_URL | Postgres 数据库 URL。 | 全部 | |
| WORKER_GROUP | default | 工作节点所属的工作组,其配置将从此组拉取 | 工作节点 |
| MODE | standalone | 二进制文件的运行模式。可能的值:standalone(独立模式)、worker(工作节点模式)、server(服务器模式)、agent(代理模式) | 全部 |
| METRICS_ADDR | None | (仅企业版)用于在 /metrics 路径暴露 Prometheus 指标的套接字地址。设置为 "true" 可在 8001 端口暴露 | 全部 |
| JSON_FMT | false | 以 JSON 格式输出日志,而非 logfmt 格式 | 全部 |
| BASE_URL | http://localhost:8000 | 公开访问实例的基础 URL。如有实例设置,将覆盖此值 | 服务器 |
| ZOMBIE_JOB_TIMEOUT | 30 | 工作节点未发送任务处理心跳时,任务被视为僵尸任务的超时时间(秒)(服务器每30秒检查一次僵尸任务) | 服务器 |
| RESTART_ZOMBIE_JOBS | true | 若为 true,僵尸任务将被重启(使用相同 UUID 原地重启并保留部分日志);若为 false,僵尸任务将标记为失败 | 服务器 |
| NATIVE_MODE | false | 启用原生模式:设置 NUM_WORKERS=8,拒绝非原生任务(nativets、postgresql、mysql 等) | 工作节点 |
| SLEEP_QUEUE | 50 | 上次检查数据库中是否有新任务后休眠的毫秒数。此值会乘以 NUM_WORKERS,因此对于单个工作节点实例,平均每 SLEEP_QUEUE 毫秒拉取一次任务 | 工作节点 |
| KEEP_JOB_DIR | false | 任务完成后保留任务目录。用于调试 | 工作节点 |
| LICENSE_KEY (EE only) | None | Windmill 企业版启动时检查的许可证密钥 | 工作节点 |
| SLACK_SIGNING_SECRET | None | Slack 应用的签名密钥。参见 Slack 文档 | 服务器 |
| COOKIE_DOMAIN | None | Cookie 的域名。若未设置,浏览器将根据完整源自动设置 Cookie | 服务器 |
| DENO_PATH | /usr/bin/deno | deno 二进制文件的路径。 | 工作节点 |
| PYTHON_PATH | 若不想由 uv 管理 Python 二进制文件,可指定其路径 | 工作节点 | |
| GO_PATH | /usr/bin/go | go 二进制文件的路径。 | 工作节点 |
| GOPRIVATE | 用于私有 Go 模块的 GOPRIVATE 环境变量 | 工作节点 | |
| GOPROXY | 要使用的 GOPROXY 环境变量 | 工作节点 | |
| NETRC | 用于私有 Go 仓库的 netrc 内容 | 工作节点 | |
| PY_CONCURRENT_DOWNLOADS | 20 | 设置 Windmill 在任何时候执行的最大并发 Python 下载数 | 工作节点 |
| PATH | None | PATH 环境变量,通常继承自系统 | 工作节点 |
| HOME | None | 用于 Go 和 Bash 的主目录,通常继承自系统 | 工作节点 |
| DATABASE_CONNECTIONS | 50 (服务器)/3 (工作节点) | 数据库连接池中的最大连接数 | 全部 |
| SUPERADMIN_SECRET | None | 允许调用者以虚拟超级管理员 *** 身份操作的令牌 | 服务器 |
| TIMEOUT_WAIT_RESULT | 20 | 'run_wait_result' 端点的超时等待秒数 | 工作节点 |
| QUEUE_LIMIT_WAIT_RESULT | None | 'run_wait_result' 端点在拒绝请求前的最大队列任务数。优先于查询参数。若未指定,则无限制 | 工作节点 |
| DENO_AUTH_TOKENS | None | 传递给工作节点的自定义 DENO_AUTH_TOKENS,用于允许使用私有模块 | 工作节点 |
| DISABLE_RESPONSE_LOGS | false | 禁用响应日志 | 服务器 |
| CREATE_WORKSPACE_REQUIRE_SUPERADMIN | true | 若为 true,则仅超级管理员可创建新工作区 | 服务器 |
| MIN_FREE_DISK_SPACE_MB | *** | 工作节点的最小可用磁盘空间(MB)。若工作节点可用空间不足,将发送严重警报 | 工作节点 |
| RUN_UPDATE_CA_CERTIFICATE_AT_START | false | 若为 true,在其他初始化操作前运行 CA 证书更新命令 | 全部 |
| RUN_UPDATE_CA_CERTIFICATE_PATH | /usr/sbin/update-ca-certificates | 当 RUN_UPDATE_CA_CERTIFICATE_AT_START 为 true 时,运行 CA 证书更新命令/脚本的路径 | 全部 |
我们建议使用 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 文件。
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/ 目录:
npm install、npm run generate-backend-client,然后 REMOTE=http://localhost:8000 npm run devexport NODE_OPTIONS="--max-old-space-size=4096"mkdir frontend/build 创建空的 frontend/build 文件夹backend/ 目录:
env DATABASE_URL= RUST_LOG=info cargo runcargo run --features python 以启用 Python 执行器。http://localhost:3000 访问© 2023-2026 Windmill Labs, Inc.
来自真实用户的反馈,见证轩辕镜像的优质服务