name: dokploy
description: "通过 Dokploy API 管理部署、项目、应用和域名。"
emoji: "🐳"
metadata:
clawdhub:
requires:
bins: ["curl", "jq"]

Dokploy 技能

通过 Dokploy API 管理项目、应用、域名和部署。

前提条件

1. 正在运行的 Dokploy 实例，并已启用 API 访问。
2. 从 /settings/profile → "API/CLI 部分" 生成的 API 密钥。
3. 设置 DOKPLOY_API_URL 环境变量（默认值：http://localhost:3000）。

配置

设置以下环境变量或使用配置命令：

# Dokploy 实例 URL
export DOKPLOY_API_URL="https://your-dokploy-instance.com"

# 您的 API 令牌
export DOKPLOY_API_KEY="your-generated-api-key"

# 或者运行配置命令
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 "项目名称" --description "项目描述"

更新项目

dokploy-project update <project-id> --name "新名称" --description "更新描述"

删除项目

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"

支持的应用类型： docker, git, compose

触发部署

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

注意事项

• 所有 API 调用都需要 x-api-key 请求头。
• 在脚本中可使用 jq 工具解析 JSON 响应。
• 部分操作需要管理员权限。
• 部署是异步操作，请使用状态端点检查进度。