locnh/cachetf repository overview

⁠TF Registry Cache Proxy

A high-performance proxy server for Terraform/Tofu provider binaries with local or S3 backend caching capabilities. Built with Go, Gin, and Logrus.

⁠Features

• Network mirror caching of Terraform provider binaries
• Transparent proxy to upstream Terraform registry
• Configurable cache storage (local filesystem or S3)
• Structured logging with Logrus
• Environment-based configuration
• Graceful shutdown
• Support for multiple provider versions and platforms
• Support metrics endpoint for monitoring
• Support DELETE endpoint for deleting cached binaries

⁠Getting Started

⁠Prerequisites

• Go 1.19 or higher
• Docker
• Git
• Terraform (for testing)

⁠Docker

Run the Docker container with a specific version tag (replace v0.2.0 with the desired version):

docker run -d -p 8080:8080 -p 9090:9090 --name cachetf locnh/cachetf:v0.2.0

⁠Docker Compose (Recommended)

1. Edit docker-compose.yaml and specify the version tag:

   services:
     cachetf:
       image: locnh/cachetf:v0.2.0  # Specify the version tag here
   

   Copy

2. Start the service:

   docker compose up -d
   

   Copy

⁠Build from source

1. Clone the repository:

   git clone <repository-url>
   cd <project-directory>
   

   Copy

2. Install dependencies:

   go mod tidy
   

   Copy

3. Create a .env file in the root directory and configure your environment variables:

   ⁠Basic Configuration

   # Server configuration, default: 8080
   PORT=8080
   
   # Base path for API endpoints default: /providers
   URI_PREFIX=/providers
   
   # Storage type (local or s3, default: local)
   STORAGE_TYPE=local
   
   # S3 Configuration (required if STORAGE_TYPE=s3)
   # S3_BUCKET=your-bucket-name
   # S3_REGION=eu-central-1
   
   # For filesystem storage (default: ./cache)
   CACHE_DIR=./cache
   
   # Log level (debug, info, warn, error, default: info)
   LOG_LEVEL=info
   

   Copy

4. Build and run the application:

   # Using default configuration
   go run cmd/server/main.go
   
   # Or with custom cache directory
   CACHE_DIR=./my-cache go run cmd/server/main.go
   

   Copy

5. Configure Terraform to use the network mirror⁠ cache

   provider_installation {
       network_mirror {
           # keep trailing slash / and must be https
           url = "https://your-cache-server/providers/"
       }
   }
   

   Copy

⁠Metrics

The application exposes metrics at /metrics endpoint. The metrics are exposed in Prometheus format.

# Metrics port, default: 9100
METRICS_PORT=9100

⁠API Endpoints

• GET /health - Health check endpoint
• GET /providers/:registry/:namespace/:provider/index.json - List available versions
• GET /providers/:registry/:namespace/:provider/:version.json - List available platforms
• GET /providers/:registry/:namespace/:provider/terraform-provider-${provider}_${version}_${platform}_${arch}.zip - Download provider binary
• DELETE /providers/:registry/:namespace/:provider/:version - Delete provider binary
• DELETE /providers/:registry/:namespace/:provider - Delete provider
• DELETE /providers/:registry/:namespace - Delete namespace
• DELETE /providers/:registry - Delete registry

⁠Configuration

⁠Environment Variables

⁠Logging

The application uses Logrus for structured logging. Logs are output in JSON format. Set LOG_LEVEL=debug for more verbose logging.

Example log output:

{
  "level": "info",
  "msg": "Successfully downloaded and verified provider binary",
  "cache_path": "./cache/registry.terraform.io/hashicorp/random/3.7.2/terraform-provider-random_3.7.2_darwin_arm64.zip",
  "sha256": "1e86bcd7ebec85ba336b423ba1db046aeaa3c0e5f921039b3f1a6fc2f978feab",
  "time": "2025-07-02T02:14:59+02:00"
}

⁠S3 Storage Configuration

To use S3 as the storage backend, set the following environment variables:

1. Set STORAGE_TYPE=s3
2. Configure your AWS credentials and bucket:

   STORAGE_TYPE=s3
   S3_BUCKET=your-bucket-name
   S3_REGION=eu-central-1
   

   Copy

⁠S3 IAM Permissions

The following IAM permissions are required for the S3 bucket:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetObject",
                "s3:PutObject",
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::your-bucket-name",
                "arn:aws:s3:::your-bucket-name/*"
            ]
        }
    ]
}

⁠Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a new Pull Request

⁠License

This project is licensed under the MIT License.