Environment Variables

DecisionRules Environment Variables

All variables can be set either in the docker-compose configuration file or directly as a command-line parameter before running the containers.

License Key Validation

Your server must have access to host https://license.decisionrules.io/. You won't be able to start the container without the connectivity to the license server.

Server environment variables

Variable name	Description	Mandatory	Version	Example value
REDIS_URL	Redis URL	Yes		redis(s)://host.docker.internal:6379
SOLVER_REDIS_URL	Redis URL for solver	Yes	Not needed from version 1.6.0, will use REDIS_URL instead	redis(s)://host.docker.internal:6379
MONGO_DB_URI	Mongo URL	Yes		mongodb(+srv)://host.docker.internal:27017
CLIENT_URL	Url on which client container is accessible	Yes		http://localhost:80/# (# is mandatory)
LICENSE_KEY	License key string	Yes		YOUR LICENSE KEY
DB_TYPE	Specify MongoDB type	If you use CosmosDB or DocumentDB	>= 1.8.2	MONGODB (default) COSMOSDB DOCUMENTDB
API_URL	Lets the server know it's own address for Rule Flow and dependant rule solves.	Yes*	The server will run without this variable but Rule Flow and Solve functions might not work	https://api.decisionrules.io

Optional server environment variables

Variable name	Description	Mandatory	Version	Example value
MONGO_TLS_CA_FILE	Path to file with one or more certificate authorities to trust when making a TLS connection.	No	>= 1.18.4.4	/certificates/ca.pem
MONGO_TLS_CERTIFICATE_KEY_FILE	Path to the client certificate private key file. This key is often included within the certificate file itself.	No	>= 1.18.4.4	/certificates/private.pem
BRAND_LOGO_URL	Custom brand Logo URL. Feature must be enabled in license key. Learn more in the Brand Logo Guide	No	>= 1.17.0	https://example.com.img/logo.ong OR data:image/png;base64,iVBORw0KGgoAAAANSUhE...
SHOWCASE	Turn on or off showcase mode	No		true/false
WORKERS_NUMBER	Sets number of workers (threads) of application OR set "auto" to allocate all CPU cores	No		1 OR auto
BI_MONGO_DB_URI	If you have a separate database cluster for Business Intelligence App	No	>= 1.10.0	mongodb(+srv)://host.docker.internal:27018
SAML_ENTRY_POINT	URL for your identity provider login page	No		https://devX.okta.com/app/name/HASH/sso/saml
SAML_ISSUER	Issuer string to supply to IdP	No		okta.com/HASH_STRING
SAML_CERT	Public certificate of provider. In RAW format as single line without BEGIN CERTIFICATE and END CERTIFICATE	No		MIIC8DCCAdigAwIBAgIQap4GhMRA26tJGFD.....
SAML_CALLBACK_URL	Callback URL where provider send response	No		https://api.decisionrules.io/saml/callback
RF_TIMEOUT	Time in milliseconds after which the process of solving a rule flow is stopped	No		5000
SR_TIMEOUT	Time in milliseconds after which the process of solving a scripting rule is stopped	No		5000
WORKFLOW_TIMEMOUT	Time in milliseconds after which the process of solving a workflow is stopped	No	>=1.19.0	10000
RF_NODE_LIMIT	Integer of desired rule flow nodes, default value is 30	No		30
SWAGGER_HOST	Host of the server application which will use swagger	No		api.decisionrules.io
WHITELIST	List of allowed domains from which it is possible to register or log in. You can setup multiple domains separated with comma.	No		mydomain.com, yourdomain.io
ALLOWLIST	Cultural-neutral synonym for WHITELIST.	No		mydomain.com, yourdomain.io
TELEMETRY	It turn on/off telemetry, which measures endpoint execution duration (for example: Solver API)	No	>= 1.8.1	On = 1, off = 0
EXAPI_MAX_CNT_LEN	Defined maximal response content length in bytes	No		3000
EXAPI_MAX_BODY_LEN	Defined maximal body size for request in bytes	No		10000
EXAPI_MAX_REDIRECTS	Defines maximal redirects that called URL can perform	No		5
EXAPI_TIMEOUT	Defines API connection timeout in milliseconds	No		2000
DT_HTTP_CALL_LIMIT	Defined limit for http function that can be defined in DT or DTR	No	>= 1.12.0	100
LOGGER_TYPE	Select log output format/logger type STRING is default value if not env variable is set	No		Possible options: STRING JSON
LOGGER_TIMESTAMP_UTC	Select log timestamp format If true: YYYY-MM-DDTHH:mm:ss.SSSZ if false: YYYY-MM-DDTHH:mm:ss.SSS(+-)HH:mm	No	>= 1.14.2	true/false
REDIS_PING_INTERVAL	Duration (in milliseconds) for which the server pings the Redis server.	No	>= 1.14.3	300000
FLUSH_REDIS_ON_STARTUP	Whether cache should be flushed when server is starting. Defaults to true.	No	>= 1.17.0	false
TIMEZONE	Default time zone for date functions. Default is: Europe/Prague	No	>= 1.13.1	Full list is available here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
REDIS_CACERT	CA certificate for TLS connection with Redis	No	>= 1.14.5	CA certificate as a single line without BEGIN CERTIFICATE and END CERTIFICATE. For example(MIIC8DCCAdigAwIBAgIQap4GhMRA26tJGFD...)
MONGO_MIN_POOL_SIZE	MongoDB connection minimal pool size	No	>= 1.16.2	5
MONGO_MAX_POOL_SIZE	MongoDB connection maximal pool size	No	>= 1.16.2	100
EXPORT_FOLDER_MEMORY_LIMIT	Memory limit on folder export	No	>=1.17.1	50000000
MEASUREMENTS	Logs the duration of each phase of the solving to the console	No	>= 1.18.4.3	true/false
REDIS_MODE	Specifies the mode in which the application should connect to the redis. Link to Redis Connection Modes documentation.	No	>= 1.19.2	NORMAL/CLUSTER
READER_REDIS_URL	Redis URL for reader endpoint.	No	>= 1.19.2	redis(s)://host.docker.internal:6379
REDIS_CACERT_PATH	Path to file withCA certificate for TLS connection with Redis	No	>= 1.19.2	/certificates/redis.pem
REDIS_REJECT_UNAUTHORIZED	Terminate the redis connection if the specified certificate verification fails	No	>= 1.19.2	true/false
IN_MEMORY_RULE_COUNT	Number of rules to store directly in memory of the server container. This allows for much faster response times when solving large rules. ( Setting this too high could cause the server to run out of memory. On average a large rule takes up ±25MB of memory i.e.: storing 100 large rules would take up 2.5GB of memory. )	No	>=1.19.5	25
TRACE_REQUEST	If enabled, all http requests will be logged to the console	No	>=1.19.5.1	true/false
AUDIT_PARTITION_KEY_FORMAT	Specify the format of a partition key to be included in each audit log document. The partition key is useful for defining partitions for the audit logs. Use custom string with the expressions "TIME_KEY", "SPACE_ID" and "RULE_ID". When not defined, partition keys will be null.	No	>=1.20.0	time:TIME_KEY|space:SPACE_ID|rule:RULE_ID
AUDIT_PARTITION_KEY_TIME_PERIOD	Defines the time period in hours during which the TIME_KEY value in the audit log partition key will remain the same. This is useful for defining partitions based on the timestamp of the audit log creation. If the period is longer, the partition will contain more audit logs. Default value is 12.	No	>=1.20.0	24

Client environment variables

Variable name	Description	Mandatory	Version	Example value
API_URL	URL on which backend API is accessible	Yes		http://localhost:8080
BI_API_URL	URL on which Business Intelligence API is accessible	No, but the features related to Business Intelligence won't work	>= 1.10.0	http://localhost:8082
NGINX_PORT	Custom port on which the container will run	No	>= 1.9.3	80

Audit environment variables

Variable name	Description	Mandatory	Example value
BI_MONGO_DB_URI	Mongo URL of Business Intelligence App	Yes	mongodb(+srv)://host.docker.internal:27017
MONGO_DB_URI	In case you have a separate database cluster for Server App	No	mongodb(+srv)://host.docker.internal:27018
WORKERS_NUMBER	Sets number of workers (threads) of application	No	1
DB_TYPE	If you use CosmosDB or DocumentDB	No	MONGODB (default) COSMOSDB DOCUMENTDB
LOGGER_TYPE	Select log output format/logger type STRING is default value if not evn variable is set	No	Possible options: STRING JSON
LOGGER_TIMESTAMP_UTC	Select log timestamp format If true: YYYY-MM-DDTHH:mm:ss.SSSZ if false: YYYY-MM-DDTHH:mm:ss.SSS(+-)HH:mm	No	true/false

Kafka env variables

Variable name	Description	Mandatory	Example value
KAFKA_ENABLED	Turn Kafka on/off	Yes (Kafka is disabled by default)	1/0
KAFKA_CLUSTER_CLIENTID	A logical identifier of an application.	Yes	"my-app"
KAFKA_CLUSTER_BROKERS	Broker definition	Yes	"my-broker:9092, my-broker2:9092"
KAFKA_CLUSTER_SSL	SSL on/off	Yes	"true"
KAFKA_CLUSTER_SASL_MECHANISM	Definition of Kafka SASL mechanism.	Yes	"plain"
KAFKA_CLUSTER_SASL_USERNAME	SASL username	No	"my-username"
KAFKA_CLUSTER_SASL_PASSWORD	SASL password	No	"top-secret-password"
KAFKA_CLUSTER_SASL_AUTHID	SASL authorization identity for aws mechanism	No	"IDIDIDIDID"
KAFKA_CLUSTER_SASL_ACCKEYID	SASL access key for aws mechanism	No	"KEYKEYKEY"
KAFKA_CLUSTER_SASL_SECRETKEY	SASL secret access key for aws mechanism	No	"SECRETKEY"
KAFKA_CLUSTER_SASL_SESSIONTOKEN	SASL session token for aws mechanism	No	"SESSIONTOKEN"
KAFKA_GROUP_TOPIC_1	Definition of Kafka consumer group, request topic and response topic, respectively. To define multiple topic groups, use numbers 1, 2, ..., N. Each record must have different consumer group.	Yes	"my-group, my-request-topic, my-response-topic"