Introduction
FerroBox is a self-hosted, multi-format artifact registry: a lightweight Rust server. Metadata is in PostgreSQL. Bytes go to an S3-compatible bucket (AWS S3, Garage, MinIO) or to a directory. Zero JVM overhead. With S3, the FerroBox process does not keep the bytes. With the directory, the bytes are on a volume mounted into that same process. As of this writing it speaks:
- Cargo
- npm
- PyPI
- OCI / Docker
- Helm
- Conan
- Maven
- NuGet
- Go
- Generic artifacts
More formats get added over time, so treat this list as “what’s supported today”, not a fixed set.
Vulnerability scanning, SBOM generation, and artifact signing are part of
the same server as the registry itself. Vulnerability results come from
the instance feed when one is loaded, and from api.osv.dev otherwise.
See Concepts for the feed, and for
how an admission rule fails closed when that feed is missing.
Where to go next
Section titled “Where to go next”- New to FerroBox? Start with the Quickstart to run it locally with Docker Compose, or install it with Helm.
- Setting up a real deployment? The Configuration reference lists every environment variable FerroBox reads, including the database, artifact storage, and OIDC/SSO settings.
- Want the full picture? Concepts explains repository types, admission policies, and replication.
Source and license
Section titled “Source and license”FerroBox’s source code lives at github.com/ferrobox/ferrobox. It’s source-available under the Functional Source License 1.1, Apache 2.0 Future License (FSL-1.1-Apache-2.0) — free for internal use, and each release becomes Apache-2.0 two years after it ships. Using FerroBox inside a competing product or service is a separate conversation, not a self-serve checkout — reach out at [email protected].
These docs are new and will grow alongside the product — if something here is missing, unclear, or out of date, the GitHub repository is the place to raise it.