1MONGOC_INSTALLING(3) MongoDB C Driver MONGOC_INSTALLING(3)
2
6 mongoc_installing - Installing the MongoDB C Driver (libmongoc) and
7 BSON library (libbson)
8 The following guide will step you through the process of downloading,
10 building, and installing the current release of the MongoDB C Driver
11 (libmongoc) and BSON library (libbson).
12
14 The MongoDB C Driver is continuously tested on variety of platforms
15 including:
16 · Archlinux
18 · Debian 8.1
20 · macOS 10.10
22 · Microsoft Windows Server 2008
24 · RHEL 7.0, 7.1, 7.2
26 · SUSE 12
28 · Ubuntu 12.04, 14.04, 16.04
30 · Clang 3.4, 3.5, 3.7, 3.8
32 · GCC 4.6, 4.8, 4.9, 5.3
34 · MinGW-W64
36 · Visual Studio 2010, 2013, 2015
38 · x86, x86_64, ARM (aarch64), Power8 (ppc64le), zSeries (s390x)
40
42 Several Linux distributions provide packages for libmongoc and its
43 dependencies. One advantage of installing libmongoc with a package man‐
44 ager is that its dependencies (including libbson) will be installed
45 automatically.
46 The libmongoc package is available on recent versions of Debian and
48 Ubuntu.
49 $ apt-get install libmongoc-1.0-0
51 On Fedora, a mongo-c-driver package is available in the default reposi‐
53 tories and can be installed with:
54 $ dnf install mongo-c-driver
56 On recent Red Hat systems, such as CentOS and RHEL 7, a mongo-c-driver
58 package is available in the EPEL repository. To check which version is
59 available, see https://apps.fedoraproject.org/packages/mongo-c-driver.
60 The package can be installed with:
61 $ yum install mongo-c-driver
63
65 The libbson package is available on recent versions of Debian and
66 Ubuntu. If you have installed libmongoc, then libbson will have already
67 been installed as a dependency. It is also possible to install libbson
68 without libmongoc.
69 $ apt-get install libbson-1.0
71 On Fedora, a libbson package is available in the default repositories
73 and can be installed with:
74 $ dnf install libbson
76 On recent Red Hat systems, such as CentOS and RHEL 7, a libbson package
78 is available in the EPEL repository. To check which version is avail‐
79 able, see https://apps.fedoraproject.org/packages/libbson. The package
80 can be installed with:
81 $ yum install libbson
83
85 Prerequisites for libmongoc
86 OpenSSL is required for authentication or for SSL connections to Mon‐
87 goDB. Kerberos or LDAP support requires Cyrus SASL.
88 To install all optional dependencies on RedHat / Fedora:
90 $ sudo yum install cmake openssl-devel cyrus-sasl-devel
92 On Debian / Ubuntu:
94 $ sudo apt-get install cmake libssl-dev libsasl2-dev
96 On FreeBSD:
98 $ su -c 'pkg install cmake openssl cyrus-sasl'
100 Prerequisites for libbson
102 The only prerequisite for building libbson is cmake. The command lines
103 above can be adjusted to install only cmake.
104 Building from a release tarball
106 Unless you intend to contribute to mongo-c-driver and/or libbson, you
107 will want to build from a release tarball.
108 The most recent release of libmongoc and libbson, both of which are
110 included in mongo-c-driver, is 1.13.1 and can be downloaded here. The
111 instructions in this document utilize cmake's out-of-source build fea‐
112 ture to keep build artifacts separate from source files.
113 The following snippet will download and extract the driver, and config‐
115 ure it:
116 $ wget https://github.com/mongodb/mongo-c-driver/releases/download/1.13.1/mongo-c-driver-1.13.1.tar.gz
118 $ tar xzf mongo-c-driver-1.13.1.tar.gz
119 $ cd mongo-c-driver-1.13.1
120 $ mkdir cmake-build
121 $ cd cmake-build
122 $ cmake -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF ..
123 The -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF option is recommended, see
125 init-cleanup. Another useful cmake option is -DCMAKE_BUILD_TYPE=Release
126 for a release optimized build and -DCMAKE_BUILD_TYPE=Debug for a debug
127 build. For a list of all configure options, run cmake -L ...
128 If cmake completed successfully, you will see a considerable amount of
130 output describing your build configuration. The final line of output
131 should look something like this:
132 -- Build files have been written to: /home/user/mongo-c-driver-1.13.1/cmake-build
134 If cmake concludes with anything different, then there is likely an
136 error or some other problem with the build. Review the output to iden‐
137 tify and correct the problem.
138 mongo-c-driver contains a copy of libbson, in case your system does not
140 already have libbson installed. The build will detect if libbson is not
141 installed and use the bundled libbson.
142 Additionally, it is possible to build only libbson by setting the -DEN‐
144 ABLE_MONGOC=OFF option:
145 $ cmake -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF -DENABLE_MONGOC=OFF ..
147 A build configuration description similar to the one above will be dis‐
149 played, though with fewer entries. Once the configuration is complete,
150 the selected items can be built and installed with these commands:
151 $ make
153 $ sudo make install
154 There are two ways to uninstall the components that have been
156 installed. The first is to invoke the uninstall program directly. On
157 Linux/Unix:
158 $ sudo /usr/local/share/mongo-c-driver/uninstall.sh
160 On Windows:
162 C:\Users\user> C:\mongo-c-driver\share\mongo-c-driver\uninstall.bat
164 The second way to uninstall is from within the build directory, assum‐
166 ing that it is in the exact same state as when the install command was
167 invoked:
168 $ sudo make uninstall
170 The second approach simply invokes the uninstall program referenced in
172 the first approach.
173 Building from git
175 Clone the repository and build the current master or a particular
176 release tag:
177 $ git clone https://github.com/mongodb/mongo-c-driver.git
179 $ cd mongo-c-driver
180 $ git checkout x.y.z # To build a particular release
181 $ mkdir cmake-build
182 $ cd cmake-build
183 $ cmake -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF ..
184 $ make
185 $ sudo make install
186 Generating the documentation
188 Install Sphinx, then:
189 $ cmake -DENABLE_MAN_PAGES=ON -DENABLE_HTML_DOCS=ON ..
191 $ make mongoc-doc
192 To build only the libbson documentation:
194 $ cmake -DENABLE_MAN_PAGES=ON -DENABLE_HTML_DOCS=ON ..
196 $ make bson-doc
197 The -DENABLE_MAN_PAGES=ON and -DENABLE_HTML_DOCS=ON can also be added
199 as options to a normal build from a release tarball or from git so that
200 the documentation is built at the same time as other components.
201
203 Install the XCode Command Line Tools:
204 $ xcode-select --install
206 The cmake utility is also required. First install Homebrew according to
208 its instructions, then:
209 $ brew install cmake
211 Download the latest release tarball:
213 $ curl -LO https://github.com/mongodb/mongo-c-driver/releases/download/1.13.1/mongo-c-driver-1.13.1.tar.gz
215 $ tar xzf mongo-c-driver-1.13.1.tar.gz
216 $ cd mongo-c-driver-1.13.1
217 Build and install the driver:
219 $ mkdir cmake-build
221 $ cd cmake-build
222 $ cmake -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF ..
223 All of the same variations described above (e.g., building only libb‐
225 son, building documentation, etc.) are available when building on mac‐
226 OS.
227
229 Building on Windows requires Windows Vista or newer and Visual Studio
230 2010 or newer. Additionally, cmake is required to generate Visual Stu‐
231 dio project files.
232 Let's start by generating Visual Studio project files. The following
234 assumes we are compiling for 64-bit Windows using Visual Studio 2015
235 Express, which can be freely downloaded from Microsoft. We will be uti‐
236 lizing cmake's out-of-source build feature to keep build artifacts sep‐
237 arate from source files.
238 cd mongo-c-driver-1.13.1
240 mkdir cmake-build
241 cd cmake-build
242 cmake -G "Visual Studio 14 2015 Win64" \
243 "-DCMAKE_INSTALL_PREFIX=C:\mongo-c-driver" \
244 "-DCMAKE_PREFIX_PATH=C:\mongo-c-driver" \
245 ..
246 (Run cmake -LH .. for a list of other options.)
248 Now that we have project files generated, we can either open the
250 project in Visual Studio or compile from the command line. Let's build
251 using the command line program msbuild.exe:
252 msbuild.exe /p:Configuration=RelWithDebInfo ALL_BUILD.vcxproj
254 Visual Studio's default build type is Debug, but we recommend a release
256 build with debug info for production use. Now that libmongoc and libb‐
257 son are compiled, let's install them using msbuild. It will be
258 installed to the path specified by CMAKE_INSTALL_PREFIX.
259 msbuild.exe INSTALL.vcxproj
261 You should now see libmongoc and libbson installed in C:\mongo-c-driver
263 To use the driver libraries in your program, see visual-studio-guide.
265
267 Install MSYS2 from msys2.github.io. Choose the x86_64 version, not
268 i686.
269 Open c:\msys64\ming64_shell.bat (not the msys2_shell). Install depen‐
271 dencies:
272 pacman --noconfirm -Syu
274 pacman --noconfirm -S mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake
275 pacman --noconfirm -S mingw-w64-x86_64-extra-cmake-modules make tar
276 pacman --noconfirm -S mingw64/mingw-w64-x86_64-cyrus-sasl
277 Download and untar the latest tarball, enter its directory, and build
279 with CMake:
280 CC=/mingw64/bin/gcc.exe /mingw64/bin/cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX="C:/mongo-c-driver" ..
282 make
283
285 MongoDB, Inc
286
288 2017-present, MongoDB, Inc
2891.13.1 Jan 24, 2019 MONGOC_INSTALLING(3)