mirror of https://github.com/trailofbits/buttercup synced 2026-06-21 14:11:39 +00:00

Files

T

Riccardo Schirone 761dc6c13f Add compose.prebuilt.yaml overlay for prebuilt GHCR images (#548 )

Adds an overlay for dev/docker-compose that resets the `build:` block
of every locally-built component and points it at the matching prebuilt
image from GHCR, so developers can run the stack without local builds.
Image tag defaults to "main" and is overridable via BUTTERCUP_IMAGE_TAG.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* ci: allow Docker Compose !reset/!override tags in YAML check

The static-checks YAML step uses yaml.safe_load_all, which rejects the
Compose-specific !reset/!override merge tags used by
compose.prebuilt.yaml. Register no-op constructors for those tags so
compose overlays validate without masking real YAML errors elsewhere.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-18 16:15:53 +02:00

1.6 KiB

Raw Permalink Blame History

Docker Compose Development Setup

This directory contains the legacy Docker Compose setup for Buttercup CRS, preserved for developers who need to run specific components for quick testing and development.

Usage

From the repository root directory:

# Run all services
cd dev/docker-compose && docker-compose up -d

# Run specific services or profiles
cd dev/docker-compose && docker-compose --profile fuzzer-test up -d
cd dev/docker-compose && docker-compose --profile graphdb up -d

# Stop services
cd dev/docker-compose && docker-compose down

Using prebuilt images (skip local builds)

compose.prebuilt.yaml is an overlay that replaces every locally-built component with its prebuilt image from GHCR, so nothing is built locally:

cd dev/docker-compose && docker compose -f compose.yaml -f compose.prebuilt.yaml up -d

# Pin a specific image tag (defaults to "main"):
BUTTERCUP_IMAGE_TAG=<branch-or-tag> docker compose -f compose.yaml -f compose.prebuilt.yaml up -d

Configuration

env.template - Template for environment variables (copy to .env and customize)
env.dev.compose - Development-specific environment configuration
compose.yaml - Main compose file with all services
compose.prebuilt.yaml - Overlay that pulls prebuilt GHCR images instead of building locally

Notes

This setup is not recommended for production - use the Kubernetes deployment instead
Primarily useful for developers who need to run individual components for testing
The main deployment method is now Kubernetes via make deploy from the repository root
See the main README for the recommended setup instructions

1.6 KiB Raw Permalink Blame History