Configuration Reference

Below is the configuration reference to configure your Core API instance.

All values are optional, unless otherwise marked by: Required

Core API Specific Configuration

Config Key	Description	Values (Examples)	Default
service.ops.currency	Sets the currency to be used by the system. Use any value that can be passed to Currency.getInstance()	USD GBP	USD
service.item.expiryCheck.cron	Sets the interval at which expiry checks happen. In a cron format. Docs	0 0 * ? * * # Every Hour	0 0 * ? * * # Every Hour
service.tempDir	The directory to be used for temporary file creation and storage. Used for file uploads, and export bundle creation.	/tmp	/tmp/oqm-core-api
service.image.resizing.enabled	If the service is to resize images when they are uploaded (images for attached images, not images uploaded as generic files)	true false	true
service.image.resizing.height	The height to resize images to, in number of pixels.	500	750
service.image.resizing.width	The width to resize images to, in number of pixels.	500	${service.image.resizing.height}
service.image.resizing.savedType	The image format to use to save the resulting images as.	Either: jpg or: png	jpg

MongoDB Configuration

For Mongo configuration, we leverage the settings as presented by Quarkus. For convenience, we have the most important configuration below, but further options can be found on the Quarkus MongoDB Configuration documentation.

Please see MongoDB Reference for more information on how MongoDB is leveraged and used by the Core API.

Config Key	Description	Values (Examples)	Default
QUARKUS_MONGODB_CONNECTION-STRING Required	The connection string to actually connect to Mongo	mongodb://${user}:${pass}@${host}:${port}	None, must supply this value.
QUARKUS_MONGODB_DATABASE	The database to use for OQM. Also the prefix to use for specific datasets.	openQuarterMaster	openQuarterMaster

Kafka Configuration

For Kafka configuration, we leverage the settings as presented by Quarkus. For convenience, we have the most important configuration below, but further options can be found on the Quarkus Kafka Configuration documentation.

Config Key	Description	Values (Examples)	Default
mp.messaging.outgoing.events-outgoing.enabled Required	Whether or not to enable the messaging functionality.	Either: true or: false	None, must supply this value.
mp.messaging.outgoing.events-outgoing.bootstrap.servers Required, if kafka enabled	The kafka bootstrap server(s) to connect to.	OUTSIDE://{infra.kafka.host}:{infra.kafka.port}	None, must supply this value (if kafka enabled).

JWT Configuration

For JWT configuration, we leverage the settings as presented by Quarkus. For convenience, we have the most important configuration below, but further options can be found on the Quarkus JWT Configuration documentation.

Please see JWT Reference for more information on how MongoDB is leveraged and used by the Core API.

Config Key	Description	Values (Examples)	Default
smallrye.jwt.verify.key.location Required Or, some configuration that provides the certs for JWT verification.	The location of where to retrieve certs to verify JWT’s. Config property allows for a specified external or internal location of the public key. The value can be a relative path or a URL.	http://oqm-infra-keycloak:8080/realms/oqm/protocol/openid-connect/certs /path/to/cert.pub	None, must supply this value.

Metrics/OpenTelemetry Configuration

For OpenTelemetry configuration, we leverage the settings as presented by Quarkus. For convenience, we have the most important configuration below, but further options can be found on the Quarkus OpenTelemetry Configuration documentation.

Config Key	Description	Values (Examples)	Default
quarkus.otel.exporter.otlp.endpoint	Where to export OpenTelemetry metrics to.	http://#{host}:4317	None.