Configuring Phirestream

Phirestream's settings file is located at /opt/phirestream/config/application.properties. The settings that can be set in this file are described below.

Phirestream must be restarted after modifying any of the settings. You can restart Phirestream with the following command:

sudo systemctl restart phirestream

HTTP Listener Settings

Setting	Description	Valid Values	Default Value
`http.host`	The interface on which the HTTP server listens. By default it listens on all interfaces.	Valid IP address	0.0.0.0
`http.port`	The port on which the HTTP server listens.	Valid port number	8080

HTTPS Listener

Configure the following settings to enable an HTTPS listener with one-way authentication.

Setting	Description	Valid Values	Default Value
`http.server.ssl`	Whether or not to enable HTTPS	true or false	false
`http.server.ssl.key-store`	The path to the keystore.	Valid file path.
`http.server.ssk.key-store-password`	The keystore password.	Valid password.
`http.server.ssl.trust-store`	The path to the truststore.	Valid file path.
`http.server.ssl.trust-store-password`	The truthstore password.	Valid file path.
`http.server.ssl.client-auth`	Whether or not client certificates are required, requested, or ignored.	required, requested, or none

HTTPS Client Authentication

Configure the following settings to enable HTTPS client (two-way) authentication.

Setting	Description	Valid Values
`http.server.ssl.trust-store`	The path to the truststore.	Valid file path.
`http.server.ssl.trust-store-password`	The truststore password.	Valid password.
`http.server.ssl.ssl.client-auth`	Whether or not client certificates are required, requested, or ignored.	required, requested, or none

Apache Kafka Client Settings

Setting	Description
`kafka.bootstrap.servers`	The location of the downstream Apache Kafka brokers.
`kafka.producer.acks`	The number of acknowledgments Phirestream must receive before considering the request complete.

Other Apache Kafka client configuration settings can be set by adding the prefix kafka. to the setting name. For example, if the Apache Kafka broker is using an SSL listener you can set the ssl.key.password setting by using kafka.ssl.key.password. Refer to the Producer Configuration options for the available settings.

Last modified: 08 November 2023