1. Home
  2. FlexRule Server
  3. Utilities
  4. Create FlexRule Server Configuration File

Create FlexRule Server Configuration File

◷ Reading Time: 5 minutes

This page is under construction 🚧

FlexRule Server requires configuration files for each agent and master instance. These configuration files contain settings to run the server such as database credentials, master/agent host data, and encryption keys.

There are two types of configuration files:

  • Agent Configuration File: FlexRule.Server.ExecAgent.exe.config
  • Master Configuration File: FlexRule.Server.Master.exe.config

The default locations of these files:

  • Agent Configuration File:
    C:\Program Files (x86)\FlexRule\Server\ <server version> \ExecAgent\FlexRule.Server.ExecAgent.exe.config
  • Master Configuration File:
    C:\Program Files (x86)\FlexRule\Server\<server version>\Master\FlexRule.Server.Master.exe.config

How to create the configuration files

Configuration files can be created using the CLI commands or using the command generator.

You should create the configuration files separately for each master/agent instance.

Create the Configuration Files using the CLI Commands

  • Open a command prompt in administrator mode.
  • Navigate to the Master/ Agent folder
    e.g. cd C:\Program Files (x86)\FlexRule\Server\9.0.103\Master
  • Run the following command to create the configuration file.
    FRS.exe config --new [master | agent]

    e.g. To create a config file in master, FRS.exe config --new master
  • Once you create the configuration file, you can run the commands to update the file with your server settings.

The CLI Commands to Set the Configuration Settings of FlexRule Server

Most of the commands are applicable to both nodes. However, note that some of the commands are applicable either to the master node or agent node only.

Command Description
FRS.exe config --new [master | agent]

Example:

Master:
FRS.exe config --new master

Agent:
FRS.exe config --new agent
Create the configuration file

FRS.exe config --execute --runtime [master|agent] --license "license path" --folder "runtime folder"

Example:

Master:
FRS.exe config --execute --runtime master --license "C:\Users\Subhashi\Documents.flexrule\flexrule.license.lic" --folder "C:\Users\Subhashi\Documents.flexrule\9.0.107"

Agent:
FRS.exe config --execute --runtime agent --license "C:\Users\Subhashi\Documents.flexrule\flexrule.license.lic" --folder "C:\Users\Subhashi\Documents.flexrule\9.0.107"
Runtime license and runtime folder path
–runtime: Runtime license path

–folder: Runtime folder path

FRS.exe config [--agent] [--master] --host IP:PORT

Example:

Master:
FRS.exe config --master --host localhost:9000

Agent:
FRS.exe config --agent --host localhost:9500
Host IP and port

FRS.exe config --agent --masterAddress [VALUE]

Example:

Master:
N/A

Agent:
FRS.exe config --agent --masterAddress "http://localhost:9000
Master node address in agent configuration

FRS.exe config --workbench [true|false] --host IP:PORT

Example:

Master:
FRS.exe config --workbench true --host "http://localhost:9010"

Agent:
N/A
Workbench host and port
–workbench [true|false]: State whether you want to set a workbench

–host IP:PORT: workbench address

FRS.exe config --error --file [PATH] --eventLog

Example:

Master:
FRS.exe config --error --file "D:\Program Files (x86)\master.log" --eventLog

Agent:
FRS.exe config --error --file "D:\Program Files (x86)\master.log" --eventLog
Error log file path

FRS.exe config --security [--masterEncryption [encryptionValue]] [--sharedSecret [secretValue]] [--authSignKey [authValue]]

Example:

Master:
FRS.exe config --security --masterEncryption "rtfeWvGee4t3UR3CE@km3RE8ey7rq87N" --sharedSecret "abcdWvGee4t3UR3CE@km3RE8ey7rq87N" --authSignKey "1234WvGee4t3UR3CE@km3RE8ey7rq87N"

Agent:
masterEncryption is not available for the agent.
sharedSecret and authSignKey are similar to the master keys.

FRS.exe config --security --sharedSecret "abcdWvGee4t3UR3CE@km3RE8ey7rq87N" --authSignKey "1234WvGee4t3UR3CE@km3RE8ey7rq87N"
Security keys. Each key should be 32 chactors long.
sharedSecret and authSignKey of the master and agent should be the same.

FRS.exe config --database --server [serverValue] --name [dbName] --user [userValue] --password [passwordValue] --integrated --azure --encrypt --trustCert --timeout [timeoutValue] --port [portValue]

Example:

Master:
FRS.exe config --database --server "FLEXRULE-02\SQLEXPRESS02" --name "frdb9096" --user "testUser" --password "testPw" --encrypt --trustCert --timeout 30 --integrated --azure "test" --port 2500

Agent:
The command is similar to the Mater as it should direct to the same databse.

FRS.exe config --database --server "FLEXRULE-02\SQLEXPRESS02" --name "frdb9096" --user "testUser" --password "testPw" --encrypt --trustCert --timeout 30 --integrated --azure "test" --port 2500
Database configuration details

FRS.exe database --migrate [nothing|refresh|new]

Example:
Database migration details

FRS.exe database --create defaults

Example:
Create database

FRS.exe account --type [app|user] --name [name of account] --pw [VALUE]

Example:
Create application or user accounts

Create the Configuration Files using the Command Generator

<update once the online generator is ready>

Updated on October 6, 2021

Was this article helpful?

Related Articles