dokploy-docs
Dokploy
Dokploy is a stable, easy-to-use, open-source deployment platform designed to simplify application management. A free self-hostable alternative to Heroku, Vercel, and Netlify, leveraging Docker and Traefik.
Quick Start
# Install Dokploy on your VPS (requires ports 80, 443, 3000 free)
curl -sSL https://dokploy.com/install.sh | sh
After installation, open http://your-server-ip:3000 to create your admin account and start deploying.
Installation
# Standard installation
curl -sSL https://dokploy.com/install.sh | sh
# Install specific version
export DOKPLOY_VERSION=v0.26.6 && curl -sSL https://dokploy.com/install.sh | sh
# Update existing installation
curl -sSL https://dokploy.com/install.sh | sh -s update
Documentation
Full documentation in docs/. See docs/000-index.md for detailed navigation.
By Topic
| Topic | Files | Description |
|---|---|---|
| Getting Started | 001-014 | Introduction, architecture, installation, troubleshooting |
| Core Concepts | 014-022 | Applications, databases, Docker Compose, domains, env vars, SSH, registry, certificates |
| Git Integration | 023-028 | GitHub, GitLab, Bitbucket, Gitea, Docker Registry, auto-deploy |
| Registry Providers | 029-031 | Docker Hub, GHCR, Digital Ocean container registry |
| Storage & Backups | 032-038 | S3 destinations, AWS S3, Cloudflare R2, GCS, Backblaze B2, volume backups |
| Notifications | 039-048 | Monitoring, webhook, Telegram, Discord, Slack, email, Pushover, Gotify, Ntfy, Lark |
| Application Management | 049-056 | Build types, advanced config, preview deployments, rollbacks, zero-downtime, production |
| Database Operations | 057-063 | Database backups, restore, connections (MariaDB, MySQL, MongoDB, PostgreSQL) |
| Docker Compose | 064-066 | Examples, utilities, domain configuration |
| Domain Configuration | 067-069 | Generated domains, Cloudflare, other providers |
| Multi-Server | 070-076 | Remote servers, deploy/build servers, validation, security, clustering |
| Framework Tutorials | 077-093 | HTML, Vue.js, Next.js, Astro, Remix, Nest.js, Deno, Preact, Solid.js, Svelte, and more |
| Enterprise | 094-100 | SSO (Auth0, Azure AD, Keycloak, Okta), license keys |
| Guides | 101-103 | EC2 setup, Tailscale VPN, Cloudflare Tunnels |
| Permissions | 104 | User roles and access control |
By Keyword
| Keyword | File |
|---|---|
| deployment | docs/001-docs-core.md |
| architecture | docs/002-docs-core-architecture.md |
| features | docs/003-docs-core-features.md |
| comparison, caprover, dokku, coolify | docs/004-docs-core-comparison.md |
| cloud, multi-server, scalability | docs/005-docs-core-cloud.md |
| installation, vps-setup | docs/008-docs-core-installation.md |
| manual-installation, bash-script | docs/009-docs-core-manual-installation.md |
| uninstall | docs/010-docs-core-uninstall.md |
| password-reset, 2fa | docs/011-docs-core-reset-password.md |
| troubleshooting | docs/012-docs-core-troubleshooting.md |
| applications, deployment-methods | docs/014-docs-core-applications.md |
| databases, database-management | docs/015-docs-core-databases.md |
| docker-compose, docker-stack | docs/016-docs-core-docker-compose.md |
| domains, traefik, https | docs/017-docs-core-domains.md |
| environment-variables, secrets | docs/018-docs-core-variables.md |
| providers, git-integration | docs/019-docs-core-providers.md |
| ssh-keys, private-repositories | docs/020-docs-core-ssh-keys.md |
| docker-registry, image-storage | docs/021-docs-core-registry.md |
| ssl-certificates, certificate-management | docs/022-docs-core-certificates.md |
| github, github-app | docs/023-docs-core-github.md |
| gitlab, webhooks | docs/024-docs-core-gitlab.md |
| bitbucket | docs/025-docs-core-bitbucket.md |
| gitea, oauth2 | docs/026-docs-core-gitea.md |
| docker-hub, ghcr | docs/027-docs-core-Docker.md |
| auto-deploy, api-deployment | docs/028-docs-core-auto-deploy.md |
| s3-destinations, backup-storage | docs/032-docs-core-actions.md |
| aws-s3, iam-policy | docs/033-docs-core-aws-s3.md |
| cloudflare-r2 | docs/034-docs-core-cloudflare-r2.md |
| google-cloud-storage, hmac-keys | docs/035-docs-core-cloud-storage.md |
| backblaze-b2 | docs/036-docs-core-backblaze-b2.md |
| backups, backup-and-restore | docs/037-docs-core-backups.md |
| volume-backups, docker-volumes | docs/038-docs-core-volume-backups.md |
| monitoring, metrics, alert-thresholds | docs/039-docs-core-monitoring.md |
| webhook-notifications | docs/040-docs-core-webhook.md |
| telegram | docs/041-docs-core-telegram.md |
| discord | docs/042-docs-core-discord.md |
| slack | docs/043-docs-core-slack.md |
| email, smtp | docs/044-docs-core-email.md |
| nixpacks, railpack, dockerfile, buildpack | docs/049-docs-core-applications-build-type.md |
| docker-swarm, resource-management, scaling | docs/050-docs-core-applications-advanced.md |
| preview-deployments, pull-requests | docs/051-docs-core-applications-preview-deployments.md |
| rollback, health-checks | docs/052-docs-core-applications-rollbacks.md |
| zero-downtime | docs/053-docs-core-applications-zero-downtime.md |
| ci-cd, github-actions, production | docs/054-docs-core-applications-going-production.md |
| watch-paths, glob-patterns | docs/055-docs-core-watch-paths.md |
| scheduled-jobs, cron | docs/056-docs-core-schedule-jobs.md |
| database-backups, cron-scheduling | docs/057-docs-core-databases-backups.md |
| database-restore | docs/058-docs-core-databases-restore.md |
| database-connection, networking | docs/059-docs-core-databases-connection.md |
| cloudflare, ssl-tls, lets-encrypt | docs/068-docs-core-domains-cloudflare.md |
| remote-servers, build-servers | docs/070-docs-core-remote-servers.md |
| server-security, ufw, fail2ban | docs/074-docs-core-remote-servers-security.md |
| cluster, horizontal-scaling | docs/076-docs-core-cluster.md |
| sso, oidc, saml | docs/096-docs-core-enterprise-sso.md |
| permissions, rbac, user-roles | docs/104-docs-core-permissions.md |
| ec2, aws | docs/101-docs-core-guides-ec2-instructions.md |
| tailscale, vpn, wireguard | docs/102-docs-core-guides-tailscale.md |
| cloudflare-tunnel, zero-trust | docs/103-docs-core-guides-cloudflare-tunnels.md |
Learning Path
- Foundation: Read 001-007 (intro/overview), then 008-014 (installation/setup)
- Core Understanding: Learn core concepts 014-022, configure providers 019-028
- Practical Application: Set up backups 032-038, notifications 039-048, follow framework tutorials 077-093
- Advanced Usage: Application management 049-056, multi-server 070-076, Docker Compose 064-066
- Enterprise: Enterprise features 094-100, permissions 104, guides 101-103
Common Tasks
Install Dokploy on a VPS
-> docs/008-docs-core-installation.md (step-by-step VPS installation guide)
Deploy an Application from Git
-> docs/014-docs-core-applications.md (deployment methods overview)
-> docs/023-docs-core-github.md (GitHub integration setup)
Configure a Custom Domain with SSL
-> docs/017-docs-core-domains.md (domain configuration and HTTPS)
-> docs/022-docs-core-certificates.md (SSL/TLS certificate management)
-> docs/068-docs-core-domains-cloudflare.md (Cloudflare-specific setup)
Set Up Database with Backups
-> docs/015-docs-core-databases.md (create and manage databases)
-> docs/057-docs-core-databases-backups.md (scheduled S3 backups)
-> docs/058-docs-core-databases-restore.md (restore from backups)
Deploy Docker Compose Application
-> docs/016-docs-core-docker-compose.md (Docker Compose with Dokploy)
-> docs/064-docs-core-docker-compose-example.md (full deployment tutorial)
-> docs/066-docs-core-docker-compose-domains.md (domain config for Compose)
Configure Notifications
-> docs/039-docs-core-monitoring.md (monitoring setup)
-> docs/041-docs-core-telegram.md through docs/048-docs-core-lark.md (notification providers)
Set Up Multi-Server / Cluster
-> docs/070-docs-core-remote-servers.md (remote server overview)
-> docs/076-docs-core-cluster.md (Docker Swarm clustering and scaling)
Configure CI/CD Auto-Deploy
-> docs/028-docs-core-auto-deploy.md (webhook and API auto-deploy)
-> docs/054-docs-core-applications-going-production.md (CI/CD optimization)
Troubleshoot Common Issues
-> docs/012-docs-core-troubleshooting.md (domain, port, volume, routing issues)
Secure Your Server
-> docs/074-docs-core-remote-servers-security.md (firewall, SSH hardening, Fail2Ban)