> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperprobe.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Self-Hosting Deployment Guide

> Deploy the HyperProbe server, database, and telemetry broker on your own infrastructure using Docker Compose.

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:

| Resource             | Recommended Minimum                |
| :------------------- | :--------------------------------- |
| **Operating System** | Ubuntu 22.04 LTS or 24.04 LTS      |
| **CPU**              | 4 vCPU                             |
| **RAM**              | 16 GB                              |
| **Storage**          | 50 GB SSD                          |
| **Docker**           | Docker v26+ and Docker Compose v2+ |

***

## 🛠️ Step-by-Step Installation

<Steps>
  <Step title="Verify Docker Engine">
    Verify that your VM is running the latest Docker Engine:

    ```bash theme={null}
    docker -v
    ```

    If Docker is not yet installed or is below version 25, run the official utility script to bootstrap it:

    ```bash theme={null}
    curl -fsSL https://get.docker.com -o get-docker.sh && sudo sh get-docker.sh
    ```
  </Step>

  <Step title="Download the Deployment Package">
    Create a secure home directory and fetch the official HyperProbe starter bundle:

    ```bash theme={null}
    sudo mkdir -p /opt/hyperprobe
    cd /opt/hyperprobe
    sudo curl -O https://hyperprobe-assets.s3.ap-south-1.amazonaws.com/static/hyperprobe.tar.xz
    sudo tar -xf hyperprobe.tar.xz
    ```
  </Step>

  <Step title="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 (retrieve stable tag list from ECR).
  </Step>

  <Step title="Boot the Platform Stack">
    Run Docker Compose in detached mode to download and launch the services:

    ```bash theme={null}
    sudo docker compose up -d
    ```
  </Step>

  <Step title="Sign In & License">
    Navigate your browser to:

    ```text theme={null}
    http://<your-vm-ip-or-domain>:<HOST_BACKEND_PORT_TRAEFIK>
    ```

    Sign in, create your primary admin account, and enter your license key to activate the workspace!
  </Step>
</Steps>