Configuration and Logging

Table of Contents

• Overview
• Directory Structure and File Summary
• Detailed file descriptions
  • dxlbroker.conf
  • dxlconsole.config

Overview

This pages 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
    console\
        dxlclient.config
        dxlclient.config.tmpl
        dxlconsole.config
       logging.config
keystore\
    broker.crt
    broker.key
    ca-broker.crt
    ca-broker.key
    ca-client.crt
    ca-client.key
logs\
    console.log
    dxlbroker.log
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	The configuration file for the OpenDXL broker. See dxlbroker.conf 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 Client 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-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.
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. This directory is for future enhancements and is not currently being used.

dxlbroker.conf

The dxlbroker.conf file contains configuration settings for the OpenDXL Broker. While the majority of settings in this file should not be changed, the following table contains a subset of properties that are candidates for modification:

Name	Default	Description
maxLogFiles	10	The maximum number of log files to create (log files are rotated).
messageSizeLimit	1048576	The maximum message size (in bytes) that can be sent over the fabric.
listenPort	8883	The listen port for the broker with the conainer. NOTE: This is the port of the broker within the container (not the one mapped externally via the host). This value should never be changed as it would require a change to the associated Dockerfile.
logLevel	info	The logging level for the broker. Valid values include: debug, info, warn, and error.
logNotices	false	Whether to log "notice" messages (when a client connects/disconnects, etc.).

dxlconsole.config

The dxlconsole.config file contains configuration settings for the OpenDXL Broker Management Console. While the majority of settings in this file should not be changed, the following table contains a subset of properties that are candidates for modification:

Name	Default	Description
username	admin	The user name required to login to the management console.
password	password	The password required to login to the management console. NOTE: This password should be changed immediately after the OpenDXL Broker is deployed.