Table of Contents

Driven Administrator Guide

version 1.2

Configuring the Driven Server

You can configure the Driven Server by using the file that is in the ${DIR}/conf/ directory.

Single-Node Environments

The default settings in the Driven Server configuration file are sufficient for a basic single-node installation with an embedded Elasticsearch datastore to start up. However, email notifications cannot be enabled until the SMTP properties are configured.

Clustered Production Environments

Driven uses Elasticsearch for persistence. To use an external Elasticsearch cluster, you must change properties to tell Driven how to communicate with Elasticsearch. You can also customize settings for embedded Elasticsearch persistence, such as where the data is written to disk.

Enabling SMTP Notifications

You must enable and configure SMTP for Driven if you want the deployment to operate with notifications. Notifications support the Teams feature of Driven. (See Configuring Teams for Collaboration in the Driven User Guide for more information about this feature.) Notifications also are required if you want to allow users to reset their Driven passwords.

  1. Enable and configure SMTP by setting the relevant parameters in the following properties list. In the following list, most parameter settings are only examples to show the format and source for your environment’s settings.

  2. Configure Driven with its external URL so that emails contain the correct hyperlinks by setting the following property:


Configuring the Elasticsearch Datastore

The parameters in the file configure the Elasticsearch datastore. The parameters that you need to set and how you set them depends on the deployment environment that you are selecting. Follow the section below that pertains to your deployment.

Driven Storage Parameters for Embedded Elasticsearch Nodes

Review the following file parameter information if you are deploying Driven to a single-node topology.

  • HTTP API Access: Set the following parameter to "true" if you want to permit API access to Elasticsearch on port 9200.
  • CORS Requests: Set the following parameter to "true" if you want to enable cross-origin resource sharing (CORS) requests. The CORS mechanism can be useful for troubleshooting, such as running the elasticsearch-head plugin.
  • Data Storage Location: By default, data is stored in the /driven directory, which is in the main directory of the Driven-packaged Tomcat installation. If you want to save data in a different location, specify the path in the following parameter.
Most properties are ignored when running with an external Elasticsearch datastore. When the datastore is external, Elasticsearch uses the settings in its own configuration file (elasticsearch.yml).

Driven Storage Parameters for Stand-alone Elasticsearch Nodes

Review the following file parameter information if you are deploying Driven to a clustered production environment.

  • runlocal Property: Set this property to "false" as shown in the following:
  • Elasticsearch Host Information: You must specify the nodes of the Elasticsearch cluster by setting the parameter. Set the parameter using the format in the following line:<_host IP or DNS node1_>:9300,<_hostIP or DNS node2_>:9300,<_hostIP or DNS node3_>:9300
  • Elasticsearch Cluster Name: You must specify the Elasticsearch cluster name for Driven. The setting for this property must match the setting for the property in the elasticsearch.yml file for the external Elasticsearch cluster.

AWS-Hosted Elasticsearch Instances

If you run Elasticsearch on Amazon Web Services (AWS), the discovery settings in the elasticsearch.yml file can be configured to enable security groups or availability zones. You can configure Driven to support these discovery methods by setting the following relevant parameters in the file:

Next Driven Server Task

Complete your Driven deployment by following the steps documented in Starting the Driven Server.