What you will achieve

By the end of this guide, the BrynQ Agent runs as a Windows service on a server in your own network. BrynQ can then reach the systems you choose (a SQL database, files, an internal REST or SOAP API, or Active Directory) without opening inbound firewall ports, registering DNS records or installing SSL certificates yourself.

Before you start

Tick off this checklist first. Each item prevents a common reason for getting stuck.

• ☐ A Windows server running Windows Server 2016 or newer (64-bit), that can reach the systems BrynQ needs to connect to.
• ☐ Local administrator rights on that server.
  Why: the installer creates Windows services and writes to Program Files and ProgramData. Without these rights, parts of the installation can fail.
• ☐ Outbound HTTPS (port 443) allowed from the server to https://app.brynq.com, https://api.cloudflare.com and the Cloudflare Tunnel endpoints. No inbound ports are needed.
• ☐ A customer-scoped BrynQ API token. Create it in BrynQ under Admin Portal > API Access > Add API token and select exactly one customer: the customer this Agent belongs to. Admin access is not needed.
  Why: BrynQ uses this token to set up the secure connection and to deliver updates. A token for several customers is rejected.
• ☐ Know which modules you need (see Step 3). Ask BrynQ support if you are not sure.
• ☐ For the SQL module only: the SQL Server name, and an account (Windows or SQL Server login) with access to the databases BrynQ needs.

Step 1: Download the installer

📍 Where: BrynQ, in a browser on the Windows server.

1. Sign in to BrynQ and go to Organization > Agent. The page is called BrynQ Agent.
   Don't see it? Ask an administrator to add the permission Access to download the BrynQ Agent to your role.
2. Check the latest Version card. Select Click here to read the full release notes if you want to review the changes first.
3. Click Download and save the installer on the server.

Need an older version? Use Older versions on the same page. Each version shows its release date, release notes and a Checksum (SHA-256) for your IT integrity checks. Use the latest version unless BrynQ support tells you otherwise.

Step 2: Run the installer

📍 Where: the Windows server.

1. Right-click the installer and choose Run as administrator.
2. Choose the setup language: English, French, German or Dutch. Some BrynQ pages and the license agreement are always in English.
   
3. Read the license agreement carefully. If you agree to it and want to use the BrynQ Agent, accept it to continue.
4. Keep the default installation folder (C:\Program Files\BrynQ\Agent) unless your organization requires another location.
5. Enter the BrynQ API token. The installer looks up your customer automatically.

Step 3: Choose the modules

Key idea: a module is one type of connection the Agent offers to BrynQ. Only the modules you select are available; all others stay closed. On a new installation, nothing is selected.

Select only what you need. To change the modules later, run the installer again.

Step 4: Set up the SQL connection (only for SQL)

1. ODBC driver: pick the suggested driver. If several are listed, choose the highest number (for example ODBC Driver 18 for SQL Server).
2. Server: pick the suggested SQL Server, or type its name (for example SERVERNAME or SERVERNAME\INSTANCE).
3. Authentication: choose Windows authentication or SQL username / password. The account needs access to the databases BrynQ uses.
4. Keep the pre-filled advanced options (Encrypt=no; TrustServerCertificate=yes) unless your database administrator says otherwise.
5. BrynQ first tests the connection to the server. Then choose whether BrynQ may use all databases or only a selected list.

The SQL settings are stored only on your server. You can change them later in the local admin dashboard.

Step 5: Finish and check

1. Select Start Menu Folder: keep the default and click Next.
2. Select Additional Tasks: OPTIONAL (recommended) tick Create a desktop shortcut to open the admin dashboard later. Tick Use custom local network settings only when the default ports are already in use on the server.
   Defaults: listen IP 127.0.0.1, Agent port 7070, local admin port 7071.
   
3. Click Install and, when the installation is done, Finish.

Step 6: Use the Agent in BrynQ

When you set up an interface that uses the Agent, enter the Agent address from public_url.txt (https://<your-customer>.brynq-agent.com) in the authorization of that app in BrynQ. The template guide of your interface tells you exactly where.

What gets installed

Next steps

• The local admin dashboard: review or change module settings.
• Update, uninstall or roll back the BrynQ Agent.
• Silent (unattended) installation: for IT teams that deploy with scripts.
• Security: how the Agent protects the connection.