1. Home
  2. FlexRule Server
  3. Installation
  4. FlexRule Server Container Configuration Settings

FlexRule Server Container Configuration Settings

◷ Reading Time: 6 minutes

Overview

Configuration settings need to be set for each container so FlexRule Server can be started using those settings.

You have two options to assign configuration settings:

1. Set environment variables when creating containers in a cloud service.

2. Pass parameters to the docker run command when using the CLI.

If you’re using docker run, use the parameter keys with the forward slash prefix.
E.g. /MasterAgentSharedSecret

Configuration Settings for All Nodes

These settings need to be set for both Master and Agent nodes.

MasterEncryptionPassword

/MasterEncryptionPassword

Key used to encrypt and decrypt passwords within FlexRule Server. This key must match between Master and Agent nodes as well as the database.

MasterAgentSharedSecret

/MasterAgentSharedSecret

Key used between Master and Agent nodes to identify and validate each other as an authorized node in the environment.

AuthSigningKey

/AuthSigningKey

Key used to sign authentication tokens sent to clients.

LogFolder

/LogFolder

Location where the log files will be saved in the container.

For Windows containers this must be set to c:\frs.
For Linux containers this must be set to /frs.

License

/license

Your FlexRule Server license key.

Monitoring.Channel

/Monitoring.Channel

Specifies where to record events from FlexRule Server.

Monitoring.Event

/Monitoring.Event

Master Configuration

These settings only need to be set for Master nodes.

Master.WorkbenchPath

/Master.WorkbenchPath

Must be set to Workbench.

Master.WorkbenchApp

/Master.WorkbenchApp

The name of the Workbench application.

Default: app1

Master.WorkbenchAuth

/Master.WorkbenchAuth

The API address used for authentication for the Workbench and Agents.
Because this requires inter-container communication, the address must point to the host machine which needs to have it’s port :9000 mapped to the Master node handling authentication.

Example: http://192.168.10.10:9000

Master.WorkbenchAddress

/Master.WorkbenchAddress

The API address used to access the Workbench through the browser.

Default: http://*:9010

Master.ApiAddress

/Master.ApiAddress

The API address used to connect to the Master API.

Default: http://*:9000

Master.GenericLogger

/Master.GenericLogger

The logging library to use to write logs.

Default: FlexRule.Server.Logging.LogFileWriter,FlexRule.Server.Library

Master.DB.Server

/Master.DB.Server

Database server address.

Master.DB.User

/Master.DB.User

Database username.

Master.DB.Password

/Master.DB.Password

Database password.

Master.DB.Name

/Master.DB.Name

Database instance name.

Agent Configuration

These settings only need to be set for Agent nodes.

Agent.ApiAddress

/Agent.ApiAddress

The API address to execute using this agent.

Default: http://*:9003

Agent.MasterAddress

/Agent.MasterAddress

The Master node’s API address used for authentication and to request other resources from the Master node.
Because this requires inter-container communication, the address must point to the host machine which needs to have it’s port :9000 mapped to the Master node handling authentication.

Example: http://192.168.10.10:9000

Agent_DB_Server

/Agent.DB.Server

Database server address.

Agent_DB_User

/Agent.DB.User

Database username.

Agent_DB_Password

/Agent.DB.Password

Database password.

Agent_DB_Name

/Agent.DB.Name

Database instance name.

Agent.GenericLogger

/Agent.GenericLogger

The logging library to use to write logs.

Default: FlexRule.Server.Logging.LogFileWriter,FlexRule.Server.Library

Agent.Runtimes

/Agent.Runtimes

Runtime version and license information.

Example: [{version:'*',license:'{Your FlexRule Runtime License}'}]

Updated on October 27, 2023

Was this article helpful?

Related Articles