Back to Details

dokploy-deploy

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Dokploy Deployment

Dokploy 部署

This skill enables you to manage and deploy applications to a Dokploy instance. Dokploy is an open-source PaaS (Platform as a Service) that simplifies deployment on your own VPS.
本技能可帮助您管理应用并将其部署到Dokploy实例。Dokploy是一款开源PaaS（平台即服务），可简化在自有VPS上的部署流程。

Prerequisites

前提条件

  • Access to a Dokploy instance.
  • Dokploy CLI installed (
    npm install -g dokploy
    ).
  • API Token (generated from Dokploy Dashboard > Settings > Profile).
  • 拥有Dokploy实例的访问权限。
  • 已安装Dokploy CLI（执行
    npm install -g dokploy
    ）。
  • API Token（从Dokploy控制台 > 设置 > 个人资料生成）。

How to Deploy

部署方法

1. Using Dokploy CLI

1. 使用Dokploy CLI

If the CLI is available in the environment:
bash
undefined
如果环境中已安装CLI：
bash
undefined

Login

登录

dokploy login --host <your-dokploy-host> --token <your-token>
dokploy login --host <your-dokploy-host> --token <your-token>

Create a Project (if not exists)

创建项目（如不存在）

dokploy project create --name <project-name>
dokploy project create --name <project-name>

Create an Application

创建应用

dokploy app create --name <app-name> --projectName <project-name>
dokploy app create --name <app-name> --projectName <project-name>

Deploy

部署

dokploy app deploy --name <app-name> --projectName <project-name>
undefined
dokploy app deploy --name <app-name> --projectName <project-name>
undefined

2. Manual Deployment via Dashboard

2. 通过控制台手动部署

  1. Navigate to your Dokploy host (e.g., 
    http://vps-ip:3000
    ).
  2. Create or select a Project.
  3. Add a new Service > Application.
  4. Connect your Git Repository (GitHub/GitLab) or use a Docker Image.
  5. Configure Nixpacks or Dockerfile for the build.
  6. Click Deploy.
  1. 访问您的Dokploy主机（例如：
    http://vps-ip:3000
    ）。
  2. 创建或选择一个项目。
  3. 添加新的服务 > 应用。
  4. 连接您的Git仓库（GitHub/GitLab）或使用Docker镜像。
  5. 配置Nixpacks或Dockerfile用于构建。
  6. 点击部署。

Best Practices

最佳实践

  • Environment Variables: Always use the Dokploy dashboard or CLI to set secrets. Do not commit 
    .env
    files.
  • Health Checks: Configure health checks in the Dokploy dashboard to ensure zero-downtime deployments.
  • Nixpacks: Prefers Nixpacks for automatic language detection and build optimization.
  • 环境变量：始终通过Dokploy控制台或CLI设置密钥，不要提交
    .env
    文件。
  • 健康检查：在Dokploy控制台中配置健康检查，确保零停机部署。
  • Nixpacks：优先使用Nixpacks进行自动语言检测和构建优化。

Triggering via API

通过API触发部署

You can trigger a deployment programmatically using a POST request to the Dokploy API:
text
POST https://<your-dokploy-host>/api/deployments/deploy
Authorization: Bearer <your-token>
Content-Type: application/json

{
  "applicationId": "<your-application-id>"
}
您可以通过向Dokploy API发送POST请求以编程方式触发部署：
text
POST https://<your-dokploy-host>/api/deployments/deploy
Authorization: Bearer <your-token>
Content-Type: application/json

{
  "applicationId": "<your-application-id>"
}