llms.txt
Compare with other sites' llms.txt files →# QuickStack
> QuickStack is a free, GPL-3.0, self-hosted PaaS for deploying and operating containerized applications (from GitHub, Gitlab, Bitbucket and other Git providers) and databases on infrastructure you control. It provides a web UI and REST API.
QuickStack builds applications from Git or deploys container images directly (using a Dockerfile, Railpack or easy deploy feature for Next.JS, Nuxt, React, Angular, SvelteKit and Astro), provisions domains and automatic HTTPS, and provides networking, storage, backups, observability, and access control in one platform. It runs on a single server by default and can grow into a multi-node cluster with distributed (and replicated) storage across the cluster.
## Start here
- [Installation](https://quickstack.dev/docs/tutorials/installation): install on a fresh Ubuntu 24.04+ or Debian 13+ server.
- [First app from Git](https://quickstack.dev/docs/tutorials/first-app-from-git): connect a repository, select a build method, and deploy it.
- [First app from image](https://quickstack.dev/docs/tutorials/first-app-from-image): deploy an existing image from a container registry.
- [Project Canvas & App Drawer](https://quickstack.dev/docs/how-to/project-canvas): create, configure, deploy, and monitor workloads from a project's central view.
- [App & Database Templates](https://quickstack.dev/docs/how-to/templates): deploy preconfigured applications and databases in a few clicks.
## Platform model
- A project contains apps, databases, and, on the canary channel, Agent Sandboxes.
- Git-source apps are built with Framework builds, Railpack, or a Dockerfile through BuildKit, then stored in the internal registry. Image-source apps and templates pull their images directly.
- Clicking **Deploy** applies the saved configuration and performs a Kubernetes rolling update. Settings are staged until deployment.
- Traefik routes HTTP(S) traffic and obtains Let's Encrypt certificates. Internal workload networking is deny-by-default; node ports expose non-HTTP services.
- App data uses Kubernetes volumes: local-path on single-node installs and Longhorn for distributed multi-node storage. Backups target S3-compatible object storage.
- QuickStack stores its control-plane configuration in SQLite and backs it up separately from application data.
## Key concepts and operations
- [Architecture](https://quickstack.dev/docs/concepts/architecture): k3s, Traefik, Longhorn, BuildKit, Railpack, registry, data locations, and the deployment pipeline.
- [Projects, Apps & Databases](https://quickstack.dev/docs/concepts/projects-apps-databases): QuickStack's workload and ownership model.
- [Security Model](https://quickstack.dev/docs/concepts/security-model): access control, workload isolation, TLS, and data residency.
- [Deployments](https://quickstack.dev/docs/how-to/deployments/build-methods): build methods, container configuration, redeploys, rollbacks, scaling, and webhooks.
- [Networking](https://quickstack.dev/docs/how-to/networking): domains, quickstack.me subdomains, policies, basic auth, and node ports.
- [Storage](https://quickstack.dev/docs/how-to/storage/volumes): volumes, shared volumes, file browser, and file mounts.
- [Backups](https://quickstack.dev/docs/how-to/backups/overview): S3 targets plus volume, database, system, download, and restore workflows.
- [Administration](https://quickstack.dev/docs/how-to/admin/updates-and-maintenance): cluster add-ons and monitoring, nodes, users and groups, SSO, 2FA, updates, and password resets.
## Automation and experimental features
- [REST API & SDK](https://quickstack.dev/docs/rest-api/overview): automate projects and app workloads with API keys and the JavaScript/TypeScript SDK.
- [MCP Server (Canary)](https://quickstack.dev/docs/mcp-server): connect AI clients through the Model Context Protocol.
- [Agent Sandbox (Canary)](https://quickstack.dev/docs/how-to/agents): run isolated Agent Sandbox instances, optionally with gVisor and an LLM Gateway. These features require the canary channel and should be treated as experimental.
## Planning
- [Sizing & Costs](https://quickstack.dev/docs/reference/sizing-and-costs): minimum server requirements, workload sizing, storage, high availability, and cost guidance.
- [Why QuickStack?](https://quickstack.dev/docs/reference/comparison): comparison with managed platforms, self-hosted PaaS tools, and raw Kubernetes.
# Features
## Deploy
Get apps running without manual container orchestration.
- Deploy from any Git repository (public or private)
- Deploy from any container registry
- One-click database deployments from templates
- Automatic domain setup and HTTPS via Let's Encrypt
- Webhook-triggered auto-deploys on push
## Operate
See what is running and fix problems without SSH gymnastics.
- Real-time log streaming per container
- Integrated web terminal for direct container access
- CPU, RAM, and disk metrics per app
- Health checks and restart policies
- Scheduled backups
## Scale
Grow from a single VPS to a multi-node cluster without rearchitecting.
- Add nodes to form a cluster at any time
- Cluster-wide persistent storage volumes (Longhorn)
- Automatic load balancing across nodes
- quickstack.me instant subdomains for fast preview access
- Internal service networking between apps
## Secure
Control who can access what, down to the project level.
- User and group management
- Granular per-project permissions
- Two-factor authentication (2FA)
- Network policies to isolate services
- Basic authentication for exposed endpoints
# How It Works
### 01. Install on a fresh server
One command sets up the whole platform on your VPS or bare-metal box.
```bash
curl -sfL https://get.quickstack.dev/setup.sh | sh -
```
### 02. Connect a repo or image
Point QuickStack at any Git repository, or pull from Docker Hub and private registries. Pick a database template for one-click Postgres, MySQL, MongoDB, MariaDB or Redis.
### 03. Deploy — the rest is handled
QuickStack builds, provisions a domain, issues HTTPS, starts the container and gives you logs, terminal, metrics and backups in the same UI.
# Use Cases
### Agencies & small teams
Give everyone a shared platform with per-project and per-app permissions. Ship staging and production for each client and hand over a clean dashboard.
Tags: Users & groups, Per-app access, Multi-server
### Self-hosters & automation builders
Deploy WordPress, n8n, Nextcloud, Gitea and databases from templates, with automatic TLS and a network graph that shows what talks to what — no terminal required.
Tags: Templates, Auto SSL, Web UI
### Indie hackers & solo builders
Run a portfolio of apps and databases on one VPS. Git-push deploys, automatic HTTPS and backups — at a fixed server cost, no per-request surprises.
Tags: Git deploy, Low cost, Backups
### Regulated teams that need data ownership
Keep applications, databases and backups on infrastructure you control, in your jurisdiction — with SSO, 2FA and per-project access for compliance reviews.
Tags: Self-hosted, Data ownership, SSO
# Frequently Asked Questions
**Do I need Kubernetes knowledge to use QuickStack?**
No. QuickStack runs on k3s under the hood, but you interact entirely through a web UI. You do not write Kubernetes manifests or run kubectl commands for day-to-day operations.
**Can I deploy from Git repositories and Docker images from Docker Hub?**
Yes. QuickStack supports both. You can connect a Git repository (GitHub, GitLab, or any other Git host) and trigger builds on push via webhooks, or you can pull an image directly from Docker Hub or a private container registry.
**Does QuickStack handle HTTPS automatically?**
Yes. QuickStack provisions SSL certificates via Let's Encrypt automatically when you add a domain. You do not need to configure Traefik, Nginx, or Certbot manually.
**Can I run databases?**
Yes. QuickStack includes database templates for PostgreSQL, MySQL, Redis, and others. You can deploy a database instance with one click and connect it to your apps using internal service networking.
**How do backups work?**
QuickStack supports scheduled backups for both application volumes and databases. Backups can be stored on S3-compatible object storage. You can restore from any backup directly through the UI.
**Is QuickStack suitable for teams?**
Yes. QuickStack includes user and group management with granular per-project permissions, and supports two-factor authentication. You can give team members access to specific projects without giving them full admin access.
**Can I start on one server and scale to a cluster later?**
Yes. QuickStack runs on a single server and supports adding nodes to form a multi-node cluster. Persistent storage volumes are managed by Longhorn and are accessible across all nodes in the cluster.
**Is QuickStack open source?**
Yes. QuickStack is open source and available on GitHub. It is licensed under the GPL-3.0 license. Contributions and feedback are welcome!
# Docs
- **Docs**
- [QuickStack Docs](/docs): QuickStack is a free, open-source, self-hosted PaaS for deploying apps, and databases on any server infrastructure, manages domains via Traefik, SSL Certificates, provides backups, monitoring, and more.
- Tutorials: undefined
- [QuickStack Installation](/docs/tutorials/installation): QuickStack installation: fastest path to a working QuickStack instance.
- [Deploy Your First App from Git](/docs/tutorials/first-app-from-git): Deploy an application directly from a Git repository using QuickStack.
- [Deploy Your First App from a Docker Image](/docs/tutorials/first-app-from-image): Deploy a Docker image from Docker Hub or any container registry using QuickStack.
- [Expose an App (Domain + HTTPS)](/docs/tutorials/expose-app): Add a custom domain and enable HTTPS for your QuickStack application.
- Concepts: undefined
- [Architecture](/docs/concepts/architecture): How QuickStack works under the hood: k3s, Traefik, Longhorn, BuildKit, Railpack, the internal registry, and the deploy pipeline.
- [Projects, Apps & Databases](/docs/concepts/projects-apps-databases): Understand the QuickStack object model: projects, apps, databases, Agent Sandboxes, sources, deployment state, and where each setting lives.
- [Security Model](/docs/concepts/security-model): How QuickStack isolates workloads and controls access: deny-by-default networking, RBAC, authentication, TLS, and data residency.
- How To: undefined
- [Project Canvas & App Drawer](/docs/how-to/project-canvas): Use the Project Canvas to see apps, databases, and connections at a glance, and create, configure, deploy, and monitor every app from its details drawer.
- [App & Database Templates](/docs/how-to/templates): Deploy one-click apps and databases from QuickStack templates: WordPress, Nextcloud, n8n, Gitea, LiteLLM, PostgreSQL, and more.
- Deployments: undefined
- [Deploy & Redeploy](/docs/how-to/deployments/redeploy-and-rollbacks): How deployment works in QuickStack: when changes take effect, environment variables, and common gotchas.
- [Build Methods](/docs/how-to/deployments/build-methods): Choose between Framework presets, Railpack (zero-config, auto-detect) and Dockerfile build methods for Git-based apps in QuickStack.
- [Webhooks & Auto-deploy](/docs/how-to/deployments/webhooks-auto-deploy): Configure webhooks to trigger automatic deployments from GitHub, GitLab, or any CI system.
- [Container Configuration](/docs/how-to/deployments/container-configuration): Override the container command and arguments and configure the security context for a QuickStack app.
- [Scaling & Resource Limits](/docs/how-to/deployments/scaling): Set replica count, CPU and memory reservations and limits per app in QuickStack.
- Networking: undefined
- [Networking & Policies](/docs/how-to/networking): How apps and databases communicate inside a project, and how to control traffic with network policies.
- [Custom Domains](/docs/how-to/networking/domains): Configure custom domains and automatic HTTPS for your QuickStack applications.
- [QuickStack.me Domain](/docs/how-to/networking/quickstack-me): Use the built-in quickstack.me domain service for instant HTTPS access without manual DNS configuration.
- [Basic Authentication](/docs/how-to/networking/basic-auth): Protect your QuickStack applications with HTTP Basic Authentication via Traefik middleware.
- [Node Ports](/docs/how-to/networking/node-ports): Expose non-HTTP application ports directly on cluster nodes using Kubernetes NodePorts for TCP/UDP workloads.
- Storage: undefined
- [Volumes](/docs/how-to/storage/volumes): Configure persistent storage volumes for your QuickStack applications: storage classes, access modes, and gotchas.
- [Shared Volumes](/docs/how-to/storage/shared-volumes): Share a persistent volume between multiple apps in the same QuickStack project.
- [File Browser](/docs/how-to/storage/file-browser): Browse and download files in a QuickStack volume without shelling into a container.
- [File Mounts](/docs/how-to/storage/file-mounts): Inject read-only configuration files into your QuickStack containers using file mounts.
- Observability: undefined
- [Logs & Terminal](/docs/how-to/observability/logs-and-terminal): Use the built-in log viewer and interactive terminal to monitor and debug running QuickStack applications.
- [Builds Overview](/docs/how-to/observability/builds-overview): Monitor and manage all active and recent build jobs across every project from a single page.
- [Health Checks](/docs/how-to/observability/health-checks): Configure Kubernetes liveness, readiness, and startup probes for your QuickStack applications.
- Databases: undefined
- [Deploy Databases](/docs/how-to/databases/deploy-databases): Deploy pre-configured databases (PostgreSQL, MySQL, MariaDB, MongoDB) from QuickStack templates.
- [Database Tools (DbGate, pgAdmin, phpMyAdmin)](/docs/how-to/databases/db-tools): Enable and use built-in database GUI tools in QuickStack: DbGate, pgAdmin, and phpMyAdmin.
- Backups: undefined
- [Backups Overview](/docs/how-to/backups/overview): Overview of QuickStack's backup model: what gets backed up, how backups work, and where to find them.
- [S3 Targets](/docs/how-to/backups/s3-targets): Configure S3-compatible storage targets for QuickStack backup destinations.
- [Volume Backups](/docs/how-to/backups/volume-backups): Schedule automated backups for QuickStack application volumes to S3-compatible storage.
- [Database Backups](/docs/how-to/backups/database-backups): Schedule automated database dump backups for MariaDB, PostgreSQL, and MongoDB in QuickStack.
- [Download & Restore](/docs/how-to/backups/download-and-restore): Download QuickStack volume, database, and system backups, and restore the QuickStack configuration.
- [System Backups](/docs/how-to/backups/system-backups): Back up and restore the QuickStack system configuration (SQLite database) including projects, users, and app settings.
- Agent Sandbox (canary): undefined
- [Agent Sandbox](/docs/how-to/agents): Run Agent Sandboxes and their Sandbox Instances in QuickStack.
- [LLM Gateway](/docs/how-to/agents/llm-gateway): Connect QuickStack Sandbox Instances to a LiteLLM-compatible gateway for centralized model access and API keys.
- Admin: undefined
- [Two-Factor Authentication (2FA)](/docs/how-to/admin/two-factor-auth): Enable TOTP two-factor authentication for your QuickStack account.
- [Users & Groups](/docs/how-to/admin/users-and-groups): Manage users, groups, and per-project permissions in QuickStack.
- [Single Sign-On (SSO)](/docs/how-to/admin/single-sign-on): Let users sign in to QuickStack through an external identity provider such as OIDC, Google, Entra ID, or GitHub.
- [Cluster Monitoring](/docs/how-to/admin/cluster-monitoring): Monitor CPU, RAM, and disk usage across QuickStack cluster nodes.
- [Updates & Maintenance](/docs/how-to/admin/updates-and-maintenance): Update QuickStack, manage disk space, and perform k3s cluster upgrades.
- [Cluster Add-ons](/docs/how-to/admin/cluster-add-ons): Install, update, and remove cluster components such as Longhorn, cert-manager, the Kubernetes Agent Sandbox, and gVisor from the QuickStack UI.
- [Cluster Nodes](/docs/how-to/admin/cluster-nodes): Add and remove worker nodes, manage scheduling, and monitor node health in your QuickStack cluster.
- [Build Container Settings](/docs/how-to/admin/build-container-settings): Configure global node placement and resource limits for QuickStack build containers.
- [Password Reset](/docs/how-to/admin/password-reset): Reset the QuickStack admin password using the reset script.
- **API**
- REST API: undefined
- [REST API overview](/docs/rest-api/overview): Use the QuickStack REST API to manage app workloads programmatically.
- [Authentication](/docs/rest-api/authentication): Create and use REST API keys for the QuickStack API.
- [JavaScript & TypeScript SDK](/docs/rest-api/javascript-typescript-sdk): Use the official QuickStack JavaScript and TypeScript SDK for app workloads.
- [MCP Server (Canary)](/docs/mcp-server): Connect AI clients such as Claude Code, Codex and GitHub Copilot to QuickStack through the remote Model Context Protocol server.
- **Reference**
- Reference: undefined
- [Why QuickStack?](/docs/reference/comparison): How QuickStack compares to managed cloud platforms like Vercel and Heroku, and to other self-hosted PaaS tools like Coolify, Dokploy, and Easypanel.
- [Sizing & Costs](/docs/reference/sizing-and-costs): Choose server size for QuickStack based on the number of apps, databases, and nodes.
- [Ports & Endpoints](/docs/reference/ports-and-endpoints): Reference for QuickStack ports, webhook URL pattern, and internal service hostnames.
- [Glossary](/docs/reference/glossary): Glossary of QuickStack-specific terms and the key underlying technologies.