Configuration files

GroundWork 8 has default settings that will work for most environments, but there are some adjustment you can make, and may need to make, to allow it to be used in one or more of your networks. These various settings can be specified in the following configuration files in the gw8 directory.

gw8.env

Timezone

The TZ  variable sets the timezone for the cron job schedule. The default is Etc/UTC if not set. The format is the same as the Linux Timezone setting.

Examples:

America/New_York
America/Chicago
America/Denver
America/Phoenix
America/Los_Angeles
etc.

For example, to set the time zone to the West Coast of the USA, change the line to say:

TZ=America/Los_Angeles

NoMa sendEmail SMTP

SMTPSERVER_* - settings for NoMa (and, in 8.1.0 and above, Nagios) sendEmail SMTP server configuration. The default is the docker host port 25 if not set. For more detailed information see How to enable sendEmail with TLS with NoMa.

SMTPSERVER_SERVERPORT=<server>:<port>
SMTPSERVER_TLS=<auto|yes|no>
SMTPSERVER_AUTHUSER=<username>
SMTPSERVER_AUTHPASS=<password>

Example, (Gmail):

SMTPSERVER_SERVERPORT=smtp.gmail.com:587
SMTPSERVER_TLS=yes
SMTPSERVER_AUTHUSER=mygmailaccount@gmail.com
SMTPSERVER_AUTHPASS=mygmailapppassword

docker-compose.override.yml

Subnet used by the GW8 containers

The networking settings are designed to avoid conflicts in your networking setup. If you use the 172.16.0.0/12 subnet anywhere internally, you will want to make sure there isn't a conflict with the subnet used by Docker. You may not be able to use the system until you correct this conflict. You may adjust it in the docker-compose.override.yml file by specifying the subnet used by the GW8 containers. See the comments in the file for details. This file is in the gw8 directory.

Postgres InfluxDB ports

GroundWork Monitor 8.1.0 and later will ship with only ports 80, 443, and 5667 NSCA open. In some cases you may want direct access to postgres and/or InfluxDB, for example if you want to use InfluxDB for reporting data from a reporting designer. Port settings are specified in the docker-compose.yml file, but editing this file is not supported, and in fact is highly discouraged. To close or open InfluxDB or PostgreSQL ports, edit the docker-compose.override.yml file in the gw8 directory. Removing # will open the indicated ports:

influxdb:
   # ports:
     # - "8086:8086"   # InfluxDB
pg:
  # ports:
     # - "5432:5432"   # PostgreSQL

After making changes to docker-compose-override.yml, you must restart the GroundWork containers with: 

$ docker-compose down
$ docker-compose up -d

Security administration

If you expose these ports, you should be prepared to manage the PostgreSQL/InfluxDB security administration. This primarily means password and identity management on these databases, which you can do as you would any postgres or Influxdb system. In some cases it may require configuring firewalls on the host or its network. 

Related articles