A GitHub Action that triggers deployments on Dokploy and optionally polls for deployment status completion.

• ✅ Deploy applications and compose projects on Dokploy using direct IDs
• 🔄 Optional polling for deployment status using deployment tracking APIs
• ⏱️ Configurable polling intervals and timeouts
• 📊 Detailed status reporting with deployment IDs and logs

- name: Deploy to Dokploy
  uses: thinesjs/dokploy-deployer-action@v1
  with:
      dokploy_url: ${{ secrets.DOKPLOY_URL }}
      api_key: ${{ secrets.DOKPLOY_API_KEY }}
      type: application
      application_id: ${{ secrets.DOKPLOY_APPLICATION_ID }}

Tip: Github Actions workflow completion is dependent on the wait_for_deployment input. If you set it to true, the workflow will wait for the deployment to complete before marking the job as complete. If you set it to false, the workflow will mark the job as complete as soon as the deployment is triggered.

- name: Deploy Application by ID
  uses: thinesjs/dokploy-deployer-action@v1
  with:
      dokploy_url: ${{ secrets.DOKPLOY_URL }}
      api_key: ${{ secrets.DOKPLOY_API_KEY }}
      type: application
      application_id: ${{ secrets.DOKPLOY_APPLICATION_ID }}
      wait_for_deployment: true

- name: Deploy Compose Project
  uses: thinesjs/dokploy-deployer-action@v1
  with:
      dokploy_url: ${{ secrets.DOKPLOY_URL }}
      api_key: ${{ secrets.DOKPLOY_API_KEY }}
      type: compose
      compose_id: ${{ secrets.DOKPLOY_COMPOSE_ID }}
      wait_for_deployment: true

When wait_for_deployment is enabled, the deployment_status output will contain one of:

• done - Deployment completed successfully
• error - Deployment failed
• timeout - Polling timed out before completion

Add these secrets to your GitHub repository (Settings → Secrets and variables → Actions):

1. API Key: Go to your Dokploy dashboard → Account → Profile → API/CLI Keys
2. Application/Compose ID: Go to your project → Select your app → Copy the ID from the URL (e.g. https://your-dokploy.example.com/dashboard/project/<project-id>/services/application/<application-id>?tab=general)
3. Dokploy URL: Your Dokploy instance base URL (without /api suffix or trailing slash)

When using wait_for_deployment: true, the action polls the Dokploy API repeatedly to check deployment status. Ensure your API key has sufficient rate limits:

• Polling frequency: Every 30 seconds by default (configurable via deployment_check_interval)
• Duration: Up to 20 minutes by default (configurable via deployment_timeout)
• Total API calls: ~40 calls per deployment (20 min ÷ 30 sec)
• Failed retries: Up to 5 additional calls per failure (configurable via max_retries)

If you encounter rate limiting issues:

• Increase deployment_check_interval (e.g., to 60 seconds)
• Check your Dokploy instance API rate limit settings
• Consider using wait_for_deployment: false for fire-and-forget deployments

name: Deploy to Dokploy

on:
    push:
        branches: [master]

jobs:
    deploy:
        runs-on: ubuntu-latest

        steps:
            - name: Deploy Application
              id: deploy
              uses: thinesjs/dokploy-deployer-action@v1
              with:
                  dokploy_url: ${{ secrets.DOKPLOY_URL }}
                  api_key: ${{ secrets.DOKPLOY_API_KEY }}
                  type: application
                  application_id: ${{ secrets.DOKPLOY_APPLICATION_ID }}
                  wait_for_deployment: true
                  deployment_check_interval: 2
                  deployment_timeout: 120

jobs:
    deploy:
        runs-on: ubuntu-latest
        strategy:
            matrix:
                environment: [staging, production]
        steps:
            - name: Deploy to ${{ matrix.environment }}
              uses: thinesjs/dokploy-deployer-action@v1
              with:
                  dokploy_url: ${{ secrets.DOKPLOY_URL }}
                  api_key: ${{ secrets.DOKPLOY_API_KEY }}
                  type: application
                  application_id: ${{ secrets[format('DOKPLOY_APPLICATION_ID_{0}', matrix.environment)] }}
                  wait_for_deployment: true

The action will:

• ✅ Validate inputs before deployment
• 🔄 Retry API calls on network failures (when polling)
• ⏰ Timeout gracefully if deployment takes too long
• 📋 Provide detailed logs for troubleshooting
• ❌ Exit with non-zero code on deployment failures

• Dokploy instance with API access
• Valid API key with deployment permissions

MIT License - see LICENSE file for details.