README
Join us on Discord for help, feedback, and discussions!
Dokploy is a free, self-hostable Platform as a Service (PaaS) that simplifies the deployment and management of applications and databases.
✨ Features
Dokploy includes multiple features to make your life easier.
- Applications: Deploy any type of application (Node.js, PHP, Python, Go, Ruby, etc.).
- Databases: Create and manage databases with support for MySQL, PostgreSQL, MongoDB, MariaDB, libsql, and Redis.
- Backups: Automate backups for databases to an external storage destination.
- Docker Compose: Native support for Docker Compose to manage complex applications.
- Multi Node: Scale applications to multiple nodes using Docker Swarm to manage the cluster.
- Templates: Deploy open-source templates (Plausible, Pocketbase, Calcom, etc.) with a single click.
- Traefik Integration: Automatically integrates with Traefik for routing and load balancing.
- Real-time Monitoring: Monitor CPU, memory, storage, and network usage for every resource.
- Docker Management: Easily deploy and manage Docker containers.
- CLI/API: Manage your applications and databases using the command line or through the API.
- Notifications: Get notified when your deployments succeed or fail (via Slack, Discord, Telegram, Email, etc.).
- Multi Server: Deploy and manage your applications remotely to external servers.
- Self-Hosted: Self-host Dokploy on your VPS.
🚀 Getting Started
To get started, run the following command on a VPS:
Want to skip the installation process? Try the Dokploy Cloud.
curl -sSL https://dokploy.com/install.sh | bash
For detailed documentation, visit docs.dokploy.com.
Github Sponsors
Contributors 🤝
📺 Video Tutorial
🤝 Contributing
Check out the Contributing Guide for more information.
Extension points exported contracts — how you extend this code
DomainConfig (Interface)
* Domain configuration
packages/server/src/templates/processors.ts
CreateContextOptions (Interface)
* 1. CONTEXT * * This section defines the "contexts" that are available in the backend API. * * These allow you to a
apps/dokploy/server/api/trpc.ts
MountConfig (Interface)
* Mount configuration
packages/server/src/templates/processors.ts
Window (Interface)
(no doc)
apps/dokploy/types/chatwoot.d.ts
TemplateConfig (Interface)
(no doc)
packages/server/src/types/template.ts
Props (Interface)
(no doc)
apps/dokploy/components/layouts/onboarding-layout.tsx
Template (Interface)
(no doc)
packages/server/src/types/template.ts
Props (Interface)
(no doc)
apps/dokploy/components/layouts/side.tsx
Core symbols most depended-on inside this repo
cn
called by 307
apps/dokploy/lib/utils.ts
audit
called by 288
apps/dokploy/server/api/utils/audit.ts
checkServicePermissionAndAccess
called by 198
packages/server/src/services/permission.ts
execAsync
called by 179
packages/server/src/utils/process/execAsync.ts
execAsyncRemote
called by 156
packages/server/src/utils/process/execAsync.ts
withPermission
called by 139
apps/dokploy/server/api/trpc.ts
paths
called by 97
packages/server/src/constants/index.ts
findServerById
called by 83
packages/server/src/services/server.ts
Shape
Function
1,885
Interface
439
Struct
16
Method
14
Class
4
Languages
TypeScript98%
Go2%
Modules by API surface
packages/server/src/utils/docker/utils.ts40 symbols
packages/server/src/utils/traefik/file-types.ts37 symbols
packages/server/src/services/deployment.ts28 symbols
packages/server/src/services/notification.ts27 symbols
packages/server/src/services/user.ts21 symbols
packages/server/src/setup/server-setup.ts20 symbols
packages/server/src/services/docker.ts19 symbols
packages/server/src/services/proprietary/forward-auth.ts16 symbols
packages/server/src/utils/traefik/application.ts15 symbols
packages/server/src/utils/gpu-setup.ts15 symbols
packages/server/src/utils/backups/utils.ts15 symbols
packages/server/src/services/permission.ts15 symbols
Dependencies from manifests, versioned
github.com/andybalholm/brotliv1.1.0 · 1×
github.com/go-ole/go-olev1.2.6 · 1×
github.com/joho/godotenvv1.5.1 · 1×
github.com/lufia/plan9statsv0.0.0-2021101212233 · 1×
github.com/mattn/go-colorablev0.1.13 · 1×
github.com/mattn/go-isattyv0.0.20 · 1×
github.com/mattn/go-runewidthv0.0.16 · 1×
github.com/mattn/go-sqlite3v1.14.24 · 1×
github.com/power-devops/perfstatv0.0.0-2021010621303 · 1×
Datastores touched
(mysql)Database · 1 repos
mydbDatabase · 1 repos
project_dbDatabase · 1 repos
(mongodb)Database · 1 repos
dev_databaseDatabase · 1 repos
dokployDatabase · 1 repos
mockDatabase · 1 repos
service_dbDatabase · 1 repos