Skip to content
Distr
Star
Book DemoStart free trialLogin

Self-Hosting Distr

While the easiest way to use Distr is to use our hosted offering, self-hosting is also an option. The free and open source Community Edition is the perfect option to try Distr locally on your own machine.

Distr comes as a statically compiled Go binary packaged as a container image, and has minimal dependencies:

  • A PostgreSQL database
  • Loki for log processing
  • Two S3 compatible object storage buckets for registry blobs and log chunks

Before you get started, review the System Requirements to make sure your environment is sized correctly.

Check out our Docker Compose or Kubernetes deployment options, or find out more information about the inner workings of Distr at github.com/distr-sh/distr.

Configuration

Section titled “Configuration”

Whichever way you deploy it, the Hub is configured entirely through environment variables, in the .env file next to the Compose file or under hub.env in the Helm values. Only DATABASE_URL, JWT_SECRET, DISTR_HOST and LOKI_URL are needed to start it. Everything else either has a default or belongs to a feature you turn on, such as the OCI registry, OIDC sign-in, outgoing mail, custom domains or the maintenance jobs.

The Configuration Reference lists every variable, grouped by area, and is the place to look up what a setting does and when it is required.

Semantic Versioning

Section titled “Semantic Versioning”

We are using semantic versioning for the releases of Distr Hub, Distr Agents and Distr SDKs.

Changelog

Section titled “Changelog”

See the changelog for a list of all releases and the changes they include.

Self-Hosting a Paid Plan

Section titled “Self-Hosting a Paid Plan”

Every plan can also be self-hosted, with the same feature set as on Distr Cloud (see Choosing a Plan). Paid plans run the Distr Enterprise image, which unlocks the plan its license key was issued for, so get in touch if you are interested. How to obtain the image and where to put the license key is described for Docker Compose and for the Helm chart.

Reference setups for a paid plan ship with the repository, as Compose stacks under deploy/docker and as Helm values files under deploy/charts/distr/examples. One of each runs everything on a single VM or cluster, and two run the Hub against a managed database and managed object storage on AWS or GCP. The Docker Compose and Kubernetes pages walk through both clouds.