boring-registry

Boring-registry is a simple open source module and provider registry compatible with Terraform and OpenTofu.

Overview

With boring-registry, you can upload and distribute your own modules and providers, as an alternative to publishing them on HashiCorp's public Terraform Registry.

Support for the Module Registry Protocol, Provider Registry Protocol, and Provider Network Mirror Protocol allows it to work natively with Terraform and OpenTofu.

Features

• Module Registry
• Provider Registry
• Network mirror for providers
• Pull-through mirror for providers
• Support for S3, GCS, Azure Blob Storage, and S3 compatible (MinIO, Garage, SeaweedFS, ...) object storage
• Support for OIDC and static API token authorization

Installation

Boring-registry can be installed in various ways, among others we offer a container image and also support the installation with Helm on Kubernetes. Learn more about the installation in our documentation.

Configuration

Check out the full documentation at boring-registry.github.io/boring-registry.

Contributing

Setup

Tools:

• go
• pre-commit
• golangci-lint
• mkdocs

pre-commit

Install pre-commit hooks:

pre-commit install --install-hooks

Running tests

Unit tests can be executed by running go test ./.... The integration tests don't run by default, but can be included by running go test ./... --tags=integration

docs

The docs can be rendered and served with mkdocs serve to preview changes live in the browser.

docker build -f docs/Dockerfile -t boring-registry-docs .
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs boring-registry-docs