install-mongodb-on-os-x.txt

==========================================
Install MongoDB Community Edition on macOS
==========================================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: twocols

.. |arrow| unicode:: U+27A4
.. |edition| replace:: Community
.. |distro-name| replace:: macOS
.. |package-manager| replace:: ``brew``
.. |executable-name| replace:: ``mongod``

.. include:: /includes/fact-atlas-banner.rst

Overview
--------

.. _`MongoDB Download Center`: https://www.mongodb.com/try/download/community?tck=docs_server

Use this tutorial to install MongoDB {+version+} |edition| Edition on
macOS using the third-party `Homebrew <https://brew.sh>`__
package manager.

You can also use these instructions to install the
`MongoDB Database Tools <https://docs.mongodb.com/database-tools/>`__.
See :ref:`brew-install-dbtools` for more information.

MongoDB Version
~~~~~~~~~~~~~~~

.. include:: /includes/fact-install-past-mongodb.rst

Considerations
--------------

Platform Support
~~~~~~~~~~~~~~~~

.. include:: /includes/fact-platform-support-macos.rst

Production Notes
~~~~~~~~~~~~~~~~

.. include:: /includes/fact-see-production-notes.rst

.. _install-with-homebrew:

Install MongoDB Community Edition
---------------------------------

.. _osx-prereq:

Prerequisites
~~~~~~~~~~~~~

Ensure your system meets each of the following prerequisites. You only
need to perform each prerequisite step once on your system. If you
have already performed the prerequisite steps as part of an earlier
MongoDB installation using Homebrew, you can skip to the
:ref:`installation procedure <install>`.

Install Xcode Command-Line Tools
````````````````````````````````

Homebrew requires the Xcode command-line tools from Apple's Xcode.

- Install the Xcode command-line tools by running the following
  command in your macOS Terminal:

  .. code-block:: sh

     xcode-select --install

Install Homebrew
````````````````

macOS does not include the Homebrew ``brew`` package by default.

- Install ``brew`` using the official
  `Homebrew installation instructions <https://brew.sh/#install>`_.

.. _install:

Installing MongoDB {+version+} |edition| Edition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Follow these steps to install MongoDB |edition| Edition using Homebrew's
``brew`` package manager. Be sure that you have followed the
:ref:`installation prerequisites <osx-prereq>` above before proceeding.

#. Tap the `MongoDB Homebrew Tap
   <https://github.com/mongodb/homebrew-brew>`_ to download the official
   Homebrew formula for MongoDB and the Database Tools, by running the
   following command in your macOS Terminal:

   .. code-block:: sh

      brew tap mongodb/brew

   If you have already done this for a previous installation of MongoDB,
   you can skip this step.

#. To update Homebrew and all existing formulae:

   .. code-block:: bash

      brew update

#. To install MongoDB, run the following command in your macOS Terminal
   application:

   .. code-block:: sh

      brew install mongodb-community@{+version+}

   Alternatively, you can specify a previous version of MongoDB if
   desired. You can also maintain multiple versions of MongoDB side by
   side in this manner.

.. tip::

   If you have previously installed an older version of the formula,
   you may encounter a ChecksumMismatchError. To resolve, see
   :ref:`troubleshooting-checksumerror`.

The installation includes the following binaries:

- The :binary:`~bin.mongod` server
- The :binary:`~bin.mongos` sharded cluster query router
- The :binary:`~bin.mongo` shell

In addition, the installation creates the following files and
directories at the location specified below, depending on your Apple
hardware:

.. list-table::
   :header-rows: 1
   :widths: 20 30 30

   * -
     - Intel Processor
     - Apple M1 Processor

   * - :doc:`configuration file </reference/configuration-options>`
     - ``/usr/local/etc/mongod.conf``
     - ``/opt/homebrew/etc/mongod.conf``

   * - :setting:`log directory <systemLog.path>`
     - ``/usr/local/var/log/mongodb``
     - ``/opt/homebrew/var/log/mongodb``

   * - :setting:`data directory <storage.dbPath>`
     - ``/usr/local/var/mongodb``
     - ``/opt/homebrew/var/mongodb``

See `Apple's documentation <https://support.apple.com/en-us/HT211814>`__
for the current list of Apple hardware using the M1 processor. You can
also run the following command to check where ``brew`` has installed
these files and directories:

.. code-block:: sh

   brew --prefix

Run MongoDB Community Edition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Follow these steps to run MongoDB |edition| Edition. These instructions
assume that you are using the default settings.

You can run MongoDB as a macOS service using ``brew``, or you can run
MongoDB manually as a background process. It is recommended to run
MongoDB as a macOS service, as doing so sets the correct system
``ulimit`` values automatically (see
:ref:`ulimit settings <ulimit-settings>` for more information).

- To run MongoDB (i.e. the :binary:`~bin.mongod` process) **as a
  macOS service**, issue the following:

  .. code-block:: sh

     brew services start mongodb-community@{+version+}

  To stop a :binary:`~bin.mongod` running as a macOS service, use the
  following command as needed:

  .. code-block:: sh

     brew services stop mongodb-community@{+version+}

- To run MongoDB (i.e. the :binary:`~bin.mongod` process) **manually
  as a background process**, issue the following:

  - For macOS running Intel processors:

    .. code-block:: sh

       mongod --config /usr/local/etc/mongod.conf --fork

  - For macOS running on `Apple M1 processors
    <https://support.apple.com/en-us/HT211814>`__:

    .. code-block:: sh

       mongod --config /opt/homebrew/etc/mongod.conf --fork

  To stop a :binary:`~bin.mongod` running as a background process,
  connect to the :binary:`~bin.mongod` from the :program:`mongo`
  shell, and issue the :dbcommand:`shutdown` command as needed.

Both methods use the :file:`mongod.conf` file created
during the install. You can add your own MongoDB
:doc:`configuration options </reference/configuration-options>` to
this file as well.

.. admonition:: macOS Prevents ``mongod`` From Opening
   :class: note

   .. include:: /includes/extracts/macos-prevent-launch-mongod.rst

To verify that MongoDB is running, perform one of the following:

- If you started MongoDB **as a macOS service**:

  .. code-block:: sh

     brew services list

  You should see the service ``mongodb-community`` listed as
  ``started``.

- If you started MongoDB **manually as a background process**:

  .. code-block:: sh

     ps aux | grep -v grep | grep mongod

  You should see your ``mongod`` process in the output.

You can also view the log file to see the current status of your
``mongod`` process: ``/usr/local/var/log/mongodb/mongo.log``.

Connect and Use MongoDB
~~~~~~~~~~~~~~~~~~~~~~~

To begin using MongoDB, connect a :binary:`~bin.mongo` shell to the
running instance. From a new terminal, issue the following:

.. code-block:: sh

   mongo

.. admonition:: macOS Prevents ``mongo`` From Opening
   :class: note

   .. include:: /includes/extracts/macos-prevent-launch-mongo.rst

For information on CRUD (Create,Read,Update,Delete) operations, see:

- :doc:`/tutorial/insert-documents`
- :doc:`/tutorial/query-documents`
- :doc:`/tutorial/update-documents`
- :doc:`/tutorial/remove-documents`

.. _brew-install-dbtools:

Installing the MongoDB Database Tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The `MongoDB Database Tools
<https://docs.mongodb.com/database-tools/>`__ are a collection of
command-line utilities for working with a MongoDB deployment,
including data backup and import/export tools like
:binary:`mongoimport` and :binary:`mongodump` as well as monitoring
tools like :binary:`mongotop`.

Follow these steps to install the MongoDB Database Tools using
Homebrew's ``brew`` package manager.

#. Verify that your system meets all the
   :ref:`installation prerequisites<osx-prereq>` by running the
   following command in your macOS Terminal:

   .. code-block:: sh

      brew tap | grep mongodb

   You should see the MongoDB brew tap listed. If you do not, or you
   receive an error, return to the :ref:`osx-prereq` section.

#. To install the MongoDB Database Tools, run the following command in
   your macOS Terminal application:

   .. code-block:: sh

      brew install mongodb-database-tools

Once installed, the Database Tools are available directly from the
command line in your macOS Terminal application.

For example you could run :binary:`mongotop` against a running MongoDB
instance by invoking it in your macOS Terminal like so:

.. code-block:: sh

   mongotop

It should start up, connect to your running :binary:`mongod`, and start
reporting usage statistics.

See the `MongoDB Database Tools Documentation
<https://docs.mongodb.com/database-tools/>`__ for usage information for
each of the Database Tools.

Additional Information
----------------------

Localhost Binding by Default
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. include:: /includes/fact-installation-bind-ip-default-in-config.rst

.. _troubleshooting-checksumerror:

Troubleshooting ChecksumMismatchError
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have previously installed an older version of the formula,
you may encounter a ``ChecksumMismatchError`` resembling the following:

.. code-block:: sh
   :copyable: false

   Error: An exception occurred within a child process:

     ChecksumMismatchError: SHA256 mismatch

   Expected: c7214ee7bda3cf9566e8776a8978706d9827c1b09017e17b66a5a4e0c0731e1f

     Actual: 6aa2e0c348e8abeec7931dced1f85d4bb161ef209c6af317fe530ea11bbac8f0

    Archive: /Users/kay/Library/Caches/Homebrew/downloads/a6696157a9852f392ec6323b4bb697b86312f0c345d390111bd51bb1cbd7e219--mongodb-macos-x86_64-4.2.0.tgz

   To retry an incomplete download, remove the file above.

To fix:

#. Remove the downloaded :file:`.tgz` archive.

#. Retap the formula.

   .. code-block:: sh

      brew untap mongodb/brew && brew tap mongodb/brew

#. Retry the install.

   .. code-block:: sh

      brew install mongodb-community@{+version+}

.. toctree::
   :hidden:
   :titlesonly:

   Install using .tgz Tarball </tutorial/install-mongodb-on-os-x-tarball>