Install and Configure Bridge
Step 1: Download the Bridge agent
Only one Bridge agent can be installed per machine.
- Navigate to
(settings) >> Advanced >> Bridge, and click Downloads.
- Choose a Download Type:
- Zip Download – Compressed file; requires extraction and manual setup via command line.
- Installer – Direct installation via setup wizard. You can download the installer directly or copy and execute the wget command.
- Select your OS: Windows 64-bit, Linux 64-bit, or macOS 64-bit.
Step 2: Install Bridge OS-Specific Setup
Prerequisites:
Ensure administrative privileges for installation.
For other system requirement refer to Bridge System requirements section.
Download using Installer
Supported OS: Windows, Linux
- For your selected OS, the download and copy icons are available. Click the download icon to download the installer, or copy the wget command and run it in your terminal.
Launch the set up wizard:
Windows: Locate the downloaded file and double-click to launch the setup wizard.
LinuX: Run the Installer with root permission:
sudo sh <Bridge.bin>
replace 'Bridge.bin' with the actual path and filename.
Review and accept the License Agreement.
Choose the installation directory (default: /Bridge) and click Next.
Configure Proxy (optional):
Select Use proxy settings if required by your network.
Enter the proxy host, port, username, and password, then click Next.
Configure External PostgreSQL (optional):
By default, the Bridge uses a bundled PostgreSQL database.
To use an external PostgreSQL instance, select Use external PostgreSQL and provide the database host, port, username, and password, and click Next.
Enter the credentials of a non-root user (local account without administrative privileges) to run the Bridge service.
Review the summary and click Install.
Once installation completes, click Done to close the wizard.
Download using Zip Package
This method allows manual setup through command-line execution.
- For your selected OS, click the download icon to download the zip file or copy icon to copy the wget command and execute in the terminal.
Launch the terminal (PowerShell as Administrator for Windows).
Click the Command to Install from the UI to copy the installation command and run it in the downloaded folder with root permission.
Follow the setup prompts:
Proxy settings (optional):
yes – Enter proxy host, port, username, and password.
no – Disable proxy.
skip – Keep existing proxy settings unchanged.
PostgreSQL settings (optional): To use an external PostgreSQL instance.
yes – Enter the host, port, username, and password.
no – Use bundled PostgreSQL.
skip – Keep existing configuration unchanged.
Non-root username
Enter a local account (without administrative privileges).
If the username does not exist, the setup will prompt you to create it.
The user will have only the required permissions to manage the Bridge service.
If a Bridge service already exists, it will prompt to override existing
No: The installation will be terminated.
Yes: The installation will continue and overwrite the existing service.
Once installation completes, verify that the Bridge service has started successfully.
The Bridge will appear on the Bridge home page along with details such as its version, status, and activity state.
- Do not share bridge files with anyone, and ensure the secure protection of the bridge location. Otherwise, there's a risk of sensitive information being exposed.
- Do not modify or remove any properties within the installed bridge configuration files. The inherent files in bridge should not be edited, deleted, or shared.
Once Bridge is configured you can execute a task through Message module in Bridge.
Bridge 3.0 Commands
Bridge provides a set of commands to install, configure, manage, and troubleshoot the bridge service across operating systems.
Before You Begin
Command Syntax : <bridge_script> [command]
<bridge_script> refers to the respective script path for your operating system.
Linux / macOS: bridge.sh
Windows: bridge.bat
For example:
On Linux/macOS: sudo sh /Bridge/bin/bridge.sh start
On Windows: cmd.exe /c 'C:\Bridge\bin\bridge.bat start'
Permission Requirements
Different commands require specific user privileges depending on your OS.
User Role | Applicable OS | Description |
admin | Windows | User with administrator privileges (must run from an elevated PowerShell or Command Prompt) |
root | Linux, macOS | System root user (run commands using the sudo command) |
service-user | All OS | The non-root local user account configured to run the Bridge service |
If a command fails due to insufficient permissions, re-run it with administrator or sudo privileges as required.
Primary Commands
Command | Description | Required Permission |
<bridge_script> install | Configures and installs the Bridge Agent | Windows: admin |
<bridge_script> start | Starts the Bridge service | Windows: admin/service-user |
<bridge_script> restart | Restarts the Bridge service | Windows: admin/service-user |
<bridge_script> stop | Stops the Bridge service | Windows: admin/service-user |
<bridge_script> uninstall | Uninstalls the Bridge service | Windows: admin |
<bridge_script> update | Manually updates the Bridge to the latest version | service-user |
<bridge_script> reset_password | Resets the Bridge password. | Windows: admin |
<bridge_script> check_connectivity | Verifies Bridge’s connectivity to Qntrl domains and lists any unreachable domains | admin / root / service-user |
Supplementary Commands
Command | Description | Required Permission |
<bridge_script> check_encryption | Checks whether encryption is supported | admin / root / service-user |
<bridge_script> configure_proxy | Updates proxy configuration details | admin / root / service-user |
<bridge_script> configure_postgres | Updates PostgreSQL configuration | admin / root / service-user |
<bridge_script> reconfigure | Updates Bridge configuration settings | admin / root / service-user |
<bridge_script> status | Displays the status of the Bridge | admin / root / service-user |
<bridge_script> send_logs | Sends Bridge logs to Qntrl support for troubleshooting | admin / root / service-user |
<bridge_script> sync_scripts | Syncs scripts from the Qntrl cloud to the local Bridge | service-user |
<bridge_script> update force | Re-runs the update for the current version | service-user |
<bridge_script> update <target_version> | Updates Bridge to a specified version | service-user |
<bridge_script> help | Displays all available commands and usage information |
|
Related Articles
Bridge agent settings
The Bridge Agent serves as the local management console for your Bridge. It allows you to view and control services, review messages and logs, configure modules, manage credentials, and maintain secure communication with external systems. Login to ...Other actions in Bridge
You can perform various additional actions from the Bridge page to manage, monitor, and troubleshoot your Bridge setup. To access the Bridge page: In Qntrl, click the settings gear icon in the left pane bottom. Navigate to Advanced >> Bridge and ...Overview of Bridge
What is a Bridge? Bridge is an installable, lightweight independent agent that can be deployed on the customer’s local network. It is compatible both on Windows and Linux machines with 32 and 64-bit OS. Its role is to facilitate communication between ...PowerShell Engine
PowerShell Engine In Bridge, the PowerShell Engine module is used to perform actions in any Windows machines in the client's network using PowerShell script. Prerequisite While creating Credentials, select the type Powershell and provide the User ...Bridge System Requirements
Qntrl Bridge is a secure and efficient agent that facilitates secure data transfer between on-premise systems and the Qntrl cloud. To ensure optimal performance and stability, it’s essential to install Qntrl Bridge on systems that meet the minimum ...
You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.