Docs Menu
Docs Home
BI Connector

Install BI Connector on Debian-based Linux

On this page

  • Prerequisites
  • MongoDB User Permissions
  • Install the BI Connector


The MongoDB Connector for BI and associated utilities are compatible with all currently supported MongoDB server versions.

To set up MongoDB Connector for BI with a business intelligence tool such as Tableau, follow the steps on this page.

  • OpenSSL installed on your host.

To verify OpenSSL is installed on your system, run the following command:

dpkg -l | grep -i openssl

If OpenSSL is not installed, use your package manager to install it.

If your MongoDB instance uses authentication, your BI Connector instance must also use authentication. The user that connects to MongoDB via the mongosqld program must have permission to read from all the namespaces you wish to sample data from.

For more details about MongoDB user permissions in BI Connector, see User Permissions for Cached Sampling.


Download the BI Connector from the MongoDB Download Center.

  1. Extract the .tar archive you downloaded.

    tar -xvzf mongodb-bi-linux-{arch}-{platform}-{version}.tgz
  2. Install the programs within the bin/ directory into a directory listed in your system PATH.

    sudo install -m755 bin/mongo* /usr/local/bin/

    If a prior version exists, overwrite the binaries.

New in version 2.9.

To help you get started, a sample mongosqld configuration file named example-mongosqld-config.yml is included with the installation package. To learn how to start BI Connector with a configuration file, refer to the mongosqld documentation section on the Configuration File.

You are now ready to launch the BI Connector. The following guide contains detailed information on BI Connector configuration, schema generation, and launch options:

← Install BI Connector on Red Hat Enterprise-based Linux