Installing the MongoDB C Driver — MongoDB C Driver 1.6.3

- MongoDB C Driver 1.6.3 »

# Installing the MongoDB C Driver

The following guide will step you through the process of downloading, building, and installing the current release of the MongoDB C Driver.

## Supported Platforms

The MongoDB C Driver is continuously tested on variety of platforms including:

Operating Systems | CPU Architectures | Compiler Toolchain
--- | --- | ---
GNU/Linux | x86 and x86_64 | GCC 4.1 and newer
Solaris 11 | ARM | Clang 3.3 and newer
Mac OS X 10.6 and newer | PPC | Microsoft Visual Studio 2010 and newer
Windows Vista, 7, and 8 | SPARC | Oracle Solaris Studio 12
FreeBSD |  | MinGW

## Install with a Package Manager

The libmongoc package is available on recent versions of Debian and Ubuntu.

    $ apt-get install libmongoc-1.0-0

On Fedora, a mongo-c-driver package is available in the default repositories and can be installed with:

    $ dnf install mongo-c-driver

On recent Red Hat systems, such as CentOS and RHEL 7, a mongo-c-driver package is available in the EPEL repository. To check version available, see https://apps.fedoraproject.org/packages/mongo-c-driver. The package can be installed with:

    $ yum install mongo-c-driver

## Building on Unix

### Prerequisites

OpenSSL is required for authentication or for SSL connections to MongoDB. Kerberos or LDAP support requires Cyrus SASL.

To install all optional dependencies on RedHat / Fedora:

    $ sudo yum install pkg-config openssl-devel cyrus-sasl-devel

On Debian / Ubuntu:

    $ sudo apt-get install pkg-config libssl-dev libsasl2-dev

On FreeBSD:

    $ su -c 'pkg install pkgconf openssl cyrus-sasl'

### Building from a release tarball

Unless you intend on contributing to the mongo-c-driver, you will want to build from a release tarball.

The most recent release of libmongoc is 1.6.3 and can be downloaded here. The following snippet will download and extract the driver, and configure it:

    $ wget https://github.com/mongodb/mongo-c-driver/releases/download/1.6.3/mongo-c-driver-1.6.3.tar.gz
    $ tar xzf mongo-c-driver-1.6.3.tar.gz
    $ cd mongo-c-driver-1.6.3
    $ ./configure --disable-automatic-init-and-cleanup

The `--disable-automatic-init-and-cleanup` option is recommended, see Initialization and cleanup. For a list of all configure options, run `./configure --help`.

If `configure` completed successfully, you'll see something like the following describing your build configuration.

    libmongoc 1.6.3 was configured with the following options:

    Build configuration:
      Enable debugging (slow)                          : no
      Compile with debug symbols (slow)                : no
      Enable GCC build optimization                    : yes
      Enable automatic init and cleanup                : no
      Code coverage support                            : no
      Cross Compiling                                  : no
      Fast counters                                    : no
      Shared memory performance counters               : yes
      SASL                                             : sasl2
      SSL                                              : openssl
      Libbson                                          : bundled

    Documentation:
      man                                              : no
      HTML                                             : no

mongo-c-driver contains a copy of libbson, in case your system does not already have libbson installed. The configure script will detect if libbson is not installed and use the bundled libbson.

    $ make
    $ sudo make install

### Building from git

To build an unreleased version of the driver from git requires additional dependencies.

RedHat / Fedora:

    $ sudo yum install git gcc automake autoconf libtool

Debian / Ubuntu:

    $ sudo apt-get install git gcc automake autoconf libtool

FreeBSD:

    $ su -c 'pkg install git gcc automake autoconf libtool'

Once you have the dependencies installed, clone the repository and build the current master or a particular release tag:

    $ git clone https://github.com/mongodb/mongo-c-driver.git
    $ cd mongo-c-driver
    $ git checkout x.y.z  # To build a particular release
    $ ./autogen.sh --with-libbson=bundled
    $ make
    $ sudo make install

### Generating the documentation

Install Sphinx, then:

    $ ./configure --enable-html-docs --enable-man-pages
    $ make man html

## Building on Mac OS X

Install the XCode Command Line Tools:

    $ xcode-select --install

Some Homebrew packages are also required. First install Homebrew according to its instructions, then:

    $ brew install automake autoconf libtool pkgconfig

Download the latest release tarball

    $ curl -LO https://github.com/mongodb/mongo-c-driver/releases/download/1.6.3/mongo-c-driver-1.6.3.tar.gz
    $ tar xzf mongo-c-driver-1.6.3.tar.gz
    $ cd mongo-c-driver-1.6.3

Build and install the driver:

    $ ./configure
    $ make
    $ sudo make install

### Native TLS Support on Mac OS X / Darwin (Secure Transport)

The MongoDB C Driver supports the Darwin native TLS and crypto libraries. Using the native libraries there is no need to install OpenSSL. By default however, the driver will compile against OpenSSL if it detects it being available. If OpenSSL is not available, it will fallback on the native libraries.

To compile against the Darwin native TLS and crypto libraries, even when OpenSSL is available, configure the driver like so:

    $ ./configure --enable-ssl=darwin

### OpenSSL support on El Capitan

Beginning in OS X 10.11 El Capitan, OS X no longer includes the OpenSSL headers. To build the driver with SSL on El Capitan and later:

    $ brew install openssl
    $ export LDFLAGS="-L/usr/local/opt/openssl/lib"
    $ export CPPFLAGS="-I/usr/local/opt/openssl/include"

## Building on Windows

Building on Windows requires Windows Vista or newer and Visual Studio 2010 or newer. Additionally, `cmake` is required to generate Visual Studio project files.

Let's start by generating Visual Studio project files for libbson, a dependency of the C driver. The following assumes we are compiling for 64-bit Windows using Visual Studio 2015 Express, which can be freely downloaded from Microsoft.

    cd mongo-c-driver-1.6.3\src\libbson
    cmake -G "Visual Studio 14 2015 Win64" "-DCMAKE_INSTALL_PREFIX=C:\mongo-c-driver"

(Run `cmake -LH .` for a list of other options.)

Now that we have project files generated, we can either open the project in Visual Studio or compile from the command line. Let's build using the command line program `msbuild.exe`

    msbuild.exe ALL_BUILD.vcxproj

Now that libbson is compiled, let's install it using msbuild. It will be installed to the path specified by `CMAKE_INSTALL_PREFIX`.

    msbuild.exe INSTALL.vcxproj

You should now see libbson installed in `C:\mongo-c-driver`

Now let's do the same for the MongoDB C driver.

    cd mongo-c-driver-1.6.3
    cmake -G "Visual Studio 14 2015 Win64" \
      "-DCMAKE_INSTALL_PREFIX=C:\mongo-c-driver" \
      "-DBSON_ROOT_DIR=C:\mongo-c-driver"

    msbuild.exe ALL_BUILD.vcxproj
    msbuild.exe INSTALL.vcxproj

All of the MongoDB C Driver's components will now be found in `C:\mongo-c-driver`.

### Native TLS Support on Windows (Secure Channel)

The MongoDB C Driver supports the Windows native TLS and crypto libraries. Using the native libraries there is no need to install OpenSSL. By default however, the driver will compile against OpenSSL if it detects it being available. If OpenSSL is not available, it will fallback on the native libraries.

To compile against the Windows native TLS and crypto libraries, even when OpenSSL is available, configure the driver like so:

    cmake -G "Visual Studio 14 2015 Win64" \
      "-DENABLE_SSL=WINDOWS" \
      "-DCMAKE_INSTALL_PREFIX=C:\mongo-c-driver" \
      "-DBSON_ROOT_DIR=C:\mongo-c-driver"

Created using Sphinx 1.5.3, based on Sphinx Readable Theme.