2.5k
GitHub Stars
2
Bundled Files
2 months ago
Catalog Refreshed
4 months ago
First Indexed
Readme & install
Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.
Installation
Preview and clipboard use veilstrat where the catalogue uses aiagentskills.
npx veilstrat add skill openclaw/skills --skill dokploy- _meta.json274 B
- SKILL.md4.2 KB
Overview
This skill manages Dokploy deployments, projects, applications, domains, and environment variables using the Dokploy API. It provides CLI-like commands wrapped for automation and scripting, requiring a Dokploy instance URL and API key. Use it to create, update, delete, and inspect resources and to trigger or monitor deployments programmatically.
How this skill works
The skill talks to the Dokploy REST API at $DOKPLOY_API_URL/api and authenticates with the x-api-key header. It exposes operations for projects, applications, domains, deployments, and env vars, and wraps endpoints such as project.create, application.deploy, deployment.logs, and domain.create. Actions map to synchronous API calls or trigger asynchronous deployments where you poll status or read logs.
When to use it
- Automate creation and configuration of projects and applications
- Trigger and monitor deployments from CI/CD pipelines
- Manage domains and routing for deployed apps
- Backup or audit Dokploy resources across instances
- Set or rotate application environment variables programmatically
Best practices
- Set DOKPLOY_API_URL and DOKPLOY_API_KEY as environment variables for secure automation
- Use the status and deployment endpoints to poll asynchronous operations rather than assuming immediate completion
- Limit API keys to least privilege; some operations require admin rights
- Script JSON parsing with jq or language-native JSON libraries to handle responses robustly
- Include retries and exponential backoff for network or transient API errors
Example use cases
- Create a new project and provision multiple applications with environment variables and domains in one script
- Integrate dokploy deploy triggers into CI pipelines to deploy builds after successful tests
- Collect deployment logs automatically to a centralized logging service for post-deploy diagnostics
- Batch update application settings or rotate secrets across many apps using the env set and update endpoints
- Automate domain provisioning and certificate updates by scripting domain.create and domain.update calls
FAQ
You need a Dokploy API key and the Dokploy instance URL. Provide them via DOKPLOY_API_KEY and DOKPLOY_API_URL environment variables.
How do I check deployment progress?
Trigger a deployment with application.deploy then poll the deployment or status endpoints. Use deployment.logs to stream or fetch logs for troubleshooting.
Are all operations synchronous?
No. Deployments are asynchronous. Many CRUD operations return immediately, but deployment progress must be polled until completion.