Install MongoDB Enterprise Edition on Debian
On this page
Note
MongoDB Atlas
MongoDB Atlas is a hosted MongoDB service option in the cloud which requires no installation overhead and offers a free tier to get started.
Overview
Use this tutorial to install MongoDB 4.4 Enterprise Edition
using the apt
package manager.
MongoDB Enterprise Edition is available on select platforms and contains support for several features related to security and monitoring.
MongoDB Version
This tutorial installs MongoDB 4.4 Enterprise Edition. To install a different version of MongoDB Enterprise, use the version drop-down menu in the upper-left corner of this page to select the documentation for that version.
Considerations
Platform Support
MongoDB 4.4 Enterprise Edition supports the following 64-bit Debian releases on x86_64 architecture:
Debian 10 "Buster"
Debian 9 "Stretch"
MongoDB only supports the 64-bit versions of these platforms.
See Platform Support Notes for more information.
Production Notes
Before deploying MongoDB in a production environment, consider the Production Notes document which offers performance considerations and configuration recommendations for production MongoDB deployments.
Official MongoDB Packages
To install MongoDB Enterprise on your Debian system, these
instructions will use the official mongodb-enterprise
package, which is
maintained and supported by MongoDB Inc. The official mongodb-enterprise
package always contains the latest version of MongoDB, and is available
from its own dedicated repo.
Important
The mongodb
package provided by Debian is not
maintained by MongoDB Inc. and conflicts with the official
mongodb-enterprise
package. If you have already installed the mongodb
package on your Debian system, you must first uninstall
the mongodb
package before proceeding with these instructions.
See MongoDB Enterprise Edition Packages for the complete list of official packages.
Install MongoDB Enterprise Edition
Follow these steps to install MongoDB Enterprise Edition using the
apt
package manager.
From a terminal, install gnupg
and curl
if they are not already
available:
sudo apt-get install gnupg curl
To import the MongoDB public GPG key, run the following command:
curl -fsSL https://pgp.mongodb.com/server-4.4.asc | \ sudo gpg -o /usr/share/keyrings/mongodb-server-4.4.gpg \ --dearmor
Create a /etc/apt/sources.list.d/mongodb-enterprise.list
file for MongoDB.
Create the list file using the command appropriate for your version of Debian:
echo "deb [ signed-by=/usr/share/keyrings/mongodb-server-4.4.gpg ] https://repo.mongodb.com/apt/debian buster/mongodb-enterprise/4.4 main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list
echo "deb [ signed-by=/usr/share/keyrings/mongodb-server-4.4.gpg ] https://repo.mongodb.com/apt/debian stretch/mongodb-enterprise/4.4 main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list
Install the apt-transport-https
package:
apt install apt-transport-https
If you'd like to install MongoDB Enterprise packages from a particular release series, you can specify the release series of a version of MongoDB that is supported for your Debian build in the repository configuration. For example, to restrict your system to the 4.2 release series, add the following repository:
echo "deb [ signed-by=/usr/share/keyrings/mongodb-server-4.2.gpg ] https://repo.mongodb.com/apt/debian buster/mongodb-enterprise/4.2 main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise-4.2.list
echo "deb [ signed-by=/usr/share/keyrings/mongodb-server-4.2.gpg ] https://repo.mongodb.com/apt/debian buster/mongodb-enterprise/4.2 main" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise-4.2.list
Install the apt-transport-https
package:
apt install apt-transport-https
Install the MongoDB Enterprise packages.
Install MongoDB Enterprise.
Issue the following command:
sudo apt-get install -y mongodb-enterprise
Install a specific release of MongoDB Enterprise.
To install a specific release, you must specify each component package individually along with the version number, as in the following example:
sudo apt-get install -y mongodb-enterprise=4.4.29 mongodb-enterprise-server=4.4.29 mongodb-enterprise-shell=4.4.29 mongodb-enterprise-mongos=4.4.29 mongodb-enterprise-tools=4.4.29
If you only install mongodb-enterprise=4.4.29
and do not include the
component packages, the latest version of each MongoDB package will be
installed regardless of what version you specified.
Pin a specific version of MongoDB Enterprise.
Although you can specify any available version of MongoDB,
apt-get
upgrades the packages when a newer version
becomes available. To prevent unintended upgrades, pin the
package. To pin the version of MongoDB at the currently
installed version, issue the following command sequence:
echo "mongodb-enterprise hold" | sudo dpkg --set-selections echo "mongodb-enterprise-server hold" | sudo dpkg --set-selections echo "mongodb-enterprise-shell hold" | sudo dpkg --set-selections echo "mongodb-enterprise-mongos hold" | sudo dpkg --set-selections echo "mongodb-enterprise-tools hold" | sudo dpkg --set-selections
Run MongoDB Enterprise Edition
By default, MongoDB instance stores:
its data files in
/var/lib/mongodb
its log files in
/var/log/mongodb
If you installed via the package manager, these default directories are created during the installation.
If you installed manually by downloading the tarballs, you can create
the directories using mkdir -p <directory>
or sudo mkdir -p
<directory>
depending on the user that will run MongoDB. (See your
linux man pages for information on mkdir
and sudo
.)
By default, MongoDB runs using the mongodb
user account. If you
change the user that runs the MongoDB process, you must also modify
the permission to the /var/lib/mongodb
and /var/log/mongodb
directories to give this user access to these directories.
To specify a different log file directory and data file directory, edit
the systemLog.path
and storage.dbPath
settings in
the /etc/mongod.conf
. Ensure that the user running MongoDB has
access to these directories.
Most Unix-like operating systems limit the system resources that a
process may use. These limits may negatively impact MongoDB operation,
and should be adjusted. See UNIX ulimit
Settings for the recommended
settings for your platform.
Note
Starting in MongoDB 4.4, a startup error is generated if the
ulimit
value for number of open files is under 64000
.
Procedure
Follow these steps to run MongoDB Enterprise Edition on your system.
These instructions assume that you are using the official mongodb-enterprise
package -- not the unofficial mongodb
package provided by
Debian -- and are using the default settings.
Init System
To run and manage your mongod
process, you will be using
your operating system's built-in init system. Recent versions of
Linux tend to use systemd (which uses the systemctl
command),
while older versions of Linux tend to use System V init (which uses
the service
command).
If you are unsure which init system your platform uses, run the following command:
ps --no-headers -o comm 1
Then select the appropriate tab below based on the result:
systemd
- select the systemd (systemctl) tab below.init
- select the System V Init (service) tab below.
Start MongoDB.
You can start the mongod
process by issuing the
following command:
sudo systemctl start mongod
If you receive an error similar to the following when starting
mongod
:
Failed to start mongod.service: Unit mongod.service not found.
Run the following command first:
sudo systemctl daemon-reload
Then run the start command above again.
Stop MongoDB.
As needed, you can stop the mongod
process by issuing the
following command:
sudo systemctl stop mongod
Restart MongoDB.
You can restart the mongod
process by issuing the following
command:
sudo systemctl restart mongod
You can follow the state of the process for errors or important messages
by watching the output in the /var/log/mongodb/mongod.log
file.
Begin using MongoDB.
Start a mongo
shell on the same host machine as the
mongod
. You can run the mongo
shell
without any command-line options to connect to a
mongod
that is running on your localhost with default
port 27017:
mongo
For more information on connecting using the mongo
shell, such as to connect to a mongod
instance running
on a different host and/or port, see The mongo
Shell.
To help you start using MongoDB, MongoDB provides Getting Started Guides in various driver editions. For the driver documentation, see Start Developing with MongoDB.
Start MongoDB.
Issue the following command to start mongod
:
sudo service mongod start
Verify that MongoDB has started successfully
Verify that the mongod
process has started
successfully:
sudo service mongod status
You can also check the log file for the current status of the
mongod
process, located at:
/var/log/mongodb/mongod.log
by default. A running
mongod
instance will indicate that it is ready for
connections with the following line:
[initandlisten] waiting for connections on port 27017
Stop MongoDB.
As needed, you can stop the mongod
process by issuing the
following command:
sudo service mongod stop
Restart MongoDB.
Issue the following command to restart mongod
:
sudo service mongod restart
Begin using MongoDB.
Start a mongo
shell on the same host machine as the
mongod
. You can run the mongo
shell
without any command-line options to connect to a
mongod
that is running on your localhost with default
port 27017:
mongo
For more information on connecting using the mongo
shell, such as to connect to a mongod
instance running
on a different host and/or port, see The mongo
Shell.
To help you start using MongoDB, MongoDB provides Getting Started Guides in various driver editions. For the driver documentation, see Start Developing with MongoDB.
Uninstall MongoDB
To completely remove MongoDB from a system, you must remove the MongoDB applications themselves, the configuration files, and any directories containing data and logs. The following section guides you through the necessary steps.
Warning
This process will completely remove MongoDB, its configuration, and all databases. This process is not reversible, so ensure that all of your configuration and data is backed up before proceeding.
Stop MongoDB.
Stop the mongod
process by issuing the following command:
sudo service mongod stop
Additional Information
Localhost Binding by Default
By default, MongoDB launches with bindIp
set to
127.0.0.1
, which binds to the localhost network interface. This
means that the mongod
can only accept connections from
clients that are running on the same machine. Remote clients will not be
able to connect to the mongod
, and the mongod
will
not be able to initialize a replica set unless this value is set
to a valid network interface which is accessible from the remote clients.
This value can be configured either:
Warning
Before binding to a non-localhost (e.g. publicly accessible) IP address, ensure you have secured your cluster from unauthorized access. For a complete list of security recommendations, see Security Checklist. At minimum, consider enabling authentication and hardening network infrastructure.
For more information on configuring bindIp
, see
IP Binding.
MongoDB Enterprise Edition Packages
MongoDB Enterprise Edition is available from its own dedicated repository, and contains the following officially-supported packages:
Package Name | Description | ||||||
---|---|---|---|---|---|---|---|
mongodb-enterprise | A metapackage that automatically installs the component
packages listed below. | ||||||
mongodb-enterprise-server | Contains the mongod daemon and associated
configuration and init scripts. | ||||||
mongodb-enterprise-mongos | Contains the mongos daemon. | ||||||
mongodb-enterprise-shell | Contains the mongo shell. | ||||||
mongodb-enterprise-cryptd | Contains the mongocryptd
binary | ||||||
mongodb-enterprise-tools | A
|