Setup and Installation: Docker

Setting up Testsigma Tunnel with Docker ensures secure and reliable connections for your test automation. This article discusses installing Testsigma Tunnel using Docker.

Prerequisites

Before you begin, ensure that you have referred to:

1. Documentation on key components.

Setup Testsigma Tunnel Using Docker

1. Create a docker-compose.yml file in your project directory with the following content:

US Region:

  services:
     testsigma-tunnel:
     image: testsigmainc/testsigma-tunnel:<arm64/amd64>-latest
     container_name: testsigma-tunnel
     environment:
          - KEY=<API_KEY>
          - TUNNEL_NAME=<NAME_OF_TUNNEL>
          - CONNECTIONS=<NUMBER>
          - INACTIVE_TIMEOUT=<NUMBER in seconds>
          - VERBOSE=true/false

IN Region:

  services:
     testsigma-tunnel:
     image: testsigmainc/testsigma-tunnel-in:<arm64/amd64>-latest
     container_name: testsigma-tunnel
     environment:
          - KEY=<API_KEY>
          - TUNNEL_NAME=<NAME_OF_TUNNEL>
          - CONNECTIONS=<NUMBER>
          - INACTIVE_TIMEOUT=<NUMBER in seconds>
          - VERBOSE=true/false

EU Region:

  services:
     testsigma-tunnel:
     image: testsigmainc/testsigma-tunnel-eu:<arm64/amd64>-latest
     container_name: testsigma-tunnel
     environment:
          - KEY=<API_KEY>
          - TUNNEL_NAME=<NAME_OF_TUNNEL>
          - CONNECTIONS=<NUMBER>
          - INACTIVE_TIMEOUT=<NUMBER in seconds>
          - VERBOSE=true/false

2. Replace the placeholder values in the docker-compose.yml file:

   • <API_KEY>: Your Testsigma authentication key.
   • <NAME_OF_TUNNEL>: The name of your tunnel.
   • <NUMBER>: The number of connections to establish.
   • <NUMBER in seconds>: The inactive timeout duration.
   • true/false: Set to true for verbose logging or false to disable it.
3. Run the following command to start the Testsigma Tunnel service:
   docker compose up -d
4. Once the service is running, logs will indicate that Testsigma Tunnel is active. Use the tunnel name for your automation tests.
5. To stop the service, use the following command:
   docker compose down