Dokploy 技能

与 Dokploy 的 API 交互，以管理项目、应用、域名和部署。

先决条件

1. Dokploy 实例正在运行且具有 API 访问权限
2. API 密钥生成自/settings/profile→ "API/CLI 部分"
3. 设置DOKPLOY_API_URL环境变量（默认值：http://localhost:3000）

配置

设置这些环境变量或使用 config 命令：

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

# Your API token
export DOKPLOY_API_KEY="your-generated-api-key"

# Or run the config command
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"

应用类型： 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解析
• 部分操作需要管理员权限
• 部署过程是异步的 — 请使用状态端点来检查进度