Overview
pulse™ provides a number of startup options that allow you to customise the pulse™ deployment. One way to specify configuration options is by using a properties file named config.properties. This file is located (by default) at $HOME/.pulse/config.properties for the pulse™ master and $HOME/.pulse-agent/config.properties for agents. The benefit of using the properties file is that pulse™ will be able to use the same configuration even after an upgrade.
Creating the Configuration File
Master
When the pulse™ master starts up for the first time, it will try to create a template config file for you. This file will contain default values for all of the available properties. During the Setup Wizard pulse™ will also store the value of the selected data directory. This allows new versions of pulse™ to locate the data when upgrading.
If pulse™ is unable to locate the file, it will enter the Setup Wizard and prompt you for the data directory.
Agents
By default, agents do not use a configuration file. To configure agents, you must create the file manually in the expected location ($HOME/.pulse-agent/config.properties).
Configuration
To use this configuration file to configure pulse, first ensure the file exists. When adding your configuration properties to the file, ensure that you use a new line for each property. Properties should be added in the following format:
<property key>=<property value>
Below is a list of the properties that pulse™ supports:
| Property |
Description |
| pulse.data |
The location of the pulse data directory. |
| ssl.enabled |
If true, pulse™ will use https instead of http. Requires ssl.password and ssl.keyPassword to be set. |
| ssl.keystore |
Path to the SSL key store file. |
| ssl.keyPassword |
Password for the SSL key to use. |
| ssl.password |
Password for the SSL key store. |
| webapp.port |
The port on which the pulse™ web application will listen for requests. |
| webapp.contextPath |
The context path for the pulse™ web application. |
Example
To start pulse on port 80 and to use the /absolute/path/to/data directory as the pulse data directory, add the following to the config.properties file:
Changing the Location of the Configuration File
If you wish to store the configuration in a file other than the default, you can specify the location of the file to pulse™ in two ways:
- By passing -f <config file> to the start command
- By setting an environment variable named PULSE_CONFIG to the absolute path of the file you wish to use
Examples
Using the -f flag:
Using PULSE_CONFIG in a bash shell:
