Requirements and installation

Requirements and installation

In order to run the agent correctly, the following setup is required.

Hard- en software requirements

  1. Windows Server 2012 64 bit or 2016 64 bit with 8 GB Ram, minimal of 2 CPU cores with 2.40 GhZ, 150 GB hard drive;
  2. Connection to the internet (possibly via a proxy);
  3. An internet and intranet registered DNS A. The DNS A record refers to the server on which the agent is installed;
  4. A public usable SSL certificate
  5. A web server. E.g. IIS, NginX, etc. which contains at least the configuration described in 1.2.

Authorization requirements

It will need the rights to retrieve data from the given system.


Installing the Agent

The following steps must be taken to get the agent working correctly.
  1. Register a DNS record referring to the customer server on which traffic is coming in;
  2. Install a browser SSL certificate for the registered DNS record;
  3. In a web server, set the configuration where the following things are set. An example configuration for NginX is shown in appendix 1:
    1. HTTP redirect to HTTPS;
    2. SSL certificaat for all the traffic;
    3. Redirect any incoming request to the agent (port 7070);
  4. Create a separate folder in which the brynq_agent.exe is placed;
  5. Download the BrynQ Agent via https://app.brynq.com/interface-agent/ and place it in this folder
  6. Create a user who has the necessary rights to the folder where the agent is located and who has the rights as mentioned in the Requirements.

Running the Agent

You can test and run the BrynQ Agent by opening a PowerShell window in the directory where brynq-agent.exe is located.
Start it with: .\brynq-agent-<version>.exe

If you run it without parameters, the agent starts with the following defaults:

  • Listen IP: 127.0.0.1
  • Port: 7070
  • SSL: false
  • Certificate directory: current directory
  • Certificate file: brynq_agent_cert.pem
  • Key file: brynq_agent_key.pem

You can override these settings with command-line options.

Available Parameters 

  1. –listen / -l
    Sets the IP address the agent binds to so incoming connections can reach it.     Example: brynq-agent.exe --listen 0.0.0.0
  2. –port / -p
    Changes the port the agent listens on for incoming requests. Example: brynq-agent.exe --port 5005
  3. –ssl / -s
    Enables or disables SSL encryption for the agent’s webserver. Note: If set to true, you must also provide --certdirectory.
  4. –certdirectory / -cd
    Defines the folder where the SSL certificate and key files are stored. Example: brynq-agent.exe --ssl true --certdirectory C:\agentcerts
  5. –certfile / -cf
    Overrides the default certificate filename the agent uses for SSL. Useful when your certificate file does not use the default name.
  6. –keyfile / -kf
    Overrides the default key filename the agent uses for SSL. Useful when your key file does not use the default name.
  7. –http_proxy / -hp
    Sets an outbound HTTP proxy for the agent’s external requests. Used in restricted environments where direct outbound traffic is blocked.
  8. –https_proxy / -hsp
    Sets an outbound HTTPS proxy for secure external requests. Used when HTTPS traffic must go through a corporate proxy.
  9. –verify_ssl / -vssl
    Enables or disables SSL certificate verification for outbound HTTPS requests. Use false only when working with internal or self-signed endpoints.

Example Full SSL Start: brynq-agent.exe –listen 0.0.0.0 –port 443 –ssl true –certdirectory C:\agentcerts

Warning
Note that if you use the ssl parameter, the certfolder parameter is mandatory. 

    Create Task

    1. Create a task in the Windows Task Scheduler with the following settings:
      1. General
        1. Run with newly created user;
        2. Check “Run wheter user is logged on or not”;
        3. Do not check “Run with highest privileges”
      2. Triggers:
        1. Begin the task: At Startup
        2. Delay task for: 15 minutes
      3. Actions:
        1. Action: Start a program
        2. Program/Script: The full path to the brynq-agent.exe. Add the parameters (see step 6) if wanted.
        3. Start in: The directory where the brynq-agent.exe is placed
      4. Settings
        1. Uncheck “Stop the task if it runs longer than:”;
    2. Save the windows task and run it.

      • Related Articles

      • Determine Interface Scope

        This guide explains how to create and manage interfaces between two systems (source and target systems) within our platform. It includes creating a new interface, defining scenarios, detailing fields per scenario, and submitting your setup for ...