Deploy HyperTest Server
This page shows to install hypertest server on a linux VM using docker compose
In this guide, we will install HyperTest in a new ubuntu VM.
The VM should preferably be latest Ubuntu version - 24.04.
Tech Stack Overview
Docker: Docker is an open platform for developing, shipping, and running applications
HyperTest: 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
Your system should have the following installed:
Docker: (>= 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>
Last updated