Configuration Overview

This page contains descriptions of the configuration and logging files that are used by the OpenDXL Broker.

Directory Structure and File Summary

The directory structure of the OpenDXL Broker logging and configuration files is as follows:

config\
    dxlbroker.conf.defaults
    console\
        dxlclient.config
        dxlclient.config.tmpl
        dxlconsole.config
       logging.config
keystore\
    broker.crt
    broker.key
    ca-broker.crt
    ca-broker.key
    ca-broker.srl
    ca-brokers.lst
    ca-client.crt
    ca-client.key
    ca-client.srl
logs\
    console.log
    dxlbroker.log
policy\
    brokerstate.policy
    general.policy
    topicauth.policy

Each of the files and directories listed above are described in detail below.

Directory	File Name	Description
config\		This directory and its sub-directories contain all of the configuration files for the OpenDXL Broker and its associated management console.
	dxlbroker.conf.defaults	The configuration file for the OpenDXL broker. See dxlbroker.conf.defaults for detailed information regarding this configuration file.
console\		This directory contains configuration files for the OpenDXL Broker Management Console.
	dxlclient.config	This file contains the information necessary for the OpenDXL Broker Management Console to connect to the OpenDXL Broker. NOTE: This file should never need to be modified.
	dxlclient.config.tmpl	This template file is used to create the client configuration file that is included with a generated client configuration package (see Generate Configuration Page). The dxlclient.config file that is created from this template contains the settings necessary for OpenDXL clients to connect to the OpenDXL Broker. This file can be edited to include additional host names, IP addresses, and ports for resolving a connection to the OpenDXL Broker.
	dxlconsole.config	The configuration file for the OpenDXL Broker Management Console. See dxlconsole.config for detailed information regarding this configuration file.
	logging.config	Configuration file that contains logging settings for the OpenDXL Broker Management Console.
keystore\		This directory contains the required PKI files for the OpenDXL Broker.
	broker.crt	The certificate for the OpenDXL Broker.
	broker.key	The private key for the OpenDXL Broker.
	ca-broker.crt	The bundle of certificate authorities (CAs) for the broker. This bundle is used by OpenDXL clients to determine the authenticity of the broker that is being connected to.
	ca-broker.key	The private key for the Broker Certificate Authority (CA). This key is used to sign broker certificates.
	ca-brokers.lst	This file contains a list of thumbprints for broker certificates and/or CAs that are used to validate that a broker establishing a bridge to this broker is authorized. (validate incoming connections)
	ca-client.crt	The bundle of certificate authorities (CAs) for OpenDXL clients. This bundle is used by the broker to determine the authenticity of connecting OpenDXL clients.
	ca-client.key	The private key for the Client Certificate Authority (CA). This key is used to sign client certificates.
logs\		This directory contains the log files associated with the OpenDXL Broker.
	console.log	The log file for the OpenDXL Broker Management Console.
	dxlbroker.log	The log file for the OpenDXL Broker.
policy\		Contains policy information for the OpenDXL Broker. Policy files differ from configuration files due to the fact that they must be identical across all of the brokers in a DXL fabric (configuration files contain broker-specific settings).
	brokerstate.policy	The purpose of the broker state policy file is to define how the brokers comprising a DXL fabric should connect (bridge) to each other. (See brokerstate.policy for more information)
	general.policy	General settings for the fabric.
	topicauth.policy	The topic authorization file contains authorization rules for topics on a DXL fabric. (See topicauth.policy for more information)