Skip to main content

Usage

This page explains how to authenticate and use modules from the Unmold registry in OpenTofu and Terraform.

Authentication​

To access private modules, you must authenticate with the registry.

Use the built-in login command:

tofu login registry.unmold.dev
terraform login registry.unmold.dev

This command:

  • Generates or uses an API token
  • Stores it securely in the OpenTofu/Terraform credentials store
  • Enables seamless access to private modules

Alternative: Environment Variable​

You can provide the API token via environment variable:

export TF_TOKEN_registry_unmold_dev=<your_api_token>

This is commonly used in CI/CD environments.

Alternative: .netrc File​

For HTTP-based access, you need to configure a .netrc file at the HOME directory:

machine registry.unmold.dev
login <your_email>
password <your_api_token>

This allows tools like OpenTofu and Terraform to authenticate automatically. See documentation for details.

Using Modules​

Unmold supports two ways to reference modules.

Use the registry source format:

module "example" {
  source  = "registry.unmold.dev/<namespace>/<name>/<system>"
  version = "<version>"
}

This approach only supports semver versions.

Example:

module "network" {
  source  = "registry.unmold.dev/team-infra/vpc/aws"
  version = "1.2.0"
}

HTTP Source​

You can also download modules directly via HTTP:

module "example" {
  source = "https://registry.unmold.dev/modules/v1/<namespace>/<name>/<system>/<version>/package.zip"
}

This approach supports semver versions and arbitrary version names.

Example:

module "network" {
  source = "https://registry.unmold.dev/modules/v1/team-infra/vpc/aws/1.0.0/package.zip"
}

Choosing a Source​

  • Use registry source for standard OpenTofu/Terraform workflows
  • Use HTTP source for custom tooling or direct downloads