vidhyasanjeevi/Dokploy Deployment Suite

Automate Dokploy deployments with health checks, rollback, zero-downtime, and comprehensive lifecycle management

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
dokploy-urlThe URL of your Dokploy instance (e.g., https://dokploy.example.com)yes
api-keyAPI key for authenticating with Dokployyes
application-idDokploy application ID to deploy (optional if using project/environment/app names)no""
docker-imageDocker image to deploy (e.g., ghcr.io/user/app:v1.0.0). Required for application deployments, optional for compose deployments.no""
project-idDokploy project ID (optional if using project-name)no""
project-nameDokploy project name (will be created if not exists)no""
project-descriptionDescription for the project (used when creating new project)noAutomated deployment project
environment-idDokploy environment ID (optional if using environment-name)no""
environment-nameDokploy environment name (will be created if not exists)noproduction
application-nameDokploy application name (will be created/updated)no""
server-nameServer name for deployment (e.g., Hostinger-Server1)no""
auto-create-resourcesAutomatically create project/environment/application if they do not existnotrue
wait-for-completionWait for deployment to complete (true/false)notrue
timeoutDeployment timeout in secondsno20
enable-health-checkEnable health check after deployment (true/false)notrue
health-check-pathHealth check endpoint path (e.g., /health or /)no""
health-check-retriesNumber of health check retriesno10
health-check-intervalInterval between health check retries in secondsno6
fail-on-health-check-errorFail the deployment if health check fails (true/false). Set to false to allow manual verification later.notrue
expected-status-codeExpected HTTP status code for health checkno200
cleanup-old-containersCleanup old containers after successful deployment (true/false)nofalse
container-prefixContainer name prefix for cleanup filteringno""
keep-container-countNumber of old containers to keepno1
rollback-on-failureAutomatically rollback on deployment failure (true/false)notrue
memory-limitMaximum memory limit for container in MB (e.g., 512 for 512MB)no""
memory-reservationSoft memory reservation in MB (e.g., 256 for 256MB)no""
cpu-limitMaximum CPU limit (e.g., 1.0 for 1 CPU, 0.5 for half CPU)no""
cpu-reservationCPU reservation/guaranteed allocation (e.g., 0.25 for quarter CPU)no""
restart-policyContainer restart policy: always, unless-stopped, on-failure, nonounless-stopped
container-nameCustom container name. Supports templates: {app} (application name), {version} (image tag/version), {env} (environment name). Example: "{app}-{version}" becomes "myapp-v1.0.0"no""
volumesContainer volume mounts (one per line). Format: /host/path:/container/path or /host/path:/container/path:ro. Example: /var/run/docker.sock:/var/run/docker.sockno""
group-addAdditional groups to add the container user to (comma-separated). Example: "988" for Docker group or "docker,sudo"no""
deployment-typeDeployment type: application (default) or compose. Use "compose" to deploy from docker-compose.yml or Dokploy template.noapplication
compose-filePath to docker-compose.yml file (relative to repository root). Used when deployment-type is "compose".no""
compose-rawRaw docker-compose.yml content as string. Alternative to compose-file. Used when deployment-type is "compose".no""
compose-nameName for the compose deployment. Required when deployment-type is "compose".no""
compose-service-nameService name from docker-compose.yml to expose via domain (e.g., "coder", "web"). Required for multi-service compose files. Defaults to compose-name.no""
dokploy-template-base64Base64-encoded Dokploy template (from templates marketplace). Alternative to compose-file. Used when deployment-type is "compose".no""
replicasNumber of container replicas to run (Docker Swarm)no1
registry-urlDocker registry URL (e.g., ghcr.io)noghcr.io
registry-usernameDocker registry usernameno""
registry-passwordDocker registry password/tokenno""
envEnvironment variables as KEY=VALUE pairs, one per lineno""
env-filePath to .env file with environment variablesno""
env-from-jsonEnvironment variables in JSON format: {"KEY1":"value1","KEY2":"value2"}no""
domain-hostDomain host for the application (e.g., app.example.com)no""
domain-pathDomain path prefix (e.g., /api)no/
application-portContainer port that the application listens on (not the domain port which is always 80/443)no80
domain-httpsEnable HTTPS for domain (true/false)notrue
deployment-strategyDeployment strategy: rolling, recreatenorolling
debug-modeEnable debug logging (true/false)nofalse
namedescription
deployment-idThe deployment ID from Dokploy
deployment-statusThe deployment status (success/failed/timeout)
health-statusHealth check status (healthy/unhealthy/skipped)
containers-cleanedNumber of old containers cleaned up
project-idThe project ID (created or existing)
environment-idThe environment ID (created or existing)
application-idThe application ID (created or updated)