Optional settings

Most relevant configuration settings are described in more detail under the particular installation method section. For the optional settings described below you would be editing the TethysDash.conf file corresponding to the particular installation method.

Asynchronous notifications

Besides email, TethysDash can also send out asynchronous notifications using two possible mechanisms: Pusher (with the notifications reflected in the FleetStatus frontend); and Slack (with the notifications reflected in the selected Slack channel). Both of these are optional.

  • Pusher. Assuming you already have a Pusher account, visit https://dashboard.pusher.com/ and create an application for purposes of your TethysDash instance. Take note of the credentials of the created application: app_id and key, and secret, which you will need to indicate in the async.pusher.url property.

  • Slack. TethysDash uses this API to post notifications on a desired Slack channel. Create a Slack "webhook" and take note of corresponding URL.

To specify any of the Pusher or Slack settings, edit the async section in TethysDash.conf to uncomment the relevant lines and enter the values as appropriate:

async {

  # pusher notifications, enabled if pusher.url is defined
  pusher {
    #url = "http://???:???@api.pusherapp.com:80/apps/????"

    # corresponding appKey:
    #appKey = "???"

    eventChannelName = "td-events"
  }

  # slack notifications, enabled if slack.webHook is defined
  slack {
    # A Slack web hook looks like "https://hooks.slack.com/services/xxx/yyy/zzz"
    #webHook  = "..."

    primaryChannel  = "#LRAUVs"
    username = "lrauv"

    # Used for links in posted messages.
    # Adjust the server part (http://localhost here) depending on how you
    # will be exposing the system externally.
    dataLink = "http://localhost/TethysDash/data"
  }
}

ReCAPTCHA

TethysDash can use the ReCAPTCHA mechanism to greatly reduce the risk of spam in user account creation. This is optional but highly recommended. Follow the Google documentation to register your TethysDash site. Capture the generated privateKey and siteKey in corresponding fields under the recaptcha section in TethysDash.conf:

recaptcha {
  # privateKey - the private key associated with your ReCaptcha API key
  privateKey = "..."

  # siteKey - corresponding site (public) key
  siteKey = "..."
}