Install TestGear

Requirements

https://docs.docker.com/compose/install/open in new window

Docker Engine 17.09.0 or higher

Docker Compose 1.17.0 or higher

Package Contents

  • .env - configuration file.
  • docker-compose.yml - Docker Compose configuration file.
  • docker-compose.elk.yml - Docker Compose configuration file with Elasticsearch, Logstash, Kibana.
  • backup.sh - backup initiation script.
  • restore.sh - backup restore script.
  • images.tar.gz - Docker images archive (available in the offline installation archive only).

Prerequisites

Before installation, you need to change the default values and secrets in the .env file.

  1. Set the parameters vm.max_map_count=262144 and vm.overcommit_memory=1:

    echo 'vm.max_map_count=262144' >> /etc/sysctl.conf
    echo 'vm.overcommit_memory = 1' >> /etc/sysctl.conf
    sysctl -p
    
  2. For security reasons, we recommend blocking all incoming ports other than port 80 from accessing the user interface. Optionally, to service the system via SSH, open port 22 (it can be reassigned to a specific configuration). If you use HTTPS, open port 443. Example for CentOS7 (enables access to ports 80 and 22):

    firewall-cmd --zone=public --add-port=80/tcp --permanent
    firewall-cmd --zone=public --add-port=22/tcp --permanent
    firewall-cmd --zone=public --add-port=443/tcp --permanent
    firewall-cmd --reload
    
  3. [Optional] enable user actions logging. By default, this feature is disabled.

Offline Installation

This type of installation enables you to install the product if the server is isolated from the internet, and it is not possible to get a Docker image from public repositories.

  1. Reach out to us on our websiteopen in new window to get the distribution kit.
  2. Unzip the contents of the offline installation archive to a folder, for example, ~/testgear.
    • If you are using Docker Compose version 1.20.0 or later, do the following:
      cd ~/testgear
      docker load -i images.tar.gz
      docker-compose -f docker-compose.yml --project-name prod up --detach --timeout 120
      
    • If you are using Docker Compose version 1.17.0-1.19.0, do the following:
      cd ~/testgear
      docker load -i images.tar.gz
      docker-compose -f docker-compose.yml --project-name prod up -d
      

Online Installation

  1. Download the online installation files from the download pageopen in new window. Unzip the contents of the online installation archive to a folder such as ~/testgear.
    • If you are using Docker Compose version 1.20.0 or later, do the following:

      cd ~/testgear
      docker-compose -f docker-compose.yml --project-name prod up --detach --timeout 120
      
    • If you are using Docker Compose version 1.17.0-1.19.0, do the following:

      cd ~/testgear
      docker-compose -f docker-compose.yml --project-name prod up -d
      

Restart the System

Run the following command to restart the system:

docker-compose -f docker-compose.yml --project-name prod restart --timeout 120

Full Data Cleaning

Note

To save the information from TestGear for further usage, run the command without the --volumes flag:

docker-compose -f docker-compose.yml --project-name prod down --timeout 120

To completely remove the system and its data, run the following command:

docker-compose -f docker-compose.yml --project-name prod down --volumes --timeout 120