1. Prerequisites

To configure databridge on your private network, ensure that all the system requirements are followed. Learn more 

2. Databridge details   

3. Steps to configure databridge

3.1. Configuring  Qntrl integration

Before setting up a databridge, you must configure Qntrl under System Integrations in Zoho Creator. This enables secure communication between Creator and your private service.
The super admin can also configure Qntrl under Databridge in Operations.

3.2. Configuring databridge 

After setting up Qntrl in System integrations,

1. Navigate to Databridge under Operations.
   
2. Click the required operating system and version (for example, macOS - 64 bit) from the list. The databridge package will be downloaded to your system in the format of a zip file.
   

   
   

   Note: The download package will only remain accessible for 15 days. 

   
   

3. Install the databridge on the machine that has access to your internal services or databases. After the installation is completed, it'll appear in the databridge listing page.
   
   
   
   

   Tip: After installation, verify that the databridge is listed in the databridge section. Ensure that the databridge is active. 

3.3. Installing databridge on a server 

Databridge can be installed using one of two package formats, depending on your operating system and how you prefer to manage the installation:

Note: The installer offers a guided UI flow with prompts. The zip method is suited to scripted or headless deployments and runs through the command line.

During installation, you will be asked for proxy settings, external Postgres settings, and a service user account. The behavior is consistent across operating systems:

• Proxy settings: If your server reaches the internet through a proxy, enter the proxy username, password, host, and port. Otherwise, skip this step or disable the proxy.

• External Postgres settings: If you want Databridge to use an external Postgres database, enter its host, port, username, and password. Otherwise, the bundled Postgres will be used.

• Service user account: The non-root local user account that Databridge will run under. This account should not have administrator privileges and must be created on the server beforehand. If the user does not exist when prompted by the zip installer, you will be given the option to create one with only the permissions required to run the service.

3.3.1. Install on Windows using the zip (admin PowerShell only)  

1. Download the Databridge agent zip from Creator.
   
2. Open an elevated PowerShell window (Run as administrator) and extract the agent zip:
   

powershell

   Expand-Archive - Force Bridge.zip 'C:\Bridge'

Replace Bridge.zip with the path to the actual downloaded zip. 

3. Run the install script with root permission to start the installation:

powershell

   cmd.exe /c 'C:\Bridge\bin\bridge.bat install'

4. At the proxy settings prompt, choose one of the following:

• Yes - Configure the proxy by entering the proxy username, password, host, and port.

• No - Disable the proxy.

• Skip - Make no changes to proxy settings.

5. At the postgres settings prompt, choose one of the following:

• Yes - Configure external Postgres by entering the host, port, username, and password.

• No - Disable external Postgres and use bundled Postgres.

• Skip - Make no changes to Postgres settings.

6. At the service user prompt, enter a non-root username on your system. If the username does not exist, the create-user prompt will let you create the user with only the permissions required to run the service.

7. Verify that the Databridge has started successfully.
   

Note: The zip installation on Windows must be run from an elevated PowerShell. A standard PowerShell session will not have the privileges required. 

3.3.2. Install on Linux using the zip  

1. Download the Databridge agent zip from Creator.
   
2. Open the terminal and extract the agent zip:
   

bash

   sudo unzip -d /Bridge Bridge.zip

Replace Bridge.zip with the path to the actual downloaded zip. 

3. Run the install script with root permission to start the installation:

bash

   sudo sh /Bridge/bin/bridge.sh install

4. At the proxy settings prompt, choose one of the following:

• Yes - Configure the proxy by entering the proxy username, password, host, and port.

• No - Disable the proxy.

• Skip - Make no changes to proxy settings.

5. At the postgres settings prompt, choose one of the following:

• Yes - Configure external Postgres by entering the host, port, username, and password.

• No - Disable external Postgres and use bundled Postgres.

• Skip - Make no changes to Postgres settings.

6. At the service user prompt, enter a non-root username on your system. If the username does not exist, the create-user prompt will let you create the user with only the permissions required to run the service.

7. Verify that the Databridge has started successfully.

3.3.3. Install on Mac using the zip  

1. Download the Databridge agent zip from Creator.
   
2. Open the terminal and extract the agent zip:
   

bash

    sudo unzip -d /Library/Bridge Bridge.zip

Replace Bridge.zip with the path to the actual downloaded zip. 

3. Run the install script with root permission to start the installation:

bash

   sudo sh /Library/Bridge/bin/bridge.sh install

4. At the proxy settings prompt, choose one of:

• Yes - Configure the proxy by entering the proxy username, password, host, and port.

• No - Disable the proxy.

• Skip - Make no changes to proxy settings.

5. At the postgres settings prompt, choose one of:

• Yes - Configure external Postgres by entering the host, port, username, and password.

• No - Disable external Postgres and use bundled Postgres.

• Skip - Make no changes to Postgres settings.

6. At the service user prompt, enter a non-root username on your system. If the username does not exist, the create-user prompt will let you create the user with only the permissions required to run the service.

7. Verify that the Databridge has started successfully.
   

3.4. Post installation of the databridge

1. Open the required databridge, from the databridge listing page. In the databridge details page, click Add Connection.
   

2. Choose a connector from the list of privately hosted connectors and create the connection as required.
   
   

3. Enable connection access to your application from the Microservices section.
   
   

Note: The admin configures the databridge and the associated connection. To grant application access, the admin must navigate to the Microservices section and enable access for the relevant application.

 Note:

1. The databridge must remain active for connections to function. If it is inactive, applications will not be able to access data from internal systems.
2. You can add a maximum of 20 databridge in one account.
3. A maximum of 5 databridges can be actively connected at a time. 
4. Databridge requires outbound internet connectivity from the machine where it is installed. It should be installed on a dedicated server that remains powered on. If the machine sleeps or restarts, all associated workflows will be interrupted.
   

4. Manage databridge

4.1. Databridge details page

• Host - The hostname of the server where the Databridge is installed.
  

• Host OS - The operating system of the host server (Windows, Mac OS X, or Linux).

• Port - The port the Databridge is listening on.

• Latest poll time - The most recent time Creator successfully polled the Databridge.

• Status - Active or Down.
  

• Active - The Databridge is up, connected to Creator, and ready to handle data operations.
  

• Down - The Databridge is not currently reachable from Creator. This can happen when the service has been stopped, the host server is offline, or there is a network issue.
  

• Test Databridge - A Test button that validates the channel between Creator and this Databridge.

• Added by - The user who added this Databridge.

• Added on - The date the Databridge was added.

4.1.1. Testing the Databridge  

1. Open the Databridge from the listing page, click Test under Test Databridge in the details page.

• Databridge is active - Creator was able to reach the databridge. The Databridge is ready to handle data operations.

• Databridge is down - Creator could not reach the databridge. Check that the Databridge service is running on the host server, verify outbound network connectivity from the server, and refer the Troubleshooting steps.

Note: Test validates the Creator to databridge channel only. It does not test the connection between the Databridge and your internal service or database.

4.2 Actions in databridge

• Stop
  
• View References
• Delete
  

4.2.1. Stop

1. Click the ellipsis (three dots) next to the required databridge. Click Stop.
   

2. Click Stop databridge in the popup that follows.
   

4.2.2. View references   

1. Click the ellipsis (three dots) next to the required databridge.
   

2. Click View references. The associated connections that use this databridge will be listed in a popup.
   

3. Click References to view where the databridge is being used. Click View to open the connection in the application. 

4.2.3. Delete

1. Click the ellipsis (three dots) next to the required databridge.
   

2. Click Delete in the popup after reviewing the listed connections that reference this databridge.
   

Note: Databridge can't be deleted while it has active connections. Switch the connections to a different Databridge, or delete those connections, and then try again.

5. Troubleshooting

6. Points to note

• Databridge requires outbound internet connectivity from the machine where it is installed. It should be installed on a dedicated server that remains powered on. If the machine sleeps or restarts, all associated workflows will be interrupted.
  
• The downloaded databridge package is valid for 15 days.

• A maximum of five databridge can be actively connected at a time.
  

7. Glossary

• Databridge: A lightweight agent that enables secure communication between Zoho Creator and data sources within your privately hosted network.
  
• Outbound connection: A connection initiated from within your network to an external service, eliminating the need for inbound firewall access.
  

8. Related links

• Understanding databridge