Dokploy Skill 用于与 Dokploy 的 API 交互,管理项目、应用、域名和部署。
用途
该技能面向需要通过命令行或脚本操作 Dokploy 的用户,提供对项目、应用、域名、环境变量和部署的统一管理入口。
主要能力
- 项目管理:列出、获取详情、创建、更新、删除项目。
- 应用管理:列出项目下的应用、获取应用详情、创建应用、触发部署、查看部署日志、列出部署记录、更新应用、删除应用。应用类型包括 docker、git、compose。
- 域名管理:列出应用下的域名、获取域名详情、为应用添加域名、更新域名、删除域名。
- 环境变量管理:列出应用的环境变量、设置环境变量、删除环境变量。
- 工具命令:检查 API 连接、查看当前配置。
使用方式
前置条件:
- 运行中的 Dokploy 实例并开放 API 访问。
- 在 /settings/profile → "API/CLI Section" 生成 API Key。
- 设置 DOKPLOY_API_URL 环境变量(默认:http://localhost:3000)。
配置方式: 可通过环境变量配置:
export DOKPLOY_API_URL="https://your-dokploy-instance.com"
export DOKPLOY_API_KEY="your-generated-api-key"
或使用 config 命令:
dokploy-config set --url "https://your-dokploy-instance.com" --key "your-api-key"
常用命令示例:
- 列出所有项目:
dokploy-project list - 获取项目详情:
dokploy-project get <project-id> - 创建项目:
dokploy-project create --name "My Project" --description "Description here" - 更新项目:
dokploy-project update <project-id> --name "New Name" --description "Updated" - 删除项目:
dokploy-project delete <project-id> - 列出项目下的应用:
dokploy-app list --project <project-id> - 获取应用详情:
dokploy-app get <application-id> - 创建应用:
dokploy-app create --project <project-id> --name "my-app" --type "docker" --image "nginx:latest" - 触发部署:
dokploy-app deploy <application-id> - 获取部署日志:
dokploy-app logs <application-id> --deployment <deployment-id> - 列出部署:
dokploy-app deployments <application-id> - 更新应用:
dokploy-app update <application-id> --name "new-name" --env "KEY=VALUE" - 删除应用:
dokploy-app delete <application-id> - 列出应用域名:
dokploy-domain list --application <application-id> - 获取域名详情:
dokploy-domain get <domain-id> - 添加域名:
dokploy-domain create --application <application-id> --domain "app.example.com" --path "/" --port 80 - 更新域名:
dokploy-domain update <domain-id> --domain "new.example.com" - 删除域名:
dokploy-domain delete <domain-id> - 列出环境变量:
dokploy-app env list <application-id> - 设置环境变量:
dokploy-app env set <application-id> --key "DATABASE_URL" --value "postgres://..." - 删除环境变量:
dokploy-app env delete <application-id> --key "DATABASE_URL" - 检查 API 连接:
dokploy-status - 查看当前配置:
dokploy-config show
API 参考:
基础 URL:$DOKPLOY_API_URL/api
| 端点 | 方法 | 说明 |
|---|---|---|
| /project.all | GET | 列出所有项目 |
| /project.create | POST | 创建项目 |
| /project.byId | GET | 按 ID 获取项目 |
| /project.update | PATCH | 更新项目 |
| /project.delete | DELETE | 删除项目 |
| /application.all | GET | 列出应用 |
| /application.create | POST | 创建应用 |
| /application.byId | GET | 按 ID 获取应用 |
| /application.update | PATCH | 更新应用 |
| /application.delete | DELETE | 删除应用 |
| /application.deploy | POST | 触发部署 |
| /deployment.all | GET | 列出部署 |
| /deployment.byId | GET | 按 ID 获取部署 |
| /deployment.logs | GET | 获取部署日志 |
| /domain.all | GET | 列出域名 |
| /domain.create | POST | 创建域名 |
| /domain.update | PATCH | 更新域名 |
| /domain.delete | DELETE | 删除域名 |
适用场景
- 通过命令行或脚本批量管理 Dokploy 中的项目、应用与域名。
- 自动化触发部署并查看部署日志与状态。
- 在 CI/CD 或运维脚本中集成 Dokploy 操作。
限制与注意事项
- 所有 API 调用都需要 x-api-key 请求头。
- 脚本中可使用 jq 解析 JSON。
- 部分操作需要管理员权限。
- 部署是异步的,需使用状态端点检查进度。
- 关于收费、价格、平台支持范围等信息,资料中暂未提供。