Skip to content
Install

What is Orchard

Orchard is an open-source, self-hosted platform as a service (PaaS) from Hack Club. It gives you the push-to-deploy workflow of a hosted platform on hardware that you control. You connect a Git repository, and Orchard builds the app, runs it behind an HTTPS URL, and runs a managed Postgres database next to it, with backups to S3-compatible storage and point-in-time restore.

Orchard runs on Kubernetes, but you do not need to know Kubernetes to use it. On a single Linux server, one command sets up a k3s cluster and every component Orchard needs. On a cluster that you already operate, a Helm chart installs Orchard on top of it. After that, you work in the dashboard, the CLI, or an AI agent, the same way you would on a hosted platform.

Orchard is free and licensed under AGPL-3.0. The SDK for building extensions is licensed under MIT. Hack Club runs its own apps on Orchard. There is no hosted version, so you run the instance yourself.

  1. You install Orchard. The installer sets up k3s, Orchard, a container registry, and the operators for databases and certificates. The Helm chart installs Orchard on a cluster that already has them.
  2. You connect a repository from GitHub, GitLab, Gitea, or another Git host over HTTPS. You can also deploy a container image, or, when the instance has S3 storage, deploy a folder from your computer with orchard up.
  3. Orchard builds an image on your cluster. It uses your Dockerfile, or it detects your language and builds the app without one.
  4. Orchard runs the app, routes HTTPS traffic to it, and keeps it running. By default, the new version must be ready before Orchard stops the old one. An app with a volume stops first instead.
  5. With auto-deploy on, each push to the branch that you choose deploys again. On GitHub, this needs the GitHub App. If a deploy goes wrong, you roll back to an earlier build.

Your apps and databases run as normal Kubernetes workloads, so they do not depend on the Orchard dashboard or API. If Orchard itself stops, your apps keep serving traffic, and only new deploys and changes wait until it is back. The exception is a domain with access protection, which routes requests through the Orchard server. For the components and how they connect, refer to Architecture.

  • Developers and students who want push-to-deploy hosting on a VPS or a home server, without learning DevOps.
  • Teams that want one platform for their apps, databases, and jobs, with roles, single sign-on (SSO), and audit logs.
  • People who already run Kubernetes and want a PaaS on top of it. They install the Helm chart instead of the installer.
Feature Description Refer to
Deployments Deploy from GitHub, GitLab, Gitea, or another Git host, from a container image, or from a folder. Deploy from GitHub
Builds Build from a Dockerfile, or without one. Builds run on your cluster and stream their logs. Builds
Routing Give each app an HTTPS URL, custom domains, and access protection. Manage domains and HTTPS
Databases Run Postgres with backups, point-in-time restore, forks, read replicas, and major upgrades. Create and manage a database
Jobs Run multi-step jobs on a cron schedule or on demand. Run jobs and pipelines
Observability Search logs, read metrics and requests, and open a shell in a running container. Read logs and open a shell
Teams Manage organizations, roles, SSO, audit logs, and quotas. Manage organizations and roles
Interfaces Use the dashboard, the CLI, the Model Context Protocol (MCP) server, or Terraform. Use the CLI
Extensions Add pages, API endpoints, and MCP tools with grafts, which are extensions that the operator installs. Grafts

A graft is an extension that adds features to an Orchard instance without a fork. Orchard publishes its own grafts, such as Greenhouse, which runs coding agents on cloud machines. For the full feature list, refer to Features. To compare Orchard with other self-hosted platforms, refer to Compare.

Orchard runs the same way in both setups. What changes is how much of the cluster underneath it you operate.

Setup What you get Use it for
One-command installer A single-node k3s cluster on one Linux machine, with local-path disks, a zot registry, and an S3 store for backups on the same machine. The installer configures all of it. A home lab, a side project, a small team, or a trial
Helm chart Orchard on a cluster that you build and operate. You choose the registry, the storage, the backup store, and the number of nodes. A production setup

The installer’s limit is its single-node layout, not k3s: that one machine is a single point of failure. For production, Orchard recommends the Helm chart on a multi-node cluster built for it, such as Talos Linux, with the bundled components replaced by ones that you operate. For the differences and the components you can replace, refer to Choose a layout.

Before you go live on either setup, work through Go to production.

  • Orchard is not fully tenant-isolated by default. Apps cannot reach each other over the network, but they share the host kernel. Before you let people you do not trust deploy code, follow Requirements for untrusted code.
  • Orchard uses Kubernetes words where they matter. Pods, replicas, and namespaces appear in the dashboard under those names.
  • Managed databases are Postgres only. Other databases, such as MariaDB or MongoDB, run as apps from templates.

For the full list, grouped by area, refer to Known limitations.

  • Install - Run the installer on a Linux machine, or install the Helm chart on your cluster.
  • Deploy your first app - Deploy a repository and connect a Postgres database to it.
  • Concepts - Learn how organizations, projects, environments, and apps fit together.
  • FAQ - Read short answers about production use, security, and licensing.