Hypertest Docs
HyperTestKnowledge Base
  • Quick Set-up
    • Install HyperTest
    • Deploy your application
    • Mirror Traffic
      • Using Kubernetes
      • Using Amazon ECS
      • Using Docker
      • Using Nginx
      • Using Goreplay
        • ElasticBeanStalk Script for Goreplay
      • Using Apache
      • Using IIS
      • Using Istio
      • Using Kong
      • Using HAProxy
      • Others
  • HyperTest Overview
    • Introduction
    • Architecture
  • Detailed Setup Guide
    • Detailed Setup Guide
      • Installation
        • Linux VM
        • Kubernetes Cluster
          • Hardware Requirements
          • Cluster Setup
            • EKS
              • Existing Application Load Balancer
              • Calculate Setup Cost for EKS Cluster
            • GCP
            • AKS
            • Self Managed
              • Microk8s with EKS-D
          • HyperTest Installation
      • Mirror Traffic
      • Configure HyperTest
      • Automate Starting a Test
        • CI Integration
          • GitHub Checks Integration
            • Mandatory checks
          • Gitlab Integration
          • Bitbucket Integration
          • Jenkins Pipeline
            • Jenkins Plugins for PR events
  • Upgrade HyperTest
    • Upgrade HyperTest
      • Linux VM
      • Kubernetes Cluster
  • User Guides
    • Usage Guide
      • Install and Configure HyperTest
        • Install HyperTest
        • Configure Base DNS
        • Add New Service
      • Tests Runs and Analysis
        • View Test Cases
        • Start New Test Run
        • Understand Your Test Run Analysis
        • Prioritize Your Error Types
        • Track Bugs
        • Ignore Errors/Desired Changes
        • View/Download Report
        • View Consolidated Dashboard Reports
        • Sign-off Reports
        • Reduce Execution Time
        • Deduplication Rules
      • Troubleshooting and FAQs
    • Best Practices Guide
      • Cost Optimization
    • Dashboard Tour
      • Dashboard
      • All Sessions
      • Regression Report
      • Notifications
      • First Test Run
      • Interactions
      • Custom Analysis
      • Configuration
    • User Management
      • Create Admin User
      • Roles, Groups & Users
      • Enabling User Signup
    • Other Guides
      • Basic Nginx Auth for Linux HT
  • Middleware
  • Advanced Features
    • Import test cases from Postman
  • Change Log
  • Troubleshooting
  • FAQs
    • Setup
    • General
    • Regression Report
  • Glossary
    • Session
Powered by GitBook
On this page
  • Tech Stack Overview
  • Recommended Resources
  • Prerequisites
  • 1. Installing Docker
  • 2. Installing Docker Compose v1
  • Getting Started
  • 1. Download HyperTest
  • 2. Start HyperTest
  • Mirror Traffic to HyperTest
  • Configure HyperTest
  1. Quick Set-up

Install HyperTest

Deploy HyperTest on Linux VM

PreviousQuick Set-upNextDeploy your application

Last updated 1 year ago

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

The VM should be x64 architecture and preferably latest Ubuntu version - 22.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.

If you want to install HyperTest on Kubernetes cluster, refer guide...

Tech Stack Overview

Recommended Resources

2vCPU

4GB RAM

50GB Disk

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

Prerequisites

You should have root user access in VM

Your system should have the following installed:

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

2. Installing Docker Compose v1

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

docker-compose -v

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

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && sudo chmod +x /usr/local/bin/docker-compose && sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

Replace 1.29.1 with the latest v1 version. v2 is not supported as of now.

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

Check if docker-compose is installed successfully by using the following command

docker-compose -v

Getting Started

1. Download HyperTest

Create a new directory

Replace the <name of your service> with the service name you choosing to test with HyperTest in all below commands

mkdir -p /opt/hypertest_<name of your service>
cd /opt/hypertest_<name of your service>

Download HyperTest

wget -O ht-cli.tar.xz https://hypertest-binaries-1.s3.ap-south-1.amazonaws.com/ht-cli/ht-cli-latest.tar.xz
tar xvf ht-cli.tar.xz

2. Start HyperTest

Set up a cron job to start HyperTest on reboot

  1. Run sudo crontab -e

  2. Edit the path to HyperTest binary and add the following entry to a new line.

    * * * * * cd /opt/hypertest_<name of your service> && ./hypertest bg-start >> /tmp/ht-<name of your service>.log 2>&1

Start HyperTest

./hypertest start

After starting HyperTest, you will have to enter two ports for HyperTest. These ports should be opened in your VM. Here we have given 8000 and 8001, but you can always give other ports.

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

  • HT_PORT: 8001 - This is the port on which HyperTest Dashboard will be accessible by the users

Wait for complete installation of HyperTest

Open dashboard

HyperTest dashboard would be running on the port specified by you just now.

Open up your browser and go to http://<your-ip/your-hostname>:<HT_PORT>

Mirror Traffic to HyperTest

After installing HyperTest, please follow below guide to mirror traffic to HyperTest

Configure HyperTest

After installing HyperTest, please follow below guide to configure HyperTest

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

: Compose is a tool for defining and running multi-container Docker applications

: A No-code API testing tool

: (>= 20.10.6)

: (>= 1.29.1)

Docker
Docker Compose v1
HyperTest
Docker
Docker-compose
Mirror Traffic
Configure HyperTest
HyperTest
this