Skip to end of metadata
Go to start of metadata

Securing the Controller

If you plan on using the Uptime Controller by integrating API functions with the Uptime Infrastructure Monitor Web interface, consider doing the following to prevent several common browser-related warnings when navigating secure and non-secure pages within the same web page:

Reflecting Configuration Changes in the Proxy

As part of the Uptime Infrastructure Monitor installation process, a proxy is configured in the <uptimeDirectory>\apache\conf\httpd.conf file. This provides ease of use with the Uptime Controller, as it simplifies many API programming tasks, and helps to ensure the Controller remains secure.

By default the proxy section should look like the following:

The proxy is configured to work using the default options and configuration choices made when Uptime Infrastructure Monitor is installed:

  • the Monitoring Station (<uptimeHost> above) and Uptime Controller (<controllerHost> above) are part of the same installation (i.e., they have the same value), and assumed to be on the same host
  • the port the Controller uses to communicate with Uptime Infrastructure Monitor is 9997

If there are changes to the way Uptime Infrastructure Monitor is deployed on the network, you need to modify the Apache Web server configuration file, accordingly: 

Deployment ChangeAffected Proxy Setting
change the API hostname or move the API to another server<controllerHost>
change the API port9997
when on running on different servers, the Monitoring Station's network location is changed

<uptimeHost>

After making any change, restart the Uptime Web Server service (on the correct Uptime Infrastructure Monitor instance, if applicable) to apply these changes. Then verify that you correctly configured the proxy by browsing to https://<uptimeMonitoringStation>/api. The behavior should be identical to browsing to the Uptime Controller at https://<uptimeController>/api.

Controller Configuration Parameters

The following list details several common Uptime Controller configuration tasks.

TaskSettingConfiguration Location in <uptimeDirectory>\controller\Notes
change Controller portUptime  Contoller port\etc\jetty-ssl.xmlTo change the port, find this line within jetty-ssl.xml:
<Set name="Port"><Property name="jetty.port" default="9997"/></Set>
          

Update the 9997 value to an unassigned port, and then restart the Uptime Controller service.

change Controller DataStore targetdatabase connection settings\resources\uptime-controller.conf

Example connection fields and options are provided for all supported DataStore back-end platforms. By default, the Uptime Controller uses a standard MySQL DataStore connection (unless you updated these values during installation).

dbType=MYSQL
dbHostname=localhost
dbPort=3308
dbName=uptime
dbUsername=uptime
dbPassword=uptime
dbJdbcProperties=

To change the connection details, update these fields with your database platform information. There are example entries in the configuration file.

After you have updated your settings, restart the Uptime Controller service.

indicate where PHP sessions are storedPHP session directory\resources\uptime-controller.conf

By default, the phpSessionDirectory parameter is not defined, and Uptime Infrastructure Monitor looks for stored sessions in the Apache work space:

  • <uptimeDirectory>\apache\tmp (Windows)
  • /usr/local/uptime/apache/tmp (Linux)

change Controller logging level

logging level\resources\uptime-controller.conf

The Controller automatically logs events in the /logs directory. Logging levels include the following:

  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
  • FATAL

By default, the logging level is INFO.

After you have updated your settings, restart the Uptime Controller service.

install new Controller SSL certificateSSL communication
\etc\jetty-ssl.xml
To install a new key, follow steps 3 and 4 from Configuring SSL/TLS, and then restart the Uptime Controller service.
configure SSL/TLS parametersSslContextFactory
\etc\jetty-ssl.xml
serverIncludeCipherSuites=ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-
SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-
SHA384:ECDHE-RSA-AES256-SHA384 serverIncludeProtocols=TLSv1.2 # serverExcludeCipherSuites= serverExcludeProtocols=SSLv3
  • No labels