Hypertest v2 Docs
HyperTest
  • Overview
    • How It Works?
  • SETUP GUIDE
    • Installation
      • Deploy HyperTest Server
      • Creating your first User
      • Adding your first service
      • Integrate SDK
        • Node.js
          • Node.js SDK with CJS
          • Node.js SDK with ESM
        • Java
    • Start a Test Run
      • CLI Login
      • Type References
      • Java
  • Interpreting Test Results
    • Test Results
    • Understanding Results Categories
    • Mock Not Found
    • AI Match Mocks
    • Accepting Changes
  • USER GUIDES
    • Node.js SDK
      • Limit memory usage
      • Supported NPM packages
      • Mock Dependencies Manually
      • Unmocking/Passing Through
      • Sampling and blocking requests
      • Manage Global Variables
      • Mocking Environment Variables
      • Tags
      • Set HTTP path patterns
      • Discard a test case(Request) while recording
      • Set Git Commit Hash
      • Code coverage based features
        • Continuous Coverage
        • Updating test coverage
        • Running post test deduplication
        • Only testing modified requests
        • Ignore differences for unmodified requests
      • Experimental flags
      • Manual Request
      • Only testing modified requests
      • Server hooks
    • Java SDK
      • Sampling and blocking requests
      • Mock Dependencies Manually
      • Tags
      • Unmocking/Passing Through
      • Code Coverage Setup and Report Generation
      • Supported Java packages
    • Build your own Docker Image
    • CLI Config
    • Ignoring Differences
      • Type References for Filter functions
  • Impact Features
    • Fast Mode
    • Code Coverage Report
    • Delete Recorded Requests
    • Inter Service Testing
  • Release History
    • Slack Integration
    • Version History
Powered by GitBook
On this page
  • Tech Stack Overview
  • Recommended Resources
  • Prerequisites
  • 1. Installing Docker
  • Getting Started
  • 1. Deploy HyperTest Services
  1. SETUP GUIDE
  2. Installation

Deploy HyperTest Server

This page shows to install hypertest server on a linux VM using docker compose

PreviousInstallationNextCreating your first User

Last updated 6 months ago

In this guide, we will install in a new ubuntu VM.

The VM should preferably be latest Ubuntu version - 24.04.

If you are using AWS EC2, you can reduce cost by installing HyperTest on a spot instance and attaching an elastic IP to it.

Tech Stack Overview

: Docker is an open platform for developing, shipping, and running applications

: A No-code API testing tool

Recommended Resources

Recommended minimum resources required to run HyperTest on a VM are as follows:

4 vCPU

16 GB RAM

100 GB Disk

Prerequisites

You should have root user access in VM

Your system should have the following installed:

  1. : (>= 20.10.6)

1. Installing Docker

Check if you have docker installed in your VM already by using the following command

docker -v

If you don’t have docker, install it using the following command

curl -fsSL https://get.docker.com -o get-docker.sh && sudo sh get-docker.sh

If you have an older version of docker (< 18.09.7), remove it and reinstall the latest version using above command

Check if docker is installed successfully by using the following command

docker -v

Getting Started

1. Deploy HyperTest Services

Switch to sudo user

sudo -i

download the starter archive docker-compose.yml with the below content

mkdir -p /opt/hypertest
cd /opt/hypertest
curl -O https://hypertest-documentation-assets.s3.ap-south-1.amazonaws.com/docker-compose/ht-init.tar.xz
tar -xf ht-init.tar.xz

## verify contents using ls -a 

You should now have these files

  • docker-compose.yml

  • dynamic.yml

  • .env

  • .htpasswd

  • otel-collector.yml

The following are the details of the env variables in the .env file These ports should be opened on your VM

HOST_TRAEFIK_STATS_PORT_TRAEFIK=8080
HOST_BACKEND_PORT_TRAEFIK=8001
HOST_LOGGER_PORT_TRAEFIK=4319
HOST_CONSUL_HTTP_PORT_TRAEFIK=8500
HOST_DB_PORT=16544
HOST_JAEGER_PORT=16687
HYPERTEST_VERSION=0.2.23-4
  • HOST_BACKEND_PORT_TRAEFIK: 8001 - This is the port on which HyperTest Dashboard will be accessible by the users

  • HOST_LOGGER_PORT_TRAEFIK: 4319 - This port will be used internally for mirroring traffic. You have to allow incoming traffic to HyperTest on this port from your application

  • HOST_CONSUL_HTTP_PORT_TRAEFIK: 8500 - This port will be used to expose consul

  • HYPERTEST_VERSION: 0.2.23-4 - Version of HyperTest (Get the latest from the HT team)

Bring up the services by the following command

docker compose up -d

Verify the containers are up and running by docker ps

HT Dashboard will be accessible onhttp://<hypertest-vm-ip/domain>:<HOST_BACKEND_PORT_TRAEFIK>

HyperTest
Docker
HyperTest
Docker