GitHub - distr-sh/distr: The Open Source control plane for self-hosted, BYOC, and on-prem deployments. Everything you need to distribute applications to self-hosted customers out of the box. Supporting Docker Compose, Docker Swarm and Helm based applications. · GitHub
Distr
Software Distribution Platform
Distr enables software and AI companies to distribute applications to self-managed customers with minimal setup.
Website • Quickstart • Documentation • Blog • Community
Main features
- Centralized Management: View & manage all deployments, artifacts, connected agents, self-managed & BYOC customers via the intuitive web UI
- Deployment Automation: Optional prebuilt Helm and Docker agents manage deployments, collect logs and metrics, and allow remote troubleshooting.
- White-label customer portal: Let your customers control their deployments or download your artifacts
- License Management: Distribute specific versions of your application to specific customers
- Container registry: Distribute OCI-compatible artifacts (Docker images, Helm charts, Terraform modules) with built-in granular access control and analytics.
- Access the API using our rich SDK
- Fully Open Source and self-hostable
Check out the hosted version at https://distr.sh/get-started/.
About
Distr is an Open Source software distribution platform that provides a ready-to-use setup with prebuilt components to help software and AI companies distribute applications to customers in complex, self-managed environments.
Use cases include:
- On-premises, VPC and self-managed software deployments
- Bring Your Own Cloud (BYOC) automation
- Edge & Fleet management
Read more about Distr and its core concepts at https://distr.sh/docs/core-concepts/
Architecture overview
architecture-beta group ctrl(cloud)[Distr Saas or Your Cloud] service hub(server)[Distr Hub] in ctrl service db(database)[PostgreSQL] in ctrl service oci(database)[Distr OCI Registry] in ctrl service s3(disk)[Object Storage] in ctrl oci:R -- L:hub db:T -- B:hub oci:B -- T:s3
junction customerjunction
hub:R <-- L:customerjunction customerjunction:T -- B:agent customerjunction:B -- T:client
group agentcustomer(cloud)[Customer Cloud] service agent(internet)[Distr Agent] in agentcustomer service app(server)[Your Application] in agentcustomer agent:L --> R:app
group ocicustomer(cloud)[Fully self managed customer] service client(internet)[OCI client] in ocicustomer
Loading
Self-hosting
In case you get stuck, have questions, or need help, we're happy to support you, join our community forum.
Docker
The Distr Hub is distributed as a Docker image via ghcr.io. Check out deploy/docker for our example deployment using Docker Compose. To get started quickly, do the following:
mkdir distr && cd distr && curl -fsSL https://github.com/distr-sh/distr/releases/latest/download/deploy-docker.tar.bz2 | tar -jx
make necessary changes to the .env file
docker-compose up -d
Kubernetes
Distr is also available as a Helm chart distributed via ghcr.io. Check out deploy/charts/distr for our Helm Chart source code. To install Distr in Kubernetes, simply run:
helm upgrade --install --wait --namespace distr --create-namespace \ distr oci://ghcr.io/distr-sh/charts/distr \ --set postgresql.enabled=true --set rustfs.enabled=true
For a quick testing setup, you don't have to modify the values. However, if you intend to use distr in production, please revisit all available configuration values and adapt them accordingly. You can find them in the reference values.yaml file. Register your first account at http://localhost:8080/register
The full self-hosting documentation is at https://distr.sh/docs/self-hosting/
Using Distr agents on macOS? Follow the macOS guide to get started. Using Distr agents on Windows with WSL2? Follow the Windows WSL2 guide to get started.
Building from source
To build Distr Hub from source we recommend that you use mise to install all required dependencies, but you don't have to.
All dependency versions and build tasks can be found in the mise.toml file, for example:
Build the control plane
mise run build:hub
Build all docker images
mise run "docker-build:**"
Distr Integrations
Distr offers several ways to integrate with your existing tools and workflows.
Distr API
Distr provides a comprehensive REST API that allows you to manage deployments, artifacts, agents, licenses, and more programmatically. The full API reference is available at https://app.distr.sh/docs.
For further details on authentication and usage, see https://distr.sh/docs/integrations/api/.
Distr SDK
Interact with Distr directly from your application code using our first-party SDK. The Distr SDK is currently available for JavaScript only, but more languages and frameworks are on the roadmap. Let us know what you would like to see!
You can install the Distr SDK for JavaScript from npmjs.org:
npm install --save @distr-sh/distr-sdk
The full SDK documentation is at https://distr.sh/docs/integrations/sdk/
GitHub Action
Automate artifact version creation in your CI/CD pipeline with the official Distr GitHub Action. It is available at https://github.com/distr-sh/distr-create-version-action.
For setup and usage instructions, see https://distr.sh/docs/integrations/gh-action/.
Contributing & Local Development
If you are interested in contributing to Distr or want to modify it for your own needs, check out our contributing guidelines.
License
Distr is licensed under the Apache License 2.0. For a hosted version and Enterprise plans, see https://distr.sh/pricing/.