Configurations

In the Docker Compose deployment, the network ports listed in the following table are configured by default:

These ports can be reconfigured by following the steps in the corresponding sections that follow.

Note: After any changes are made to the port settings, you must rebuild the images and restart containers.

Edit install/docker-compose.yaml to change the nginx proxy configuration to use a different port.

services:
  tdq-nginx:
    build:
      context: tdq-nginx/dockerRoot
    container_name: tdq-nginx  
    ports:
      - "9800:80" # tdq-valet-ui

So, to run the Valet User Interface on port 8900, edit as follows:

services:
  tdq-nginx:
    build:
      context: tdq-nginx/dockerRoot
    container_name: tdq-nginx  
    ports:
      - "8900:80" # tdq-valet-ui

Then, edit the following properties in install/tdq-valet-ui/.env.development.tmpl to use the new port:

REACT_APP_AUTH_POST_LOGOUT_REDIRECT_URI=https://$HOSTDOMAIN:9800/index.html
REACT_APP_AUTH_REDIRECT_URI=https://$HOSTDOMAIN:9800/callback

Edit install/docker-compose.yaml to change the nginx proxy configuration to use a different port.

services:
  tdq-nginx:
    build:
      context: tdq-nginx/dockerRoot
    container_name: tdq-nginx  
    ports:
      …
      - "9801:81" # tdq-wso2

So, to run the WSO2 Identity Server on port 8901, edit as follows:

services:
  tdq-nginx:
    build:
      context: tdq-nginx/dockerRoot
    container_name: tdq-nginx  
    ports:
      …
      - "8901:81" # tdq-wso2

Also in docker-compose.yaml, change the following settings for the tdq-grafana service to use the new port:

tdq-grafana:
 	…
    Environment:
…
      - GF_AUTH_SIGNOUT_REDIRECT_URL=https://${HOSTDOMAIN}:9801/oidc/logout?post_logout_redirect_uri=https%3A%2F%2F${HOSTDOMAIN}%3A9807
	…
      - GF_AUTH_GENERIC_OAUTH_AUTH_URL=https://${HOSTDOMAIN}:9801/oauth2/authorize

Then, edit the following properties in install/tdq-valet-ui/.env.development.tmpl to use the new port:

REACT_APP_AUTH_AUTHORITY_URL=https://$HOSTDOMAIN:9801/oauth2/token

Then, edit install/tdq-wso2/dockerRoot/config/repository/conf/deployment.toml to set the new port here:

[transport.https.properties]
proxyPort = 9801

To remove access to the WSO2 console, edit install/tdq-nginx/dockerRoot/server-wso2.tmpl. Find this section of the file:

    location / {
      # Reject requests with unsupported HTTP method
      resolver 127.0.0.1;

      if ($request_method !~ ^(GET|POST|PUT|DELETE|HEAD|OPTIONS|PATCH)$) {
        return 405;
      }

      proxy_pass https://${LOCATION_HOSTNAME}:${LOCATION_PORT}/;
      proxy_pass_header Server;
      proxy_set_header Host $server_name;
      proxy_set_header X-Forwarded-Host $host;
      proxy_set_header X-Forwarded-Server $host;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_read_timeout 5m;
      proxy_send_timeout 5m;
    }
  }

Edit as follows:

    location / {
      # Reject requests with unsupported HTTP method
      resolver 127.0.0.1;

      if ($request_method !~ ^(GET|POST|PUT|DELETE|HEAD|OPTIONS|PATCH)$) {
        return 405;
      }

      proxy_pass https://${LOCATION_HOSTNAME}:${LOCATION_PORT}/;
      proxy_pass_header Server;
      proxy_set_header Host $server_name;
      proxy_set_header X-Forwarded-Host $host;
      proxy_set_header X-Forwarded-Server $host;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_read_timeout 5m;
      proxy_send_timeout 5m;
    }

    location /carbon/ {
      # Reject requests to admin console
      return 401;
    }
  }

Edit install/docker-compose.yaml to change the nginx proxy configuration to use a different port.

services:
  tdq-nginx:
    build:
      context: tdq-nginx/dockerRoot
    container_name: tdq-nginx  
    ports:
      …
      - "9803:83" # tdq-valet-services

So, to run the Valet API Server on port 8903, edit as follows:

services:
  tdq-nginx:
    build:
      context: tdq-nginx/dockerRoot
    container_name: tdq-nginx  
    ports:
      …
      - "8903:83" # tdq-valet-services

Then, edit the following properties in install/tdq-valet-ui/.env.development.tmpl to use the new port.

# Base url for API requests
REACT_APP_API_BASE_URL=https://$HOSTDOMAIN:9803

Edit install/docker-compose.yaml to change the nginx proxy configuration to use a different port.

services:
  tdq-nginx:
    build:
      context: tdq-nginx/dockerRoot
    container_name: tdq-nginx  
    ports:
      …
      - "9807:87"  # tdq-grafana

So, to run the Watchdog on port 8907, edit as follows:

services:
  tdq-nginx:
    build:
      context: tdq-nginx/dockerRoot
    container_name: tdq-nginx  
    ports:
      …
      - "8907:87"  # tdq-grafana

Also in docker-compose.yaml, change the following settings for the tdq-grafana service to use the new port:

    environment:
	…
      - GF_SERVER_ROOT_URL=https://${HOSTDOMAIN}:9807
      …
      - GF_AUTH_SIGNOUT_REDIRECT_URL=https://${HOSTDOMAIN}:9801/oidc/logout?post_logout_redirect_uri=https%3A%2F%2F${HOSTDOMAIN}%3A9807

Then, edit the following properties in install/tdq-valet-ui/.env.development.tmpl to use the new port:

# Watchdog url
REACT_APP_WATCHDOG_URL=https://$HOSTDOMAIN:9807

The Postgres database is exposed on port 9543 for the convenience of users who might want to use it for reporting or analysis purposes. The application does not require that it be exposed and for security reasons, some users may wish not to expose it. To change the exposed port or remove it, edit install/docker-compose.yaml.

  tdq-postgres:
    …
    ports:
      - "9543:5432"

To change the port for the Postgres database to 8943, you would edit as follows:

  tdq-postgres:
    …
    ports:
      - "8943:5432"

To remove the port, either delete those two lines, or comment them:

  tdq-postgres:
    …
    #ports:
    #  - "9543:5432"

You can configure the following environment variables for User Interface by editing the install/tdq-valet-ui/.env.development.tmpl file.

Note: Changes will not take effect until the tdq-valet-ui image is rebuilt.

Timezone

# Setup timezone for user information display
REACT_APP_USER_TIMEZONE=America/New_York

Date Format

# Setup Date format for user display
REACT_APP_DATE_FORMAT="MM/DD/YY h:mm A"

File Upload Limit

# Setup File upload limit in bytes (allows users to upload upto max this size)
REACT_APP_TOTAL_FILE_UPLOAD_LIMIT_BYTES="5368709120"

Values for Business Impact

# Setup numeric values for Business Impact used for Data Profile and DQ scoring
REACT_APP_BUSINESS_IMPACT_HIGH_VALUE=10
REACT_APP_BUSINESS_IMPACT_MEDIUM_VALUE=5
REACT_APP_BUSINESS_IMPACT_LOW_VALUE=1

Profile Score Thresholds

# Setup Profile score thresholds (Note: between values is a warning)
# i.e if the 2 values are 50 and 74; 0-49=Bad; 50-74=Warning; 75-100=Good
REACT_APP_PROFILE_SCORE_BAD_WHEN_LT_VALUE=50
REACT_APP_PROFILE_SCORE_GOOD_WHEN_GT_VALUE=74

DQ Score Thresholds

# DQ scoring thresholds (Note: between values Get Docker | Docker Documentationis a warning)
REACT_APP_DQ_SCORE_BAD_WHEN_LT_VALUE=50
REACT_APP_DQ_SCORE_GOOD_WHEN_GT_VALUE=74

Observation Limit for Correlation Analysis

# Setup max number of observations for correlation analysis  (# of Variables X Row Count)
REACT_APP_TOTAL_OBSERVATIONS_LIMIT="500000"