Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nayalsaurav/deploy-your-app/llms.txt

Use this file to discover all available pages before exploring further.

Deploy Your App is an open-source, self-hostable deployment platform that connects to your GitHub repositories and handles the entire pipeline — from detecting your framework to building a Docker image, running containers, and routing traffic. Ship Next.js, Vite, and Node.js applications to your own infrastructure in seconds.

Quickstart

Connect your GitHub repo and deploy your first app in under 5 minutes.

Self-Hosting

Run the full platform on your own infrastructure with Docker Compose.

Architecture

Understand the microservices, queues, and proxy that power every deployment.

API Reference

Explore the REST API to manage projects and trigger deployments programmatically.

How It Works

Deploy Your App runs as a set of cooperating microservices. You push code to GitHub, a webhook fires, and the platform takes over — cloning, building, and routing your app automatically.
1

Connect Your Repository

Sign in with GitHub OAuth. The platform lists your repositories and lets you import any of them as a project. A webhook is automatically registered to track future pushes.
2

Auto-Detect & Build

The builder service inspects your package.json to detect whether you’re running Next.js, Vite, or Node.js, selects the correct Dockerfile template, and builds a Docker image.
3

Deploy & Route

Dynamic apps run as isolated Docker containers. Static sites (Vite builds) are uploaded to Cloudflare R2 and served via CDN. The reverse proxy routes every subdomain and custom domain to the right destination.
4

Monitor in Real Time

Watch build output stream live in the dashboard. Every deployment records its status (PENDINGCLONINGBUILDINGSUCCESS / FAILED), logs, and completion time.

Key Features

Zero-Config Detection

Automatically identifies Next.js, Vite, and Node.js projects from package.json — no deploy.yml required.

Docker Isolation

Every app runs in its own container. No shared processes, no port conflicts, clean teardown on redeploy.

Hybrid Engine

Static assets go to Cloudflare R2 for edge delivery. Dynamic apps stay as long-running containers behind the proxy.

Encrypted Env Vars

Environment variables are AES-encrypted at rest with a master key. Secrets are never stored in plaintext.

Custom Domains

Point any domain at your deployment with CNAME verification. TLS is handled automatically by Caddy.

Multi-Channel Alerts

Get notified via Email (Resend), Slack, Discord, or WhatsApp (Twilio) when deployments succeed or fail.

Explore the Docs

Import a Project

Step-by-step guide to importing a GitHub repository and configuring your first deployment.

Environment Variables

Manage secrets and configuration values securely for each project.

Custom Domains

Configure a custom domain and verify DNS ownership with CNAME records.

Build Configuration

Override auto-detected build and start commands for advanced setups.

Build docs developers (and LLMs) love