Enable TeamForge (PostgreSQL Datamart) for queries from external tools

You must enable, then re-start TeamForge so that you can use an external tool to query the datamart directly.

You cannot use external reporting tools to connect directly to a datamart if you have a single-box installation using localhost:SERVICES.

  1. Edit the site-options.conf file. Set REPORTS_DB_ACCESS_HOSTS to the IP address or IP address range (CIDR address) from which the tool will establish connection to the datamart. Specify multiple IPs as a comma-separated list. For example: REPORTS_DB_ACCESS_HOSTS = 10.0.0.2,10.2.1.0/24
    Note:
    • If the TeamForge site is not within your network and a Network Address Translation (NAT) is configured, then specify the NAT's external facing IP in the token.
    • If you have used an "advanced" installation method to install TeamForge, you must also manually add the IP addresses to the pg_hba.conf file.
  2. In site-options.conf, set REPORTS_DATABASE_READ_ONLY_USER and REPORTS_DATABASE_READ_ONLY_PASSWORD with your user and password.
  3. On the TeamForge host machine, enable REPORTS_DATABASE_HOST and REPORTS_DATABASE_PORT for remote access.
  4. Provision services.
    • teamforge provision
    Note:

    TeamForge 17.4 (and later) installer expects the system locale to be LANG=en_US.UTF-8. TeamForge "provision" command fails otherwise.

You can now enable trusted users to establish connections by providing them with values of options REPORTS_DATABASE_HOST, REPORTS_DATABASE_PORT, REPORTS_DATABASE_READ_ONLY_USER, and REPORTS_DATABASE_READ_ONLY_PASSWORD.