1. Home
  2. FlexRule Server
  3. Installation
  4. Download and Install FlexRule Server

Download and Install FlexRule Server

Print Friendly, PDF & Email

◷ Reading Time: 10 minutes


  1. Go to the FlexRule website’s Download section: http://www.flexrule.com/downloads/links.
  2. Log in with your FlexRule username and password.
  3. Enter the password you received from FlexRule (contact support@flexrule.com for the password if you don’t already have it).
  4. Click on Download Now to download the FlexRule Server installation file.

  5. A zip file will be downloaded.

  6. Unzip the downloaded file. There will be two setup files.

There are two separate installations.

  • Master: Manages the agents and services.
  • Agent: Executes the services.

You can install FlexRule on-premise or on the cloud.

Install On-Premise

Master Installation

First, install the Master server.


1. Select the installation location for the Master Server.

2. If you have purchased a license already, close this step and copy the license files.

3. Configure the Master Server using the steps from the Master configuration guide.

Agent Installation

After installing the Master server successfully, the Agent server can be installed.


1. Select the installation location for the Agent server.

2. If you have purchased a license already, close this step and copy your license files.

3. Configure the Agent server using the steps from the Agent configuration guide.


You have to copy the server license files (FlexRule.Server.License.lic) to both Master and Agent folders.

The server license (FlexRule.Server.License.lic) is different to the runtime license (FlexRule.License.lic).

Install on Cloud

Before you start installing FlexRule Server on Azure, you need to prepare a VM and its connectivity.

select Windows 2008 R2
select Standard in the VM specs screen


IP Addresses

Each VM on Azure has two IP addresses: Public and Private. During the VM installation, you need to know the VM’s Public and Private IP addresses. These IPs have been listed in the VM’s Overview page:

These IPs will be used later to set up the FlexRule Server master/agent configurator application.

Setup DNS

In this step, you are going to create a DNS name label for the VM that allows you to use the name to access the VM rather than its IP.

After Installing FlexRule Server Master and Agent, you will be able to browse the FlexRule Workbench. FlexRule Workbench is available by browsing the VM’s DNS name from your browsers (i.e., Chrome, IE, etc.). Your selected VM by default doesn’t have the DNS name label and it needs to be configured manually. This option is available under Server Settings/Configurations/DNS Name Label:

Inbound security Rules

You should configure new inbound security rules that will enable communication to your VM from the outside (internet). By default, all ports except RDP (:3389) are blocked. To be able to browse FlexRule Workbench we need to open two ports:

  • FlexRule Server Master uses TCP:9000 by default.
  • FlexRule Workbench is uses TCP:9010 by default.

In order to add these ports in Inbound Security Rules, you need to do the following:

  1. From the left panel, go to Settings > Network Interfaces.
  2. Click on Network Security Group > [Your VM Machine] > Inbound Security Rules.
  3. Click on Add (the Add button is the three horizontal lines with a down arrow).
Add TCP:9000 port for FlexRule Server Master

Add TCP: 9010 port for FlexRule Workbench

Firewall Policy

In this step, you need to configure Inbound and Outbound ports on your firewall policy in order to be able to browse FlexRule Workbench over the Internet. To do that, you need to have the following ports opened in your Windows Firewall:

  1. TCP:9000 (FlexRule Server Master).
  2. TCP:9010 (FlexRule Server Workbench).


1. Connect to the VM.

2. When you use the Microsoft Azure VM, the IP addresses you would use on FlexRule Server Configurator need to be picked from your VM’s configuration instead of using localhost. The IP or name address for FlexRule Server Master and Workbench would be your VM’s Private IP address.

You can find this by using the command ipconfig in the command prompt.

In the above example, is the private VM IP address.

3. On the VM, install FlexRule Server Master and Agent. The steps are similar to on-premise installation.

Workbench Setup

FlexRule Workbench allows you to manage the deployed services. After you install the FlexRule Server Master and Agent successfully, you will need to configure the Workbench by changing the following configuration file:

[Local Disk]/Program Files (x86)/Pliant Framework/FlexRule Server/<version>/Master/Workbench/FlexRule/Config.jsx
  1. Open the file by using any text editor (e.g. Notepad).
  2. change the masterAddress to the DNS name label that you have chosen during the DNS setup of your VM. This enables you to browse the Workbench URL over the Internet.

In our environment, the address is http://flexruleserver.australiaeast.cloudapp.azure.com

Find the Workbench config file
Update the Workbench config file to the Master’s Full-name Address

The change below allows the Workbench to communicate with the Master public API:

// Generated by configurator
var FlexRuleMasterServer = {
    masterAddress: 'http://flexruleserver.australiaeast.cloudapp.azure.com:9000',
    clientId: 'App1',

Browse FlexRule Workbench

After successfully installing and configuring FlexRule Server (Master, Agent, and Workbench), it’s time to test it out.

You can follow these instructions, which are explained step-by-step. In our scenario, we simply ran them using the command line (in Windows Command Prompt).

If you have installed and configured everything correctly, you should now be able to browse to the FlexRule Workbench in your web browser.

  1. Open a browser (e.g. Chrome) and browse to your FlexRule Workbench.
    Use the VM’s DNS Label Name if you installed this on an Azure VM (E.g. http://flexruleserver.australiaeast.cloudapp.azure.com:9010) or the local address (e.g. http://localhost:9010) if you installed on premise.
  2. Enter admin as the username and your password that you defined during the default account settings in FlexRule Server Master configuration.

Now you should be able to see the FlexRule Workbench home page.

Video Tutorials

Master Installation with Trial License

Agent Installation with Trial License

Master Installation with License

Agent Installation with License

Installing FlexRule Server on a Virtual Machine

Running FlexRule Server

Updated on August 13, 2019

Was this article helpful?

Related Articles