How do I set up Terraboard with Docker?

Use docker-compose or Docker commands from the README, providing environment variables for AWS credentials and bucket details, then access the web UI on port 8080. A PostgreSQL container is required for the database backend.

Does Terraboard work with MinIO or other S3-compatible storage?

Yes, Terraboard supports S3-compatible backends like MinIO by configuring the AWS provider with no-versioning and no-locks options, as shown in the multiple buckets example in the README.

How can I compare Terraform state versions in Terraboard?

From the state view, select a different version to trigger the diff interface, which visually compares resource changes between versions, useful for auditing infrastructure updates.

Terraboard vs Terraform Cloud UI: which is better for state inspection?

Terraboard is open-source and supports multiple backends, ideal for self-hosting and mixed environments, while Terraform Cloud's UI is integrated but proprietary and limited to its platform. Terraboard offers more flexibility for custom setups.

What authentication methods does Terraboard support?

Terraboard has no built-in authentication; it relies on proxies like oauth2_proxy, with configuration examples for Nginx headers to pass user details, as detailed in the authentication section.

How do I push Terraform plans to Terraboard?

Wrap Terraform plans in a specific JSON format and POST them to /api/plans, as described in the README, enabling plan visualization alongside state data for better change tracking.

Is Terraboard suitable for real-time state monitoring?

No, Terraboard syncs state data periodically with a configurable interval (default 1 minute), so it's not real-time and may lag behind immediate changes in Terraform runs.

Open-Awesome

terraboard

Apache-2.0Gov2.4.0

A web dashboard to visualize and query Terraform states from multiple backend providers.

Visit Website GitHub

2.0k stars167 forks0 contributors

What is terraboard?

Terraboard is a web dashboard for inspecting and visualizing Terraform state files. It connects to remote state backends like AWS S3, Google Cloud Storage, and Terraform Cloud to provide an overview of infrastructure state, search capabilities, and version comparison. It solves the problem of lacking visibility into Terraform-managed resources across teams and environments.

Target Audience

Infrastructure engineers, DevOps teams, and platform operators who use Terraform for infrastructure-as-code and need to monitor, audit, or troubleshoot state changes.

Value Proposition

Developers choose Terraboard because it offers a free, self-hosted alternative to proprietary Terraform state visualization tools, supports multiple state backends simultaneously, and provides detailed diffing and search without requiring changes to existing Terraform workflows.

Overview

:earth_africa: :clipboard: A web dashboard to inspect Terraform States

Use Cases

Best For

Monitoring Terraform state changes across multiple projects or teams
Auditing infrastructure changes by comparing state file versions
Debugging Terraform resource issues by searching across all states
Visualizing infrastructure state for onboarding or documentation
Self-hosting a Terraform state dashboard for security or compliance
Integrating with S3-compatible storage like MinIO for on-premises deployments

Not Ideal For

Teams requiring built-in state file modification or direct management tools within the dashboard
Environments where deploying and maintaining a PostgreSQL database is impractical due to resource constraints or complexity
Projects using Terraform versions newer than those listed in the compatibility matrix without updates
Organizations seeking out-of-the-box authentication without relying on external proxies

Pros & Cons

Pros

Multi-Provider Flexibility

Supports AWS S3, Google Cloud Storage, Terraform Cloud, GitLab, and S3-compatible backends like MinIO, enabling centralized monitoring across diverse cloud and on-premises environments.

Powerful Search Capabilities

Allows querying resources by type, name, or attributes across all state files, with a dedicated search interface shown in screenshots, making it easy to debug or audit infrastructure.

Detailed Version Comparison

Provides diff views between state versions to track infrastructure changes, as highlighted in the compare feature and screenshot, essential for change management and rollbacks.

Centralized Multi-Bucket Monitoring

Can configure and monitor states from multiple buckets or providers simultaneously via YAML configuration, ideal for large-scale operations with dispersed Terraform projects.

Cons

No Built-in Authentication

Requires external authentication proxies like oauth2_proxy, as admitted in the README, adding setup complexity and security management overhead for teams.

Database Dependency Overhead

Needs a separate PostgreSQL instance for internal data storage, per the requirements section, increasing deployment footprint and maintenance effort.

Complex Multi-Provider Setup

Advanced configurations for multiple buckets or providers force use of YAML files instead of simpler environment variables, creating a steeper learning curve for initial setup.

Lagging Version Support

Compatibility matrix shows limited support for newer Terraform versions, potentially causing issues with state files from latest Terraform releases without updates.

Frequently Asked Questions

Related Projects

terraformer

CLI tool to generate terraform files from existing infrastructure (reverse Terraform). Infrastructure to Code

Stars14,559

Forks1,836

Last commit4 months ago

$Infracost$ Infracost

Cloud cost intelligence for engineers, AI coding agents, and CI/CD 💰📉 Shift FinOps Left!

Stars12,413

Forks679

Last commit21 days ago

Terragrunt

Terragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.

Terraform Pull Request Automation

Stars9,200

Forks1,304