0
0
mirror of https://github.com/mongodb/mongo.git synced 2024-11-30 17:10:48 +01:00
mongodb/docs/building.md

4.1 KiB

Building MongoDB

To build MongoDB, you will need:

  • A modern C++ compiler capable of compiling C++17. One of the following is required:
    • GCC 8.0 or newer
    • Clang 7.0 (or Apple XCode 10.0 Clang) or newer
    • Visual Studio 2017 version 15.9 or newer (See Windows section below for details)
  • On Linux and macOS, the libcurl library and header is required. MacOS includes libcurl.
    • Fedora/RHEL - dnf install libcurl-devel
    • Ubuntu/Debian - libcurl-dev is provided by three packages. Install one of them:
      • libcurl4-openssl-dev
      • libcurl4-nss-dev
      • libcurl4-gnutls-dev
  • Python 3.7.x and Pip modules:
    • See the section "Python Prerequisites" below.
  • About 13 GB of free disk space for the core binaries (mongod, mongos, and mongo) and about 600 GB for the all target.

MongoDB supports the following architectures: arm64, ppc64le, s390x, and x86-64. More detailed platform instructions can be found below.

MongoDB Tools

The MongoDB command line tools (mongodump, mongorestore, mongoimport, mongoexport, etc) have been rewritten in Go and are no longer included in this repository.

The source for the tools is now available at mongodb/mongo-tools.

Python Prerequisites

In order to build MongoDB, Python 3.7.x is required, and several Python modules. To install the required Python modules, run:

$ pip3 install -r etc/pip/compile-requirements.txt

Note: If the pip3 command is not available, pip without a suffix may be the pip command associated with Python 3.7.x.

Note: In order to compile C-based Python modules, you'll also need the Python and OpenSSL C headers. Run:

  • Fedora/RHEL - dnf install python3-devel openssl-devel
  • Ubuntu/Debian - apt-get install python3.7-dev libssl-dev

SCons

For detail information about building, please see the build manual

If you want to build everything (mongod, mongo, tests, etc):

$ python3 buildscripts/scons.py all

If you only want to build the database:

$ python3 buildscripts/scons.py mongod

Note: For C++ compilers that are newer than the supported version, the compiler may issue new warnings that cause MongoDB to fail to build since the build system treats compiler warnings as errors. To ignore the warnings, pass the switch --disable-warnings-as-errors to scons.

$ python3 buildscripts/scons.py mongod --disable-warnings-as-errors

To install

$ python3 buildscripts/scons.py --prefix=/opt/mongo install

Please note that prebuilt binaries are available on mongodb.org and may be the easiest way to get started.

SCons Targets

The following targets can be named on the scons command line to build only certain components:

  • mongod
  • mongos
  • mongo
  • core (includes mongod, mongos, mongo)
  • all

Windows

See the windows build manual

Build requirements:

  • Visual Studio 2017 version 15.9 or newer
  • Python 3.7

Or download a prebuilt binary for Windows at www.mongodb.org.

Debian/Ubuntu

To install dependencies on Debian or Ubuntu systems:

# apt-get install build-essential
# apt-get install libboost-filesystem-dev libboost-program-options-dev libboost-system-dev libboost-thread-dev

To run tests as well, you will need PyMongo:

# apt-get install python3-pymongo

OS X

Using Homebrew:

$ brew install mongodb

Using MacPorts:

$ sudo port install mongodb

FreeBSD

Install the following ports:

  • devel/libexecinfo
  • lang/llvm70
  • lang/python

Optional Components if you want to use system libraries instead of the libraries included with MongoDB

  • archivers/snappy
  • devel/boost
  • devel/pcre

Add CC=clang70 CXX=clang++70 to the scons options, when building.

OpenBSD

Install the following ports:

  • devel/libexecinfo
  • lang/gcc
  • lang/python