Docs Menu
Docs Home
/
BI Connector
/
Install or Update BI Connector

Install BI Connector on macOS

On this page

  • Prerequisites
  • MongoDB User Permissions
  • Install the BI Connector

Note

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.

Prerequisites

  • OpenSSL installed on your host.

To install OpenSSL via Homebrew, run the following command:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew update
brew install openssl

MongoDB User Permissions

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.

Install the BI Connector

1

Download the MongoDB Connector for BI.

Download the BI Connector from the MongoDB Download Center.

2

Verify the integrity of the downloaded package.

The MongoDB release team digitally signs all software packages to certify that a particular MongoDB package is a valid and unaltered MongoDB release. The bi-connector.asc key to validate the BI Connector is available on pgp.mongodb.com as a PGP key in .asc format.

  1. Run the following command to downloaded the .sig file.

    curl -LO https://info-mongodb-com.s3.amazonaws.com/mongodb-bi/v2/mongodb-bi-osx-{x86_64|arm64-macos{11|13}}-{version}.zip.sig

  2. Run the following command to download the import key file.

    curl -LO https://pgp.mongodb.com/bi-connector.asc
    gpg --import bi-connector.asc
    gpg: key 1CCF1A1263CDD699: public key "MongoDB BI Connector Release Signing Key <packaging@mongodb.com>" imported
    gpg: Total number processed: 1
    gpg:               imported: 1

  3. Run the following command to verify the MongoDB installation file.

    gpg --verify mongodb-bi-osx-{x86_64|arm64-macos{11|13}}-{version}.zip.sig mongodb-bi-osx-{x86_64|arm64-macos{11|13}}-{version}.zip

    GPG should return this response:

    gpg: Signature made Thu Jun 13 10:17:03 2024 PDT
    gpg:                using RSA key BD66803ABD3EB56953142EE51CCF1A1263CDD699
    gpg: Good signature from "MongoDB BI Connector Release Signing Key <packaging@mongodb.com>" [unknown]

    If the package is properly signed, but you do not currently trust the signing key in your local trustdb, gpg will also return the following message:

    gpg: WARNING: This key is not certified with a trusted signature!
    gpg:          There is no indication that the signature belongs to the owner.
    Primary key fingerprint: BD66 803A BD3E B569 5314  2EE5 1CCF 1A12 63CD D699

    If you receive the following error message, confirm that you imported the correct public key:

    gpg: Can't check signature: public key not found
3

Install the MongoDB Connector for BI.

  1. Extract the downloaded .zip archive. Replace {SOURCE-PATH} with the path to the directory where you downloaded the .zip archive. Replace {DESTINATION-PATH} with the path to the directory where you want to extract the archive.

    unzip {SOURCE-PATH}/mongodb-bi-osx-{x86_64|arm64-macos{11|13}}-{version}.zip -d {DESTINATION-PATH}

  2. Change to the mongodb-bi-osx-{x86_64|arm64-macos{11|13}}-{version} directory. Replace {DESTINATION-PATH} with the path to the directory where you extracted the archive in the previous step.

    cd {DESTINATION-PATH}/mongodb-bi-osx-{x86_64|arm64-macos{11|13}}-{version}/

  3. Install the programs within the bin/ directory into a directory listed in your system PATH. If a prior version exists, overwrite the binaries.

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

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.

Launch the BI Connector

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