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

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.

>= 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.

>= 1.18.4.4

/certificates/private.pem

BRAND_LOGO_URL

Custom brand Logo URL. Feature must be enabled in license key

>= 1.17.0

https://example.com.img/logo.ong OR data:image/png;base64,iVBORw0KGgoAAAANSUhE...

API_URL

For sophisticated On-Premise deployments. Lets the server know it's own address for Rule Flow and dependant rule solves.

https://api.decisionrules.io

SHOWCASE

Turn on or off showcase mode

true/false

WORKERS_NUMBER

Sets number of workers (threads) of application

BI_MONGO_DB_URI

If you have a separate database cluster for Business Intelligence App

>= 1.10.0

mongodb(+srv)://host.docker.internal:27018

SAML_ENTRY_POINT

URL for your identity provider login page

https://devX.okta.com/app/name/HASH/sso/saml

SAML_ISSUER

Issuer string to supply to IdP

okta.com/HASH_STRING

SAML_CERT

Public certificate of provider. In RAW format as single line without BEGIN CERTIFICATE and END CERTIFICATE

MIIC8DCCAdigAwIBAgIQap4GhMRA26tJGFD.....

SAML_CALLBACK_URL

Callback URL where provider send response

https://api.decisionrules.io/saml/callback

RF_TIMEOUT

Time in milliseconds after which the process of solving a rule flow is stopped

5000

SR_TIMEOUT

Time in milliseconds after which the process of solving a scripting rule is stopped

5000

WORKFLOW_TIMEMOUT

Time in milliseconds after which the process of solving a workflow is stopped

>=1.19.0

10000

RF_NODE_LIMIT

Integer of desired rule flow nodes, default value is 30

SWAGGER_HOST

Host of the server application which will use swagger

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.

mydomain.com, yourdomain.io

ALLOWLIST

Cultural-neutral synonym for WHITELIST.

mydomain.com, yourdomain.io

TELEMETRY

It turn on/off telemetry, which measures endpoint execution duration (for example: Solver API)

>= 1.8.1

On = 1, off = 0

EXAPI_MAX_CNT_LEN

Defined maximal response content length in bytes

3000

EXAPI_MAX_BODY_LEN

Defined maximal body size for request in bytes

10000

EXAPI_MAX_REDIRECTS

Defines maximal redirects that called URL can perform

EXAPI_TIMEOUT

Defines API connection timeout in milliseconds

2000

DT_HTTP_CALL_LIMIT

Defined limit for http function that can be defined in DT or DTR

>= 1.12.0

100

LOGGER_TYPE

Select log output format/logger type STRING is default value if not env variable is set

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

>= 1.14.2

true/false

REDIS_PING_INTERVAL

Duration (in milliseconds) for which the server pings the Redis server.

>= 1.14.3

300000

FLUSH_REDIS_ON_STARTUP

Whether cache should be flushed when server is starting. Defaults to true.

>= 1.17.0

false

TIMEZONE

Default time zone for date functions. Default is:

Europe/Prague

>= 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

>= 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

>= 1.16.2

MONGO_MAX_POOL_SIZE

MongoDB connection maximal pool size

>= 1.16.2

100

EXPORT_FOLDER_MEMORY_LIMIT

Memory limit on folder export

>=1.17.1

50000000

MEASUREMENTS

Logs the duration of each phase of the solving to the console

>= 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.

>= 1.19.2

NORMAL/CLUSTER

READER_REDIS_URL

Redis URL for reader endpoint.

>= 1.19.2

redis(s)://host.docker.internal:6379

REDIS_CACERT_PATH

Path to file withCA certificate for TLS connection with Redis

>= 1.19.2

/certificates/redis.pem

REDIS_REJECT_UNAUTHORIZED

Terminate the redis connection if the specified certificate verification fails

>= 1.19.2

true/false

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

>= 1.9.3

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

mongodb(+srv)://host.docker.internal:27018

WORKERS_NUMBER

Sets number of workers (threads) of application

DB_TYPE

If you use CosmosDB or DocumentDB

MONGODB (default) COSMOSDB DOCUMENTDB

LOGGER_TYPE

Select log output format/logger type STRING is default value if not evn variable is set

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

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

"my-username"

KAFKA_CLUSTER_SASL_PASSWORD

SASL password

"top-secret-password"

KAFKA_CLUSTER_SASL_AUTHID

SASL authorization identity for aws mechanism

"IDIDIDIDID"

KAFKA_CLUSTER_SASL_ACCKEYID

SASL access key for aws mechanism

"KEYKEYKEY"

KAFKA_CLUSTER_SASL_SECRETKEY

SASL secret access key for aws mechanism

"SECRETKEY"

KAFKA_CLUSTER_SASL_SESSIONTOKEN

SASL session token for aws mechanism

"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"

Last updated 15 days ago