@applitools/execution-grid-tunnel/README.md

Allows user to run tests with exection-grid and navigate to private hosts and ips

# execution-grid-tunnel

Allows user to run tests with exection-grid and navigate to private hosts and ips 

## Installing

```sh
npm install @applitools/execution-grid-tunnel
```

## Using the package to run execution-grid-tunnel

```js
const startExecutionGridTunnel = require('@applitools/execution-grid-tunnel')

const {cleanupFunction, port} = startExecutionGridTunnel()
```

## Environment Variable

* APPLITOOLS_EG_TUNNEL_PORT - The port of execution-grid-tunnel service (by default, the service listens to a random port)
* APPLITOOLS_EG_TUNNEL_MANAGER_URL - execution-grid-tunnel-manager-url (by default, https://exec-wus.applitools.com)
* APPLITOOLS_EG_TUNNEL_MIN_PORT_RANGE - min port range
* APPLITOOLS_EG_TUNNEL_MAX_PORT_RANGE - max port range
* APPLITOOLS_EG_TUNNEL_MODE_ENV - if you want to see the logs on the screen set the value to 'development'
* APPLITOOLS_EG_TUNNEL_LOG_LEVEL - Execution grid logs level