Skip to content
 
 

Latest commit

 

History

9,726 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BigRAE

Self-service agentic cyber-range platform for authorized purple, red and blue team exercises, with isolated guest workloads and operator-selected telemetry. Canonical repository: OpenRAE/bigrae.

Documentation: openrae.github.io/bigrae.

Install

The GCP installation route uses a verified release container. It needs no GitHub account, fork, or repository checkout. The latest published release checked on 2026-11-09, v4.1.1, predates the deployer image. Select an eligible later release before using the current installation procedure. Current GCP and AWS backend source does not establish published-release support.

  1. Select a release (see Releases).
  2. Follow Install on Google Cloud. You need a GCP project with billing on, a domain that you control, Docker, the gcloud CLI, Git, ORAS, and cosign.
  3. Launch your first range.

Releases

A release is a GitHub release vX.Y.Z of main. The GCP release workflow publishes these images to the public registry ghcr.io/openrae/bigrae, with signed build provenance:

  • the deployer image deployer-gcp, which holds the install commands, the Terraform roots, the Helm chart, and the pinned tools;
  • the control-plane images portal, provisioner, guacd, guacamole-client, and openvpn.

Each image tag is the full commit SHA of the release, not the version. Releases v4.1.1 and earlier have no deployer image. CHANGELOG.md lists the changes in each release.

Documentation

Purpose Start here
Tutorials Launch your first range on an installed GCP tenant.
How-to guides Feature tasks and troubleshooting.
Reference FAQ and technical contracts.
Explanation Key concepts and architecture handbook.

Get started links the installation and learning routes. The GCP deployment guide owns full operator procedures. The documentation site publishes docs/ from main under ADR-038.

Develop

Use Python 3.12+, uv, the frontend's declared Node version and npm, and pre-commit. The platform and packer packages require Python 3.14. From the repository root:

uv sync --project shifter/shifter_platform
uv sync --project shifter/installation
npm ci --prefix shifter/shifter_platform/frontend
pre-commit install --hook-type pre-commit --hook-type commit-msg

Use local development setup and contribution guidance for the development workflow. To deploy a development environment from your own fork with GitHub Actions, use the selectable aws-dev target in developer environment setup.

Test and document

Use targeted tests for changed behavior during development, for example:

(cd shifter/shifter_platform && TEST_DB_BACKEND=sqlite uv run pytest tests/config/test_dev_auth.py -n0 --no-cov)

Full-package commands such as make test-platform and make test-provisioner are recorded in the command matrix for CI reproduction. They are not the normal local editing checklist. make policy runs the repository policy checks; it is not a full test suite. Build the documentation locally without publishing:

uv run --with-requirements docs/requirements.txt mkdocs build --strict

The command matrix lists every lane and its CI job. See also ADR enforcement. CI owns the full quality matrix; local hooks also enforce architecture and secret hygiene. Architecture-boundary changes include handbook review.

Support and security

BigRAE is maintained on a community, best-effort basis without a response SLA. Use SUPPORT.md for assistance and support limits and SECURITY.md for private vulnerability reporting. Run exercises only in environments you are authorized to control, with human oversight.

The maintainer is Brad Edwards. The repository is MIT licensed; LICENSE retains the copyright holders' notices.

Contributing

Read CONTRIBUTING.md. Feature PRs target dev and use Conventional Commit titles. Release Please owns the version and CHANGELOG.md from the history promoted to main; see the release workflow.

Repository history

The repository was renamed on 2026-10-25 and moved to the OpenRAE organization on 2026-10-29. Old repository URLs redirect to OpenRAE/bigrae. GitHub Pages does not redirect the old documentation site paths, so update bookmarks.

Citation

@software{shifter,
  author       = {Edwards, Brad},
  title        = {Shifter: Self-Service Agentic Cyber Range Platform},
  year         = {2026},
  license      = {MIT},
  url          = {https://github.com/OpenRAE/bigrae}
}

Include the exact release or commit you used in your publication.