Skip to main content
For teams with strict compliance mandates or isolated VPC requirements, you can self-host the entire HyperProbe architecture (Dashboard UI, Telemetry Broker, Database, and Traefik reverse proxy) on a single Linux VM.

🖥️ System Requirements

Ensure your host VM meets these minimum hardware profiles:

🛠️ Step-by-Step Installation

1

Verify Docker Engine

Verify that your VM is running the latest Docker Engine:
If Docker is not yet installed or is below version 25, run the official utility script to bootstrap it:
2

Download the Deployment Package

Create a secure home directory and fetch the official HyperProbe starter bundle:
3

Configure Environment Variables (.env)

Inside the extracted bundle, open the .env file and customize the port bindings and versions. Ensure these ports are open on your VM’s firewall/security group rules:
  • HOST_BACKEND_PORT_TRAEFIK - The port used by developers to access the HyperProbe web dashboard.
  • HOST_LOGGER_PORT_TRAEFIK - The secure port that connected SDK agents will use to transmit dynamic log, counter, and snapshot payloads.
  • HOST_CONSUL_HTTP_PORT_TRAEFIK - Internal registry port.
  • HYPERTEST_VERSION - The platform version tag to pull. Set this to the latest @hyperprobe/node-sdk tag shown below. Platform and Node SDK always share the same the release tag value.
4

AWS ECR Public Authentication (Optional: only if you get this error continuously)

To avoid hitting pull rate limits (toomanyrequests: Rate exceeded) when pulling images from public.ecr.aws, authenticate Docker with AWS ECR before running Docker Compose.
Note: Authentication with AWS ECR Public requires --region us-east-1 regardless of your default AWS region setup.
5

Boot the Platform Stack

Run Docker Compose in detached mode to download and launch the services:
Complete aws login for better
6

Sign In & License

Navigate your browser to:
Sign in, create your primary admin account, and enter your license key to activate the workspace!
7

Create a team

  • Go to teams page from left navigation menu.
  • Click Create Team and enter the required details to set up a non-admin team. Note: Only non-admin teams can be associated with services.
  • Create a service under your non-admin team.
  • Integrate the HyperProbe SDK automatically by clicking Integration using AI agent or select your programming language from options below to follow steps and set up manually.