Get Started with the
PayProbe Platform

Prerequisites

Two things, probably already installed

Docker with the Compose plugin, and Git. That's all — in mock mode nothing else needs to be installed on your machine.

Option 1 — Prebuilt Images

Fastest: pull from Docker Hub, no build

Pulls published images from Docker Hub. You still run it from a checkout of the repository — the compose file mounts the nginx routing config and example seeds from the repo.

# 1. Clone the repository
git clone https://github.com/pay-probe/payprobe.git
cd payprobe

# 2. Start the whole platform from published images
docker compose -f infra/docker/docker-compose.hub.yml up -d
#    (or: make up-hub)

# 3. Open the portal
open http://localhost:8080

Pin a version with PAYPROBE_TAG=v0.1.0 docker compose -f infra/docker/docker-compose.hub.yml up -d (default latest). Stop with docker compose -f infra/docker/docker-compose.hub.yml down (or make down-hub).

Option 2 — Build from Source

Build the whole stack yourself

git clone https://github.com/pay-probe/payprobe.git
cd payprobe

# Build and start the whole stack
docker compose -f infra/docker/docker-compose.yml up --build

# Open the portal
open http://localhost:8080

Tear down with docker compose -f infra/docker/docker-compose.yml down (add -v to also drop the postgres & redis volumes).

What You Get

Three services on localhost

First Run

Start a mock run

Open the portal, start a mock run from the Run Monitor, and watch steps stream in live. For configuration (.env.example → .env) and production notes, see the repository README and infra/docker/README.md.

PayProbe is source-available under the PolyForm Noncommercial license — free for personal, research, and internal noncommercial use.