Godot Binary Builder wiki

Godot Binary Builder compiles Godot editors and export templates with selected C++ engine modules. A Go service manages the catalog, queue, compilation, logs, and artifacts; a Svelte frontend and the gbb CLI provide access.

Start with Getting started for a local build or development server, then Building Godot for everyday usage.

Page	Contents
Getting started	Requirements, local compilation, development server, first catalog entry
Building Godot	Browser workflow, platform matrix, CLI, build states
Configuration	Settings, credentials, storage, resource limits
Modules and administration	Catalog maintenance, dependencies, compatibility, administrator access
API	Routes, authentication modes, request examples, errors
Architecture	Components, build lifecycle, persistence, execution boundaries
Deployment and operations	Docker/Kubernetes deployment, gateway, retention, recovery
Security	Public verification, quotas, proxy trust, private delivery
Troubleshooting	Startup, compilation, authentication, downloads
Development	Repository layout, checks, integration gates, contribution workflow

Implementation status

The running service uses the Docker-compatible runner. The Kubernetes phase adapter and durable execution store are implemented as separate pieces, but the controller and phase-service integration remain unfinished. Their existence does not switch the API to Kubernetes Jobs.

Local Linux and Windows compilation has been recorded in the project documentation. macOS requires an operator-supplied Apple SDK. Production ingress, isolation, real compilation, and recovery need validation in the target deployment; passing unit tests or rendering manifests does not establish those properties.

This wiki describes the current working-tree implementation. Existing milestone documents preserve historical observations and sometimes contain superseded statements. For implementation details, consult the linked source files and focused design documents. The roadmap tracks broader work.

Reference documents

The pages above are the guide. These are the underlying design and operations documents, mirrored from docs/ in the repository — narrower, longer, and closer to the implementation.

Page	Contents
Reference: API	Full HTTP contract: builds, SSE logs, objects, modules, admin, auth
Reference: Architecture	Pipeline stages, packages, what a submitted build does
Reference: Modules	Registering a module; how compatibility is decided
Reference: Module registry	Full catalog and registry design
Reference: Admin	Admin API: versions, module lists, tokens
Reference: Artifacts	Artifact storage and download delivery
Reference: Deployment	Kubernetes, the dind sidecar, config, unverified parts
Reference: Kubernetes execution	Running builds as Kubernetes Jobs
Reference: Durable execution store	Execution state that survives a restart
Reference: Immutable build configuration	Freezing what a build was told to do
Reference: Download gateway	The separate gateway that serves artifacts
Reference: Public logs	What log output is exposed publicly
Reference: Anonymous verification	Verifying unauthenticated submitters
Reference: Abuse enforcement	Quotas, bans, and how they are applied
Reference: Public service remediation	Hardening required before public exposure
Reference: Authelia administration	Administrator access through Authelia
Reference: CI/CD	Pipelines, gates, and release flow
Reference: macOS SDK	Supplying your own Apple SDK for osxcross
Contributing	Working on the codebase
Roadmap	Milestones and their acceptance criteria

Maintaining and publishing these pages

These pages are generated from docs/wiki/ and docs/ on main in the source repository, so they can be reviewed alongside the code that changes them. Edit them there and republish; edits made directly in this wiki will be overwritten on the next publish. Home is the landing page and _Sidebar supplies the navigation.