# Dokploy Documentation

> Dokploy is an open-source, self-hostable Platform as a Service (PaaS) that simplifies the deployment and management of applications, databases, and services.

## Docs

- [Application](https://docs.dokploy.com/docs/cli/application): A guide to using the Dokploy CLI to manage applications
- [Authentication](https://docs.dokploy.com/docs/cli/authentication): A guide to authenticating with the Dokploy CLI
- [Databases](https://docs.dokploy.com/docs/cli/databases): A guide to using the Dokploy CLI to manage databases
- [Enviroment](https://docs.dokploy.com/docs/cli/enviroment): A guide to using the Dokploy CLI to manage enviroment
- [Introduction](https://docs.dokploy.com/docs/cli): A guide to using the Dokploy command-line interface
- [Project](https://docs.dokploy.com/docs/cli/project): A guide to using the Dokploy CLI to manage projects
- [Dokploy API](https://docs.dokploy.com/docs/api): How to interact with the dokploy API for administrators and users
- [Account Security](https://docs.dokploy.com/docs/core/account-security): Protect your Dokploy account with passkeys (WebAuthn) and two-factor authentication.
- [AI Assistant](https://docs.dokploy.com/docs/core/ai): Use AI to generate Docker Compose templates in Dokploy.
- [Architecture of Dokploy](https://docs.dokploy.com/docs/core/architecture): Overview of the core architecture components of Dokploy.
- [Auto Deploy](https://docs.dokploy.com/docs/core/auto-deploy): Automatically deploying your application to Dokploy can be achieved through two primary methods using Webhooks or the Dokploy API. Each method supports various platforms and provides a streamlined deployment process.
- [Backups](https://docs.dokploy.com/docs/core/backups): Learn how to create and restore backups of your Dokploy applications and services.
- [Certificates](https://docs.dokploy.com/docs/core/certificates): Configure your certificates to secure your applications.
- [Dokploy Cloud](https://docs.dokploy.com/docs/core/cloud): Deploy your apps to multiple servers remotely without worrying about the underlying infrastructure.
- [Cluster](https://docs.dokploy.com/docs/core/cluster): Manage server cluster settings.
- [Comparison](https://docs.dokploy.com/docs/core/comparison): A comparison of Dokploy, CapRover, Dokku, and Coolify
- [Concurrent Builds](https://docs.dokploy.com/docs/core/concurrent-builds): Learn how Dokploy manages build/deployment concurrency per server and how to configure it.
- [Deployment Options](https://docs.dokploy.com/docs/core/deployment-options): Dokploy Server vs Remote Servers vs Swarm Nodes: choose where your applications run.
- [Cloud vs Self-Hosted](https://docs.dokploy.com/docs/core/differences): Detailed comparison between Dokploy Cloud and the Self-Hosted version.
- [Features](https://docs.dokploy.com/docs/core/features): Explore the comprehensive suite of features available in Dokploy for optimized application deployment and management.
- [Goodies](https://docs.dokploy.com/docs/core/goodies): Dokploy has certain goodies that are external that can be used with Dokploy.
- [Welcome to Dokploy](https://docs.dokploy.com/docs/core): Dokploy is a open source alternative to Heroku, Vercel, and Netlify.
- [Installation](https://docs.dokploy.com/docs/core/installation): Get Dokploy up and running on your server within minutes with this easy-to-follow installation guide.
- [Interface Overview](https://docs.dokploy.com/docs/core/interface-overview): A visual tour of the Dokploy dashboard — screenshots of every major section of the panel.
- [Manual Installation](https://docs.dokploy.com/docs/core/manual-installation): Learn how to manually install Dokploy on your server.
- [Monitoring](https://docs.dokploy.com/docs/core/monitoring): Monitor your applications and servers with Dokploy
- [Multi-Tenancy](https://docs.dokploy.com/docs/core/multi-tenancy): Understand how Dokploy organizes resources using Organizations, Projects, Environments, and Services for team collaboration and resource isolation.
- [Patches](https://docs.dokploy.com/docs/core/patches): Apply code patches to your repository during build to modify configs, env, or code
- [Providers](https://docs.dokploy.com/docs/core/providers): Learn how to use providers in your application or docker compose.
- [Reset Password & 2FA](https://docs.dokploy.com/docs/core/reset-password): Reset your password to access your Dokploy account and disable 2FA.
- [Schedule Jobs](https://docs.dokploy.com/docs/core/schedule-jobs): Learn how to automate tasks using Dokploy's Schedule Jobs feature
- [SSH Keys](https://docs.dokploy.com/docs/core/ssh-keys): Configure your SSH keys to access your servers or clone Private Repositories.
- [Uninstall](https://docs.dokploy.com/docs/core/uninstall): Learn how to uninstall Dokploy on your server
- [Environment Variables](https://docs.dokploy.com/docs/core/variables): Dokploy allows you to create and manage shared and service-level environment variables for your projects and environments.
- [Videos](https://docs.dokploy.com/docs/core/videos): Videos about how to install and use Dokploy.
- [Volume Backups](https://docs.dokploy.com/docs/core/volume-backups): Learn how to backup your volumes using Dokploy's Volume Backups feature
- [Watch Paths](https://docs.dokploy.com/docs/core/watch-paths): Learn how to use watch paths in your application or docker compose.
- [Docker Registry](https://docs.dokploy.com/docs/core/Docker): Configure your Docker Registry repositories for deployments. This includes setting up access tokens, repository names, and authentication.
- [Bitbucket](https://docs.dokploy.com/docs/core/bitbucket): Configure your Bitbucket repositories for deployments. This includes setting up access tokens, repository names, and branches.
- [Gitea](https://docs.dokploy.com/docs/core/gitea): Configure Gitea repositories for deployments. This includes setting up access tokens, repository names, and branches.
- [GitHub](https://docs.dokploy.com/docs/core/github): Configure GitHub repositories for deployments. This includes setting up access tokens, repository names, and branches.
- [Gitlab](https://docs.dokploy.com/docs/core/gitlab): Configure Gitlab repositories for deployments. This includes setting up access tokens, repository names, and branches.
- [Actions](https://docs.dokploy.com/docs/core/actions): Manage S3 destinations.
- [AWS S3](https://docs.dokploy.com/docs/core/aws-s3): Configure S3 buckets for backup storage. This includes setting up access keys, secret keys, bucket names, regions, and endpoints.
- [Backblaze B2](https://docs.dokploy.com/docs/core/backblaze-b2): Configure buckets from Backblaze B2 for backup storage. This includes setting up access keys, secret keys, bucket names, regions, and endpoints.
- [Google Cloud Storage](https://docs.dokploy.com/docs/core/cloud-storage): Configure Google Cloud Storage buckets for backup storage. This includes setting up access keys, secret keys, bucket names, regions, and endpoints.
- [Cloudflare R2](https://docs.dokploy.com/docs/core/cloudflare-r2): Configure R2 buckets for backup storage. This includes setting up access keys, secret keys, bucket names, regions, and endpoints.
- [Discord](https://docs.dokploy.com/docs/core/discord): Configure discord notifications for your applications.
- [Email](https://docs.dokploy.com/docs/core/email): Configure email notifications for your applications.
- [Gotify](https://docs.dokploy.com/docs/core/gotify): Configure gotify notifications for your applications.
- [Lark](https://docs.dokploy.com/docs/core/lark): Configure Lark notifications for your applications.
- [Mattermost](https://docs.dokploy.com/docs/core/mattermost): Configure mattermost notifications for your applications.
- [Ntfy](https://docs.dokploy.com/docs/core/ntfy): Configure ntfy notifications for your applications.
- [Overview](https://docs.dokploy.com/docs/core/overview): Configure general notifications for your applications and services.
- [Pushover](https://docs.dokploy.com/docs/core/pushover): Configure Pushover notifications for your applications.
- [Resend](https://docs.dokploy.com/docs/core/resend): Configure Resend notifications for your applications.
- [Slack](https://docs.dokploy.com/docs/core/slack): Configure slack notifications for your applications.
- [Microsoft Teams](https://docs.dokploy.com/docs/core/teams): Configure Microsoft Teams notifications for your applications.
- [Telegram](https://docs.dokploy.com/docs/core/telegram): Configure telegram notifications for your applications.
- [Webhook](https://docs.dokploy.com/docs/core/webhook): Configure webhook notifications for your applications.
- [Permissions](https://docs.dokploy.com/docs/core/permissions): Add permissions to your users to manage your applications and services.
- [11ty](https://docs.dokploy.com/docs/core/11ty): Deploy a simple 11ty application.
- [Astro SSR](https://docs.dokploy.com/docs/core/astro-ssr): Deploy a simple Astro SSR application.
- [Astro](https://docs.dokploy.com/docs/core/astro): Deploy a simple Astro application.
- [Deno](https://docs.dokploy.com/docs/core/deno): Deploy a simple Deno application.
- [HTML](https://docs.dokploy.com/docs/core/html): Deploy a simple HTML application.
- [Lit](https://docs.dokploy.com/docs/core/lit): Deploy a simple Lit application.
- [Nest.js](https://docs.dokploy.com/docs/core/nestjs): Deploy a simple Nest.js application.
- [Next.js](https://docs.dokploy.com/docs/core/nextjs): Deploy a simple Next.js application.
- [Preact](https://docs.dokploy.com/docs/core/preact): Deploy a simple Preact application.
- [Qwik](https://docs.dokploy.com/docs/core/qwik): Deploy a simple Qwik application.
- [Remix](https://docs.dokploy.com/docs/core/remix): Deploy a simple Remix application.
- [Solid.js](https://docs.dokploy.com/docs/core/solidjs): Deploy a simple Solid.js application.
- [Svelte](https://docs.dokploy.com/docs/core/svelte): Deploy a simple Svelte application.
- [Tanstack](https://docs.dokploy.com/docs/core/tanstack): Deploy a simple Tanstack application.
- [Turborepo](https://docs.dokploy.com/docs/core/turborepo): Deploy a simple Turborepo application.
- [Vite React](https://docs.dokploy.com/docs/core/vite-react): Deploy a simple Vite React application.
- [Vue.js](https://docs.dokploy.com/docs/core/vuejs): Deploy a simple Vue.js application.
- [Advanced](https://docs.dokploy.com/docs/core/applications/advanced): Learn how to use advanced features in your application.
- [Build Type](https://docs.dokploy.com/docs/core/applications/build-type): Learn about the different build types available in Dokploy, including Nixpacks, Dockerfile, and Buildpack options.
- [Going Production](https://docs.dokploy.com/docs/core/applications/going-production): Learn how to deploy your application in production in Dokploy.
- [Applications](https://docs.dokploy.com/docs/core/applications): Explore the multiple deployment methods available in Dokploy, including GitHub, Git, Docker, and automated deployments via webhooks.
- [Preview Deployments](https://docs.dokploy.com/docs/core/applications/preview-deployments): Preview deployments allow you to test and review your application changes in an isolated environment before merging to production.
- [Rollbacks](https://docs.dokploy.com/docs/core/applications/rollbacks): Learn how to rollback your application in Dokploy.
- [Zero Downtime](https://docs.dokploy.com/docs/core/applications/zero-downtime): Learn how to configure zero downtime deployments in Dokploy.
- [Backups](https://docs.dokploy.com/docs/core/databases/backups): Learn how to schedule and manage backups for your databases in Dokploy, with options for storage in S3 buckets.
- [Databases](https://docs.dokploy.com/docs/core/databases): Discover how to create and backup databases easily with Dokploy, supporting a variety of database systems.
- [Restore](https://docs.dokploy.com/docs/core/databases/restore): Learn how to restore your databases in Dokploy, with options for restoring from S3 buckets.
- [Cloudflare](https://docs.dokploy.com/docs/core/dns-providers/cloudflare): Connect Cloudflare to create A/CNAME records for your domains from Dokploy.
- [DNS Providers](https://docs.dokploy.com/docs/core/dns-providers): Connect Cloudflare or AWS Route53 to create and manage A/CNAME records for your domains without leaving Dokploy.
- [AWS Route53](https://docs.dokploy.com/docs/core/dns-providers/route53): Connect AWS Route53 to create A/CNAME records for your domains from Dokploy.
- [Domains](https://docs.dokploy.com/docs/core/docker-compose/domains): Configure domains for your Docker Compose application.
- [Example](https://docs.dokploy.com/docs/core/docker-compose/example): Learn how to use Docker Compose with Dokploy
- [Docker Compose](https://docs.dokploy.com/docs/core/docker-compose): Learn how to use Docker Compose with Dokploy
- [Utilities](https://docs.dokploy.com/docs/core/docker-compose/utilities): Utilities for your Docker Compose application
- [Cloudflare](https://docs.dokploy.com/docs/core/domains/cloudflare): This guide will cover how to configure a Cloudflare domain for your applications in dokploy or panel.
- [Generated](https://docs.dokploy.com/docs/core/domains/generated): This section outlines how to configure free HTTP domains for your applications in Dokploy, ensuring that your applications are accessible via custom URLs.
- [Domains](https://docs.dokploy.com/docs/core/domains): This section outlines how to configure domains for your applications in Dokploy, ensuring that your applications are accessible via custom URLs.
- [Others](https://docs.dokploy.com/docs/core/domains/others): This guide will cover how to configure a domain from other providers for your applications in dokploy or panel.
- [Audit Logs](https://docs.dokploy.com/docs/core/enterprise/audit-logs): Track all actions performed by members in your organization
- [Custom Roles](https://docs.dokploy.com/docs/core/enterprise/custom-roles): Create custom roles with granular permissions for your organization members
- [Introduction](https://docs.dokploy.com/docs/core/enterprise): Enterprise features for SSO, SCIM provisioning, application authentication, custom roles, audit logs, and whitelabeling
- [License Keys](https://docs.dokploy.com/docs/core/enterprise/license-keys): Activate and manage your Enterprise license
- [SCIM Provisioning](https://docs.dokploy.com/docs/core/enterprise/scim): Automatically provision, update, and deactivate users from your identity provider with SCIM 2.0
- [Whitelabeling](https://docs.dokploy.com/docs/core/enterprise/whitelabeling): Rebrand Dokploy with your application name, logos, colors, and custom links
- [Cloudflare Tunnels](https://docs.dokploy.com/docs/core/guides/cloudflare-tunnels): Learn how to use Cloudflare Tunnels to securely expose your Dokploy applications without opening ports on your server.
- [Tailscale](https://docs.dokploy.com/docs/core/guides/tailscale): Learn how to use Tailscale to securely access your Dokploy applications and servers through a private network without opening ports.
- [Digital Ocean](https://docs.dokploy.com/docs/core/registry/digital-ocean): Configure a Digital Ocean Container Registry to store your images and artifacts.
- [Docker Hub](https://docs.dokploy.com/docs/core/registry/dockerhub): Configure Docker Hub to store your images and artifacts.
- [GHCR](https://docs.dokploy.com/docs/core/registry/ghcr): Configure GitHub Container Registry to store your images and artifacts.
- [Registry](https://docs.dokploy.com/docs/core/registry): Configure your registry settings to store your images and artifacts.
- [AWS Secrets Manager](https://docs.dokploy.com/docs/core/secrets-providers/aws): Use AWS Secrets Manager secrets in your Dokploy environment variables.
- [Azure Key Vault](https://docs.dokploy.com/docs/core/secrets-providers/azure): Use Azure Key Vault secrets in your Dokploy environment variables.
- [Doppler](https://docs.dokploy.com/docs/core/secrets-providers/doppler): Use Doppler secrets in your Dokploy environment variables.
- [HashiCorp Vault / OpenBao](https://docs.dokploy.com/docs/core/secrets-providers/hashicorp): Use HashiCorp Vault or OpenBao KV v2 secrets in your Dokploy environment variables.
- [Secrets Providers](https://docs.dokploy.com/docs/core/secrets-providers): Reference secrets from external secret managers (HashiCorp Vault, OpenBao, Infisical, AWS Secrets Manager, Doppler, Azure Key Vault, Scaleway Secret Manager) directly in your environment variables.
- [Infisical](https://docs.dokploy.com/docs/core/secrets-providers/infisical): Use Infisical secrets (cloud or self-hosted) in your Dokploy environment variables.
- [Scaleway Secret Manager](https://docs.dokploy.com/docs/core/secrets-providers/scaleway): Use Scaleway Secret Manager secrets in your Dokploy environment variables.
- [Build Server](https://docs.dokploy.com/docs/core/remote-servers/build-server): Learn how to configure a custom build server to compile your applications separately from your deployment servers.
- [Deployments](https://docs.dokploy.com/docs/core/remote-servers/deployments): Configure and set up your remote server deployment
- [Introduction](https://docs.dokploy.com/docs/core/remote-servers): Deploy your apps to multiple servers remotely.
- [Deploy Server](https://docs.dokploy.com/docs/core/remote-servers/instructions): Step-by-step guide to setup a remote server and deploy applications on a VPS.
- [Security](https://docs.dokploy.com/docs/core/remote-servers/security): Security features of Dokploy
- [Validate](https://docs.dokploy.com/docs/core/remote-servers/validate): Validate your remote server deployment
- [Domains & Traefik](https://docs.dokploy.com/docs/core/troubleshooting/domains): Fix domains that aren't working, 404 errors, Bad Gateway errors, and Traefik routing issues.
- [Troubleshooting](https://docs.dokploy.com/docs/core/troubleshooting): Solve the most common problems that occur when using Dokploy.
- [Dokploy Instance](https://docs.dokploy.com/docs/core/troubleshooting/instance): Fix a Dokploy UI that isn't accessible and recreate the core Dokploy services.
- [Logs & Monitoring](https://docs.dokploy.com/docs/core/troubleshooting/logs-monitoring): Fix logs and monitoring that aren't loading on worker nodes or remote servers.
- [Networking & DNS](https://docs.dokploy.com/docs/core/troubleshooting/networking): Fix Docker Swarm initialization, service connectivity, DNS resolution, and network address pool issues.
- [Volumes & Mounts](https://docs.dokploy.com/docs/core/troubleshooting/volumes-mounts): Fix issues with Docker Compose volumes, file mounts, and files from your repository.
- [Connection](https://docs.dokploy.com/docs/core/databases/connection): Learn how to connect to your database using Dokploy.
- [MariaDB](https://docs.dokploy.com/docs/core/databases/connection/mariadb): This guide will cover how to connect from Beekeeper Studio to your mariadb databases in dokploy.
- [Mongo Compass](https://docs.dokploy.com/docs/core/databases/connection/mongo-atlas): This guide will cover how to configure a Mongo Compass connection for your applications in dokploy or panel.
- [MySQL](https://docs.dokploy.com/docs/core/databases/connection/mysql): This guide will cover how to connect from Beekeeper Studio to your mysql databases in dokploy.
- [PG Admin](https://docs.dokploy.com/docs/core/databases/connection/pg-admin): This guide will cover how to connect from pgAdmin to your postgres databases in dokploy.
- [Redis](https://docs.dokploy.com/docs/core/databases/connection/redis): This guide will cover how to connect from RedisInsight to your redis databases in dokploy.
- [Application Authentication (Forward Auth)](https://docs.dokploy.com/docs/core/enterprise/sso/application-authentication): Protect deployed applications behind an SSO login gate, powered by oauth2-proxy and Traefik forward-auth
- [Auth0](https://docs.dokploy.com/docs/core/enterprise/sso/auth0): Configure SSO with Auth0 (OIDC or SAML)
- [Azure AD (Microsoft Entra ID)](https://docs.dokploy.com/docs/core/enterprise/sso/azure): Configure SSO with Azure AD / Microsoft Entra ID (OIDC or SAML)
- [Single Sign-On (SSO)](https://docs.dokploy.com/docs/core/enterprise/sso): Configure SSO with Auth0, Keycloak, or other OIDC/SAML providers
- [Keycloak](https://docs.dokploy.com/docs/core/enterprise/sso/keycloak): Configure SSO with Keycloak
- [Okta](https://docs.dokploy.com/docs/core/enterprise/sso/okta): Configure SSO with Okta (OIDC or SAML)
- [Zitadel](https://docs.dokploy.com/docs/core/enterprise/sso/zitadel): Configure SSO with Zitadel

## API Reference

- [OpenAPI Specification](https://docs.dokploy.com/openapi.json): Complete API reference in OpenAPI format

## Full Documentation

- [llms-full.txt](https://docs.dokploy.com/llms-full.txt): All documentation pages as plain text