terminal
Documentation Node // Online

Public documentation for installing and understanding Vinculum.

This page focuses on the shipped platform: what the Helm chart installs, how the main runtime pieces fit together, and where to go next for release and repository details.

Install SequenceHELM_PATH
$helm repo add vinculum https://florianwenzel.github.io/vinculum
$helm repo update
$helm install vinculum vinculum/vinculum -n vinculum-system --create-namespace
Install Notes

What the chart gives you

  • The umbrella chart installs PostgreSQL, Keycloak, Forgejo, Vinculum Infra, the orchestrator, and Hive UI.
  • Default first-party image tags follow the chart appVersion unless you override them in values.
  • Use your own ingress, hostname, storage, and identity settings through Helm values for your environment.
Core API Resources

First resources to know

POST /api/drones
POST /api/repositories
POST /api/accesses
POST /api/requirements
POST /api/tasks
POST /api/reviews
Published Artifacts

Where releases live

Helm chart repository: https://florianwenzel.github.io/vinculum
OCI chart namespace: oci://ghcr.io/florianwenzel/helm
Container image namespace: ghcr.io/florianwenzel/*
Source repository: https://github.com/florianwenzel/vinculum
Public Scope

What this documentation covers

  • Install the published platform from Helm without relying on repo-local development tooling.
  • Understand the main runtime components and the core resources exposed by the API.
  • Find the canonical source docs for release flow, chart publishing, and implementation details in the repository.
Architecture

Main runtime pieces

Platform Overview

Hive UI

Browser control surface for drones, repositories, requirements, tasks, reviews, and operational visibility.

Orchestrator

Go service and Kubernetes operator that manages CRDs, scheduling, task state, and drone execution.

Vinculum Infra

Bootstrap and reconciliation service for shared platform setup across Keycloak and Forgejo.

Vinculum Code

Forgejo-based code hosting, pull requests, repository automation, and access management.

Identity

Keycloak-backed OIDC layer for browser sign-in and platform-to-platform authentication.

Drone Runtime

Containerized worker runtime built around OpenCode plus a control API for isolated task execution.

Workflow

How work moves through the platform

01

Define requirements

Create requirements through the UI or API so work starts from durable product intent instead of disposable chat state.

02

Decompose into tasks

The orchestrator turns requirements into technical tasks and assigns available drones based on role and access.

03

Execute in pods

Drones run in isolated containers with repository access, instructions, provider auth, and execution controls.

04

Review and validate

Review resources, automated checks, and test workflows close the loop before changes are merged or promoted.