diff --git a/conf.py b/conf.py index c3fc2486c74..e210819adcd 100644 --- a/conf.py +++ b/conf.py @@ -76,7 +76,7 @@ def has(self, *args): ]) source_constants = { - 'version-dev': '5.3', # Current development branch + 'version-dev': '6.1', # Current development branch 'package-name-org': 'mongodb-org', 'package-name-enterprise': 'mongodb-enterprise', 'version': version, diff --git a/snooty.toml b/snooty.toml index 849026c9915..f68b252ab3a 100644 --- a/snooty.toml +++ b/snooty.toml @@ -97,7 +97,6 @@ toc_landing_pages = [ "/crud", "/geospatial-queries", "/indexes", - "/installation", "/introduction", "/mongo", "/reference/aggregation", @@ -225,10 +224,9 @@ windows-dir-version = "6.0" # wizard package-name-org = "mongodb-org" package-name-enterprise = "mongodb-enterprise" package-name = "mongodb" -version = "6.0" +version = "6.1" latest-lts-version = "6.0" release = "6.0.0" -version-dev = "6.1" pgp-version = "{+version+}" rsa-key = "4B7C549A058F8B6B" pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B" diff --git a/source/about.txt b/source/about.txt index 9de02ad7b1e..71928dacea5 100644 --- a/source/about.txt +++ b/source/about.txt @@ -36,7 +36,7 @@ which are also distributed with the official MongoDB Packages. Version and Revisions --------------------- -This version of the manual reflects version {+latest-lts-version+} +This version of the manual reflects version {+version+} of MongoDB. See the `MongoDB Documentation Project Page `_ @@ -96,4 +96,3 @@ For more information on the MongoDB documentation process, see the If you have any questions, please feel free to open a :issue:`Jira Case `. - diff --git a/source/administration/install-community.txt b/source/administration/install-community.txt index 043afb224d7..4c4589ad185 100644 --- a/source/administration/install-community.txt +++ b/source/administration/install-community.txt @@ -10,6 +10,8 @@ Install MongoDB Community Edition :depth: 1 :class: singlecol +.. include:: /includes/rapid-release.rst + These documents provide instructions to install MongoDB Community Edition. .. _`MongoDB Download Center`: https://www.mongodb.com/try/download/community?tck=docs_server diff --git a/source/administration/install-on-linux.txt b/source/administration/install-on-linux.txt index 6f8ced82008..3d71e9f6536 100644 --- a/source/administration/install-on-linux.txt +++ b/source/administration/install-on-linux.txt @@ -4,6 +4,8 @@ Install MongoDB Community Edition on Linux .. default-domain:: mongodb +.. include:: /includes/rapid-release.rst + These documents provide instructions to install MongoDB Community Edition for supported Linux systems. diff --git a/source/administration/production-notes.txt b/source/administration/production-notes.txt index 863c0841052..41cec72fc85 100644 --- a/source/administration/production-notes.txt +++ b/source/administration/production-notes.txt @@ -857,11 +857,6 @@ consider the following recommendations: default MongoDB directory paths or :doc:`ports `. - See: :ref:`Configure SELinux for - MongoDB ` and :ref:`Configure SELinux - for MongoDB Enterprise ` - for the required configuration. - .. include:: /includes/fact-selinux-server-side-js.rst .. _readahead: diff --git a/source/administration/upgrade-community-to-enterprise.txt b/source/administration/upgrade-community-to-enterprise.txt index b3790a48384..7e552faed64 100644 --- a/source/administration/upgrade-community-to-enterprise.txt +++ b/source/administration/upgrade-community-to-enterprise.txt @@ -10,6 +10,8 @@ Upgrade MongoDB Community to MongoDB Enterprise :depth: 1 :class: singlecol +.. include:: /includes/rapid-release.rst + .. include:: /includes/extracts/enterprise-additional-features.rst The documents in this section provide instructions to upgrade from diff --git a/source/contents.txt b/source/contents.txt index b1a07168546..dc5bf9b6a7f 100644 --- a/source/contents.txt +++ b/source/contents.txt @@ -32,8 +32,7 @@ project, this Manual and additional editions of this text. :hidden: Introduction - Installation - MongoDB Shell (mongosh) + MongoDB Shell (mongosh) /crud /aggregation /data-modeling diff --git a/source/includes/fact-mongodb-intro.rst b/source/includes/fact-mongodb-intro.rst index aae4b95731a..4936c4a1a27 100644 --- a/source/includes/fact-mongodb-intro.rst +++ b/source/includes/fact-mongodb-intro.rst @@ -1,4 +1,4 @@ -Welcome to the MongoDB {+version-dev+} Manual! MongoDB is a +Welcome to the MongoDB {+version+} Manual! MongoDB is a document database designed for ease of development and scaling. diff --git a/source/includes/fact-rapid-release-install.rst b/source/includes/fact-rapid-release-install.rst index 40269da6597..270e6e1398f 100644 --- a/source/includes/fact-rapid-release-install.rst +++ b/source/includes/fact-rapid-release-install.rst @@ -1,3 +1,4 @@ -To install the latest MongoDB version supported for -on-premises use, MongoDB {+latest-lts-version+}, see the -:manual:`MongoDB 5.0 installation instructions `. +To install the latest MongoDB version supported for on-premises use, +MongoDB {+latest-lts-version+}, see the +:v6.0:`MongoDB {+latest-lts-version+} installation instructions +`. diff --git a/source/includes/in-dev.rst b/source/includes/in-dev.rst index 4065f8b59a3..a12ef20ce2d 100644 --- a/source/includes/in-dev.rst +++ b/source/includes/in-dev.rst @@ -1,6 +1,6 @@ -.. warning:: MongoDB {+version-dev+} Not Yet Available +.. warning:: MongoDB {+version+} Not Yet Available - MongoDB {+version-dev+} release candidates are not yet available. + MongoDB {+version+} release candidates are not yet available. This version of the manual is for an upcoming release and is currently a work in progress. diff --git a/source/includes/rapid-release.rst b/source/includes/rapid-release.rst index f3f2e281570..f4cf1f5bf2d 100644 --- a/source/includes/rapid-release.rst +++ b/source/includes/rapid-release.rst @@ -1,7 +1,7 @@ .. important:: - MongoDB |version| is a rapid release and is only supported for - MongoDB Atlas. MongoDB |version| is not supported for use + MongoDB {+version+} is a rapid release and is only supported for + MongoDB Atlas. MongoDB {+version+} is not supported for use on-premises. For more information, see :ref:`release-version-numbers`. diff --git a/source/includes/rc-available.rst b/source/includes/rc-available.rst index 72b10dad208..f06fca5c04b 100644 --- a/source/includes/rc-available.rst +++ b/source/includes/rc-available.rst @@ -1,6 +1,6 @@ -.. important:: MongoDB {+version-dev+} Release Candidates +.. important:: MongoDB {+version+} Release Candidates - MongoDB {+version-dev+} binaries are currently available only as + MongoDB {+version+} binaries are currently available only as **release candidates**. Release candidates can be used for early testing of new features, but are not suitable for production deployments. diff --git a/source/index.txt b/source/index.txt index dc98a08c5ee..f13ac1e2823 100644 --- a/source/index.txt +++ b/source/index.txt @@ -11,20 +11,14 @@ What is MongoDB? MongoDB is a document database designed for ease of application development and scaling. - Run MongoDB with + Run MongoDB with `MongoDB Atlas + `__ fully managed in + the cloud. - - `MongoDB Atlas - `__ fully managed in - the cloud, - - the source available and free-to-use :doc:`MongoDB - Community `, or - - the :doc:`MongoDB Enterprise Advanced - ` subscription. + .. button:: Get started with MongoDB Atlas + :uri: https://www.mongodb.com/cloud?tck=docs_server - .. button:: Install MongoDB - :uri: /installation - - `Get started with MongoDB Atlas `__ + .. include:: /includes/rapid-release.rst .. image:: /images/hero.png :alt: Homepage hero image @@ -215,8 +209,7 @@ Explore libraries and tools for MongoDB. :titlesonly: Introduction - Installation - MongoDB Shell (mongosh) + MongoDB Shell (mongosh) /crud /aggregation /data-modeling diff --git a/source/installation.txt b/source/installation.txt index 06a8289752a..4ba409756c8 100644 --- a/source/installation.txt +++ b/source/installation.txt @@ -1,6 +1,13 @@ .. _tutorials-installation: .. _tutorial-installation: +.. This page is hidden from the TOC and search indexing. + +:orphan: + +.. meta:: + :robots: noindex, nosnippet + =============== Install MongoDB =============== @@ -13,114 +20,12 @@ Install MongoDB :depth: 1 :class: singlecol - - - - - .. include:: /includes/unicode-checkmark.rst .. include:: /includes/unicode-checkmark.rst -MongoDB is available in two server editions: *Community* and -*Enterprise*. - -.. _`MongoDB Download Center`: https://www.mongodb.com/try/download/community?tck=docs_server - -.. include:: /includes/fact-atlas-banner.rst - -This section of the manual contains information on installing -MongoDB. - -- For instructions on upgrading your current deployment to MongoDB - {+version+}, see :ref:`{+version+}-upgrade` instead. - -- For instructions on upgrading to the latest patch release for your - current version, see :doc:`/tutorial/upgrade-revision` instead. - -MongoDB Installation Tutorials ------------------------------- - -MongoDB installation tutorials are available for the following -platforms, for both the Community Edition and the -:products:`Enterprise Edition -`: - -.. list-table:: - :header-rows: 1 - :widths: 10 45 45 - - * - Platform - - Community Edition - - Enterprise Edition - - * - Linux - - | :doc:`/tutorial/install-mongodb-on-red-hat` - | :doc:`/tutorial/install-mongodb-on-ubuntu` - | :doc:`/tutorial/install-mongodb-on-debian` - | :doc:`/tutorial/install-mongodb-on-suse` - | :doc:`/tutorial/install-mongodb-on-amazon` - - - | :doc:`/tutorial/install-mongodb-enterprise-on-red-hat` - | :doc:`/tutorial/install-mongodb-enterprise-on-ubuntu` - | :doc:`/tutorial/install-mongodb-enterprise-on-debian` - | :doc:`/tutorial/install-mongodb-enterprise-on-suse` - | :doc:`/tutorial/install-mongodb-enterprise-on-amazon` - - * - macOS - - :doc:`/tutorial/install-mongodb-on-os-x` - - :doc:`/tutorial/install-mongodb-enterprise-on-os-x` - - * - Windows - - :doc:`/tutorial/install-mongodb-on-windows` - - :doc:`/tutorial/install-mongodb-enterprise-on-windows` - - * - Docker - - - - :doc:`/tutorial/install-mongodb-enterprise-with-docker` - -.. include:: /includes/unicode-checkmark.rst - -Upgrade Community Edition to Enterprise Edition Tutorials ---------------------------------------------------------- - -.. important:: - - .. include:: /includes/extracts/enterprise-upgrade-edition-only.rst - -- :doc:`/tutorial/upgrade-to-enterprise-standalone` -- :doc:`/tutorial/upgrade-to-enterprise-replica-set` -- :doc:`/tutorial/upgrade-to-enterprise-sharded-cluster` - -.. _mongodb-supported-platforms: - -Supported Platforms -------------------- - -.. versionchanged:: 3.4 - - MongoDB no longer supports 32-bit x86 platforms. - -.. sharedinclude:: server/platform-support/platform-support.rst - -.. [#oracle-linux] - - MongoDB only supports Oracle Linux running the Red Hat Compatible - Kernel (RHCK). MongoDB does **not** support the Unbreakable - Enterprise Kernel (UEK). - -.. [#RockyAlmaLinux-support-install] - - MongoDB on-premises products released for RHEL version 8.0+ are - compatible with and supported on Rocky Linux version 8.0+ and - AlmaLinux version 8.0+, contingent upon those distributions meeting their - obligation to deliver full RHEL compatibility. - -.. [#SLES12-SP-info] - - MongoDB versions 5.0 and greater are tested against SLES 12 service - pack 5. Earlier versions of MongoDB are tested against SLES 12 - with no service pack. +.. include:: /includes/rapid-release.rst + .. toctree:: :hidden: diff --git a/source/introduction.txt b/source/introduction.txt index 670ca8df41d..eda8148e75c 100644 --- a/source/introduction.txt +++ b/source/introduction.txt @@ -10,6 +10,8 @@ Introduction to MongoDB :depth: 1 :class: singlecol +.. include:: /includes/rapid-release-short.rst + Document Database ----------------- diff --git a/source/reference/installation-ubuntu-community-troubleshooting.txt b/source/reference/installation-ubuntu-community-troubleshooting.txt index 06c41899e1a..f357c94a913 100644 --- a/source/reference/installation-ubuntu-community-troubleshooting.txt +++ b/source/reference/installation-ubuntu-community-troubleshooting.txt @@ -15,293 +15,4 @@ Troubleshooting .. |arrow| unicode:: U+27A4 .. |distro-name| replace:: Ubuntu -Errors when retrieving the public key -------------------------------------- - -During :guilabel:`Import the public key used by the package management system` -step of the :ref:`install-community-ubuntu-pkg` procedure, you may -encounter a ``"gpg: no valid OpenPGP data found."`` error. - -Ensure you are copying the command exactly as documented. The operation -should respond with ``OK``. - -To check that the MongoDB public GPG key exists on your system, -run the following command in the terminal: - -.. code-block:: text - - sudo apt-key list - -The output should include an entry that resembles the following: - -.. code-block:: text - :copyable: false - - /etc/apt/trusted.gpg - -------------------- - pub rsa4096 2018-04-18 [SC] [expires: 2023-04-17] - {+pgp-fingerprint-fmt+} - uid [ unknown] MongoDB {+pgp-version+} Release Signing Key - - -Errors when running ``sudo apt update`` ---------------------------------------- - -You may encounter one or more errors that resemble the following -when running ``sudo apt-get update`` as part of the -:ref:`install-community-ubuntu-pkg` procedure: - -.. code-block:: text - :copyable: false - - W: GPG error: https://repo.mongodb.org/apt/ubuntu /mongodb-org/{+version+} Release: \ - The following signatures couldn't be verified because the public key is not available: NO_PUBKEY 4B7C549A058F8B6B - E: The repository 'https://repo.mongodb.org/apt/ubuntu /mongodb-org/{+version+} Release' \ - is not signed. - N: Updating from such a repository can't be done securely, and is therefore disabled by default. - N: See apt-secure(8) manpage for repository creation and user configuration details. - -These errors indicate that the MongoDB Public GPG key was not -added in step -:guilabel:`Import the public key used by the package management system` -of the :ref:`install-community-ubuntu-pkg` procedure. - -Repeating the -:guilabel:`Import the public key used by the package management system` -step of the -:ref:`install-community-ubuntu-pkg` procedure typically resolves this -issue. Ensure you are copying the command and key exactly as documented. - -You can validate that the MongoDB public GPG key exists on your system -by running the following command in the terminal: - -.. code-block:: text - - sudo apt-key list - -The output should include an entry that resembles the following: - -.. code-block:: text - :copyable: false - - -------------------- - pub rsa4096 2018-04-18 [SC] [expires: 2023-04-17] - {+pgp-fingerprint-fmt+} - uid [ unknown] MongoDB {+pgp-version+} Release Signing Key - -Errors when running ``sudo apt install -y {+package-name-org+}`` ----------------------------------------------------------------- - -You may encounter an error that resembles the following when running -``sudo apt install -y {+package-name-org+}`` -in step :guilabel:`Create a list file for MongoDB` of the -:ref:`install-community-ubuntu-pkg` procedure: - -.. code-block:: text - :copyable: false - - Reading package lists... Done - Building dependency tree - Reading state information... Done - E: Unable to locate package {+package-name-org+} - -This error indicates that the -``/etc/apt/sources.list.d/mongodb-org-{+pgp-version+}.list`` -may be configured incorrectly or is missing. - -To review the contents of the ``mongodb-org-{+pgp-version+}.list`` file, -run the following command in the terminal or shell: - -.. code-block:: text - - cat /etc/apt/sources.list.d/mongodb-org-{+pgp-version+}.list - -If the file contents do not exactly match the documentation for -your Ubuntu version in the step linked above, remove the file and -repeat the :guilabel:`Create a list file for MongoDB` step. -If the file does not exist, create it as part of that step. - -Once you have validated that the ``mongodb-org-{+pgp-version+}.list`` -file exists and has the correct contents, run -``sudo apt update`` to update the ``apt`` repositories and -retry ``sudo apt install -y {+package-name-org+}``. - -Unable to install package due to ``dpkg-deb: error`` ----------------------------------------------------- - -You may encounter an error that resembles the following when -installing the ``mongodb-org`` package: - -.. code-block:: text - :copyable: false - - dpkg: error processing archive /var/cache/apt/archives/mongodb-org-server_{+version+}.0_amd64.deb (--unpack): - trying to overwrite '/usr/bin/mongod', which is also in package mongodb-server-core 1:3.6.3-0ubuntu1 - -This error indicates that the system already had the |distro-name| -``mongodb`` package installed prior to installing the official -MongoDB Inc. ``{+package-name-org+}`` packages. To confirm wheter the -host has the |distro-name| ``mongodb`` package installed, run the -following command in a terminal or shell: - -.. code-block:: text - - sudo apt list --installed | grep mongo - -If your output resembles the following, you **must** uninstall -the |distro-name| ``mongodb`` package before retrying the -:ref:`install-community-ubuntu-pkg` procedure: - -.. code-block:: text - :copyable: false - - mongodb/bionic,now 1:3.6.3-0ubuntu1 amd64 [installed] - mongodb-clients/bionic,now 1:3.6.3-0ubuntu1 amd64 [installed,automatic] - mongodb-server/bionic,bionic,now 1:3.6.3-0ubuntu1 all [installed,automatic] - mongodb-server-core/bionic,now 1:3.6.3-0ubuntu1 amd64 [installed,automatic] - -Run the following commands in a terminal or shell to fully remove the -|distro-name| ``mongodb`` package before retrying the installation -procedure: - -.. code-block:: text - - sudo apt remove mongodb - sudo apt purge mongodb - sudo apt autoremove - -.. note:: - - ``sudo apt purge mongodb`` removes any default configuration files - installed by the |distro-name| ``mongodb`` package. If you have - modified these configuration files *and* want to keep those - modifications, copy the files to another directory such as - ``/home/your-user-name``. - -If your output includes a mix of ``{+package-name-org+}`` and -``mongodb`` binaries, you may need to first ``apt remove``, ``apt -purge``, and ``apt autoremove`` the ``{+package-name-org+}`` package -before attempting to remove and purge the |distro-name| ``mongodb`` -package. After clearing all MongoDB-related packages, retry the -installation procedure. - -``mongod`` reports errors related to opening a socket ------------------------------------------------------ - -You may encounter the ``Socket is already in use`` or -``Failed to unlink socket file`` errors when starting a -:binary:`mongod `. These errors generally indicate -another process using the configured port for the -:binary:`mongod ` process, typically another -:binary:`mongod ` running on the system. - -The following example uses the ``ss`` utility to list all open -TCP (``-t``) or UDP (``-u``) sockets in the ``LISTEN`` (``-l``) state -and the process using each socket (``-p``) -without resolving any service names or hostnames (``-n``). - -.. code-block:: text - - sudo ss -tulpn - -The following partial output shows a ``mongod`` process -listening on the ``27017`` port. Attempting to run another ``mongod`` -process on that same port will result in socket errors. - -.. code-block:: text - :copyable: false - - Netid State Local Address:Port - udp UNCONN 127.0.0.53%lo:53 users:(("systemd-resolve",pid=663,fd=12)) - udp UNCONN 10.1.16.87%enp0s3:68 users:(("systemd-network",pid=652,fd=15)) - tcp LISTEN 127.0.0.53%lo:53 users:(("systemd-resolve",pid=663,fd=13)) - tcp LISTEN 0.0.0.0:22 users:(("sshd",pid=819,fd=3)) - tcp LISTEN 192.168.1.15:27017 users:(("mongod",pid=10027,fd=12)) - tcp LISTEN 127.0.0.1:27017 users:(("mongod",pid=10027,fd=11)) - tcp LISTEN ::]:22 users:(("sshd",pid=819,fd=4)) - - -If the system has a :binary:`mongod ` or other system -process running on your desired port, you must either shut the -existing process down *or* select a new port for the new -:binary:`mongod ` process. You can specify the -:setting:`net.port` :ref:`configuration file ` -option to change the port that the :binary:`mongod ` -listens on. - -``mongod`` reports errors related to the data directory -------------------------------------------------------- - -Users may encounter errors that resemble the following in the -:binary:`mongod ` -:ref:`process log `: - -.. code-block:: text - :copyable: false - - Data directory ... not found - - Attempted to create lock file on a read-only directory: ... - -Generally, these errors indicate that the MongoDB data directory -either doesn't exist, or isn't accessible to the -:binary:`mongod `. - -The data directory must exist -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The data directory is specified with the :setting:`storage.dbPath` -setting in the :ref:`configuration file `, or -with the :option:`--dbpath ` option to -:binary:`mongod ` on the command line. - -- If you installed MongoDB via the ``apt`` package manager, the default - ``/etc/mongod.conf`` :ref:`configuration file ` - sets :setting:`storage.dbPath` to ``/var/lib/mongodb``. - -- If you are running :binary:`mongod ` on the command - line, and omitting the :option:`--dbpath ` option - entirely, MongoDB uses a default ``--dbpath`` of ``/data/db``. - -Whether you are using one of the data directory paths above, or -providing your own path in the configuration file or on the command -line, make sure that the data directory exists on your filesystem -prior to starting the :binary:`mongod `. You can create -directories on Ubuntu with the ``mkdir`` command. - -The data directory must be accessible -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The data directory must be configured with the appropriate -permissions and ownership settings to allow the -:binary:`mongod ` to read, write, and -navigate the directory contents (``rwx`` user or group permissions). - -Use ``chown``, and ``chmod`` to modify permissions and set -``user:group`` ownership as appropriate prior to starting the -:binary:`mongod `. - -Starting ``mongod`` using the data directory -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Users starting the ``mongod`` as a service (e.g. using either ``sudo -systemctl start mongod`` or ``sudo service mongod start``) typically -only see these errors if they modified the default -:setting:`~storage.dbPath` value in the ``/etc/mongod.conf`` to: - -* A directory that does not allow the ``mongodb`` user or ``mongodb`` - group to read, write, or execute (``rwx``) the directory and its - contents, *or* - -* A directory that does not exist. - -Users starting the :binary:`mongod ` without using the -service definition (e.g. using the terminal to launch ``mongod``) -typically see these errors if: - -* The directory specified to :setting:`~storage.dbPath` or - :option:`--dbpath ` does not allow the user or a - group to which the user belongs to read, write, and execute - (``rwx``) the directory or its contents, *or* - -* The specified data directory does not exist. +.. include:: /includes/rapid-release.rst diff --git a/source/reference/ulimit.txt b/source/reference/ulimit.txt index 68c20233b1b..14f161b2bcd 100644 --- a/source/reference/ulimit.txt +++ b/source/reference/ulimit.txt @@ -175,10 +175,9 @@ macOS ````` For macOS systems that have installed MongoDB Community using the -:ref:`brew installation method`, the +brew installation method, the recommended open files value is automatically set when you start -MongoDB through ``brew services``. See -:ref:`Run MongoDB with brew` for more information. +MongoDB through ``brew services``. For macOS systems running MongoDb Enterprise or using the TGZ installation method, use the ``launchctl limit`` command to set the diff --git a/source/release-notes/2.2.txt b/source/release-notes/2.2.txt index bf8ff6a5f5e..03e408a7271 100644 --- a/source/release-notes/2.2.txt +++ b/source/release-notes/2.2.txt @@ -422,9 +422,7 @@ Service Support for ``mongos.exe`` `````````````````````````````````` You may now run :binary:`~bin.mongos.exe` instances as a Windows -Service. See the :binary:`~bin.mongos.exe` reference and -:ref:`manually-create-windows-service` and :issue:`SERVER-1589` for -more information. +Service. Log Rotate Command Support `````````````````````````` diff --git a/source/release-notes/4.2.txt b/source/release-notes/4.2.txt index ad226f4a7b8..9e83c119016 100644 --- a/source/release-notes/4.2.txt +++ b/source/release-notes/4.2.txt @@ -1378,8 +1378,6 @@ Platform Support - Ubuntu 16.04 POWER/PPC64LE (Also removed in version 3.6.13 and 3.4.21) - macOS 10.11 - -See :ref:`mongodb-supported-platforms`. MongoDB Tools ------------- diff --git a/source/release-notes/5.1.txt b/source/release-notes/5.1.txt index 4722d6425a4..2625a1e62fd 100644 --- a/source/release-notes/5.1.txt +++ b/source/release-notes/5.1.txt @@ -274,8 +274,8 @@ SELinux Starting in MongoDB 5.1, there is a new SE Linux Policy for: -- :ref:`MongoDB Enterprise Server ` -- :ref:`MongoDB Community Edition Server ` +- MongoDB Enterprise Server +- MongoDB Community Edition Server running on Red Hat Linux. The SELinux policy is for use with default installations using ``rpm`` installer packages. diff --git a/source/release-notes/5.3.txt b/source/release-notes/5.3.txt index c8be1393482..46ed5d3fafc 100644 --- a/source/release-notes/5.3.txt +++ b/source/release-notes/5.3.txt @@ -16,6 +16,10 @@ Release Notes for MongoDB 5.3 .. include:: /includes/rapid-release-short.rst +.. note:: + + MongoDB 5.3 Released April 6, 2022 + Patch Releases -------------- diff --git a/source/release-notes/6.0-compatibility.txt b/source/release-notes/6.0-compatibility.txt index e781c7ce4a4..bf13abe4592 100644 --- a/source/release-notes/6.0-compatibility.txt +++ b/source/release-notes/6.0-compatibility.txt @@ -463,13 +463,6 @@ SELinux Policy Data .. include:: /includes/downgrade-for-SELinux-policy.rst -See: - -- :ref:`Configure SELinux Policy Data Directory - ` -- :ref:`Configure Enterprise SELinux Policy Data Directory - ` - Key Management Interoperability Protocol (KMIP) Settings ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/release-notes/6.0.txt b/source/release-notes/6.0.txt index ac8b45c0ce9..fbe9bf358fd 100644 --- a/source/release-notes/6.0.txt +++ b/source/release-notes/6.0.txt @@ -233,8 +233,8 @@ SELinux Policies Starting in MongoDB 5.1, there is a new SE Linux Policy for: -- :ref:`MongoDB Enterprise Server ` -- :ref:`MongoDB Community Edition Server ` +- MongoDB Enterprise Server +- MongoDB Community Edition Server running on Red Hat Linux. The SELinux policy is for use with default installations using ``rpm`` installer packages. diff --git a/source/tutorial/install-mongodb-enterprise-on-amazon-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-amazon-tarball.txt index 1f2bf9cab30..8aa60e9d228 100644 --- a/source/tutorial/install-mongodb-enterprise-on-amazon-tarball.txt +++ b/source/tutorial/install-mongodb-enterprise-on-amazon-tarball.txt @@ -18,108 +18,4 @@ Install MongoDB Enterprise on Amazon Linux using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on Amazon Linux using a downloaded ``.tgz`` tarball. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -Verify Linux Distribution -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-check-amazon-linux-enterprise.rst - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the yum Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-amazon.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-amazon-from-tarball: - -Install MongoDB Enterprise Edition ----------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. tabs:: - - .. tab:: Amazon Linux 2 - :tabid: amazon-linux-2 - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-redhat-7.rst - - .. tab:: Amazon Linux 2013.03+ - :tabid: amazon-linux-2013.03 - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-redhat-6.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-enterprise-on-linux.rst - -Run MongoDB Enterprise Edition ------------------------------- - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -Directories - .. include:: /includes/fact-installation-directories.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-enterprise-on-amazon.txt b/source/tutorial/install-mongodb-enterprise-on-amazon.txt index 4f38a65b1e1..9557b417650 100644 --- a/source/tutorial/install-mongodb-enterprise-on-amazon.txt +++ b/source/tutorial/install-mongodb-enterprise-on-amazon.txt @@ -17,117 +17,7 @@ Install MongoDB Enterprise Edition on Amazon Linux .. |package-manager| replace:: ``yum`` .. |executable-name| replace:: ``mongod`` -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition -on Amazon Linux using the |package-manager| package manager. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -Verify Linux Distribution -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-check-amazon-linux-enterprise.rst - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-amazon.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Enterprise Edition ----------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. Select the tab for your version of -Amazon Linux: - -.. tabs:: - - .. tab:: Amazon Linux 2 - :tabid: amazon-linux-2 - - .. include:: /includes/steps/install-mongodb-enterprise-on-amazon2.rst - - .. tab:: Amazon Linux (2013.03+) - :tabid: amazon-linux - - .. include:: /includes/steps/install-mongodb-enterprise-on-amazon.rst - -.. note:: - - .. include:: /includes/install-mongodb-yum-commands.rst - -Run MongoDB Enterprise Edition ------------------------------- - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -Directories - .. include:: /includes/fact-installation-directories.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution.rst - -Uninstall MongoDB ------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-enterprise-on-amazon.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -MongoDB Enterprise Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-enterprise-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :titlesonly: diff --git a/source/tutorial/install-mongodb-enterprise-on-debian-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-debian-tarball.txt index f685cc73efd..7c13a71baef 100644 --- a/source/tutorial/install-mongodb-enterprise-on-debian-tarball.txt +++ b/source/tutorial/install-mongodb-enterprise-on-debian-tarball.txt @@ -18,104 +18,4 @@ Install MongoDB Enterprise on Debian using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on Debian Linux using a downloaded ``.tgz`` tarball. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the apt Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-debian.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-debian-from-tarball: -.. _install-enterprise-debian-from-tarball: - -Install MongoDB Enterprise Edition ----------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. tabs:: - - .. tab:: Debian 10 (Buster) - :tabid: debian-10-buster - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-debian-10.rst - - .. tab:: Debian 9 (Stretch) - :tabid: debian-9-stretch - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-debian-9.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-enterprise-on-linux.rst - -.. include:: /includes/install-mongodb-shell-tarball.rst - -Run MongoDB Enterprise Edition ------------------------------- - -.. |mongod-user| replace:: ``mongodb`` -.. |mongod-datadir| replace:: ``/var/lib/mongodb`` - -.. include:: /includes/fact-installation-directories.rst - -.. include:: /includes/fact-installation-ulimit.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-enterprise-on-debian.txt b/source/tutorial/install-mongodb-enterprise-on-debian.txt index bcda2f4919d..0b9ef9e4117 100644 --- a/source/tutorial/install-mongodb-enterprise-on-debian.txt +++ b/source/tutorial/install-mongodb-enterprise-on-debian.txt @@ -17,114 +17,7 @@ Install MongoDB Enterprise Edition on Debian .. |package-manager| replace:: ``apt`` .. |executable-name| replace:: ``mongod`` -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition -using the |package-manager| package manager. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-debian.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Official MongoDB Packages -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/important-dont-use-distro-packages.rst - -See :ref:`debian-enterprise-package-content` for the complete list of -official packages. - -.. _install-enterprise-debian-pkg: - -Install MongoDB Enterprise Edition ----------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. - -.. include:: /includes/steps/install-mongodb-enterprise-on-debian.rst - -.. note:: - - .. include:: /includes/install-mongodb-apt-get-commands.rst - -Run MongoDB Enterprise Edition ------------------------------- - -.. |mongod-user| replace:: ``mongodb`` -.. |mongod-datadir| replace:: ``/var/lib/mongodb`` - -.. include:: /includes/fact-installation-directories.rst - -.. include:: /includes/fact-installation-ulimit.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition on your system. -These instructions assume that you are using the official |package-name| -package -- not the unofficial ``mongodb`` package provided by -|distro-name| -- and are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-debian-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-debian.rst - -Uninstall MongoDB ------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-enterprise-on-debian.rst - - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -.. _debian-enterprise-package-content: - -MongoDB Enterprise Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-enterprise-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-enterprise-on-os-x.txt b/source/tutorial/install-mongodb-enterprise-on-os-x.txt index 029a9745d02..6fb95b9bf07 100644 --- a/source/tutorial/install-mongodb-enterprise-on-os-x.txt +++ b/source/tutorial/install-mongodb-enterprise-on-os-x.txt @@ -19,67 +19,4 @@ Install MongoDB Enterprise on macOS .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on macOS using a downloaded ``.tgz`` tarball. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-macos.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Enterprise Edition ----------------------------------- - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-enterprise-on-os-x.rst - -Run MongoDB Enterprise Edition ------------------------------- - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-osx.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-enterprise-on-red-hat-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-red-hat-tarball.txt index abec69230dd..998a283e6f8 100644 --- a/source/tutorial/install-mongodb-enterprise-on-red-hat-tarball.txt +++ b/source/tutorial/install-mongodb-enterprise-on-red-hat-tarball.txt @@ -18,178 +18,4 @@ Install MongoDB Enterprise on Red Hat or CentOS using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on Red Hat Enterprise Linux, CentOS Linux, or Oracle Linux -[#oracle-linux]_ using a downloaded ``.tgz`` tarball. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the yum Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-red-hat.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-redhat-from-tarball: - -Install MongoDB Enterprise Edition ----------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. tabs:: - - .. tab:: RHEL / CentOS 8 - :tabid: rhel-centos-8 - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-redhat-8.rst - - .. tab:: RHEL / CentOS 7 - :tabid: rhel-centos-7 - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-redhat-7.rst - - .. tab:: RHEL / CentOS 6 - :tabid: rhel-centos-6 - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-redhat-6.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-enterprise-on-linux.rst - -Run MongoDB Enterprise Edition ------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -ulimit -`````` - -.. include:: /includes/fact-installation-ulimit.rst - -Directory Paths -``````````````` - -To Use Default Directories -++++++++++++++++++++++++++ - -By default, MongoDB runs using the |mongod-user| user account and -uses the following default directories: - -- |mongod-datadir| (the data directory) - -- ``/var/log/mongodb`` (the log directory) - -Create the MongoDB data and log directories: - -.. code-block:: bash - - sudo mkdir -p /var/lib/mongo - sudo mkdir -p /var/log/mongodb - -By default, MongoDB runs using the |mongod-user| user account. Create -a |mongod-user| and a ``mongodb`` group. Ensure that the |mongod-user| -belongs to the group then set the owner and group of these directories -to |mongod-user|: - -.. code-block:: bash - - sudo chown -R mongod:mongod /var/lib/mongo - sudo chown -R mongod:mongod /var/log/mongodb - -To Use Non-Default Directories -++++++++++++++++++++++++++++++ - -To use a data directory and/or log directory other than the default -directories: - -#. Create the new directory or directories. - -#. Edit the configuration file ``/etc/mongod.conf`` and modify the - following fields accordingly: - - - :setting:`storage.dbPath` to specify a new data directory path (e.g. ``/some/data/directory``) - - - :setting:`systemLog.path` to specify a new log file path (e.g. ``/some/log/directory/mongod.log``) - -#. Ensure that the user running MongoDB has access to the directory or - directories: - - .. code-block:: bash - - sudo chown -R mongod:mongod - - If you change the user that runs the MongoDB process, you **must** - give the new user access to these directories. - -#. Configure SELinux if enforced. See :ref:`install-rhel-configure-selinux`. - -.. _install-enterprise-tarball-selinux-data-directory: - -.. _install-enterprise-tarball-rhel-configure-selinux: - -Configure SELinux -````````````````` - -.. include:: /includes/fact-selinux-redhat-options.rst -.. include:: /includes/important-selinux-customizations.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition on your system. -These instructions assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-enterprise-on-red-hat.txt b/source/tutorial/install-mongodb-enterprise-on-red-hat.txt index d579ea421aa..3a684a65f79 100644 --- a/source/tutorial/install-mongodb-enterprise-on-red-hat.txt +++ b/source/tutorial/install-mongodb-enterprise-on-red-hat.txt @@ -17,160 +17,7 @@ Install MongoDB Enterprise Edition on Red Hat or CentOS .. |package-manager| replace:: ``yum`` .. |executable-name| replace:: ``mongod`` -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition on -Red Hat Enterprise Linux, CentOS Linux, or Oracle Linux [#oracle-linux]_ -using the |package-manager| package manager. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-red-hat.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-enterprise-redhat-pkg: - -Install MongoDB Enterprise Edition ----------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. - -.. include:: /includes/steps/install-mongodb-enterprise-on-red-hat.rst - -.. note:: - - .. include:: /includes/install-mongodb-yum-commands.rst - -Run MongoDB Enterprise Edition ------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -ulimit -`````` - -.. include:: /includes/fact-installation-ulimit.rst - -Directory Paths -``````````````` - -To Use Default Directories -++++++++++++++++++++++++++ - -By default, MongoDB runs using the |mongod-user| user account and -uses the following default directories: - -- |mongod-datadir| (the data directory) - -- ``/var/log/mongodb`` (the log directory) - -The package manager creates the default directories during -installation. The owner and group name are |mongod-user|. - -To Use Non-Default Directories -++++++++++++++++++++++++++++++ - -To use a data directory and/or log directory other than the default -directories: - -#. Create the new directory or directories. - -#. Edit the configuration file ``/etc/mongod.conf`` and modify the - following fields accordingly: - - - :setting:`storage.dbPath` to specify a new data directory path (e.g. ``/some/data/directory``) - - - :setting:`systemLog.path` to specify a new log file path (e.g. ``/some/log/directory/mongod.log``) - -#. Ensure that the user running MongoDB has access to the directory or - directories: - - .. code-block:: bash - - sudo chown -R mongod:mongod - - If you change the user that runs the MongoDB process, you **must** - give the new user access to these directories. - -#. Configure SELinux if enforced. See - :ref:`install-enterprise-rhel-configure-selinux`. - -.. _install-enterprise-selinux-data-directory: - -.. _install-enterprise-rhel-configure-selinux: - -Configure SELinux -````````````````` - -.. include:: /includes/fact-selinux-redhat-with-policy.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition on your system. -These instructions assume that you are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution.rst - -Uninstall MongoDB ------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-enterprise-on-redhat.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -MongoDB Enterprise Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-enterprise-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-enterprise-on-suse-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-suse-tarball.txt index 9fdec238157..355f5a5d772 100644 --- a/source/tutorial/install-mongodb-enterprise-on-suse-tarball.txt +++ b/source/tutorial/install-mongodb-enterprise-on-suse-tarball.txt @@ -18,102 +18,4 @@ Install MongoDB Enterprise on SUSE using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on SUSE Linux Enterprise Server (SLES) using a downloaded -``.tgz`` tarball. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the zypper Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-suse.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-enterprise-suse-from-tarball: - -Install MongoDB Enterprise Edition ----------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. tabs:: - - .. tab:: SUSE 15 - :tabid: suse-15 - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-suse-15.rst - - .. tab:: SUSE 12 - :tabid: suse-12 - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-suse-12.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-enterprise-on-linux.rst - -Run MongoDB Enterprise Edition ------------------------------- - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -.. include:: /includes/fact-installation-directories.rst - -.. include:: /includes/fact-installation-ulimit.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-enterprise-on-suse.txt b/source/tutorial/install-mongodb-enterprise-on-suse.txt index da039156146..91e03e9a8d3 100644 --- a/source/tutorial/install-mongodb-enterprise-on-suse.txt +++ b/source/tutorial/install-mongodb-enterprise-on-suse.txt @@ -17,98 +17,7 @@ Install MongoDB Enterprise Edition on SUSE .. |package-manager| replace:: ``zypper`` .. |executable-name| replace:: ``mongod`` -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition -on SUSE Linux Enterprise Server (SLES) using the |package-manager| package -manager. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-suse.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-enterprise-suse-pkg: - -Install MongoDB Enterprise Edition ----------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. - -.. include:: /includes/steps/install-mongodb-enterprise-on-suse.rst - -Run MongoDB Enterprise Edition ------------------------------- - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -.. include:: /includes/fact-installation-directories.rst - -.. include:: /includes/fact-installation-ulimit.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution.rst - -Uninstall MongoDB ------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-enterprise-on-suse.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -MongoDB Enterprise Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-enterprise-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-enterprise-on-ubuntu-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-ubuntu-tarball.txt index 44191a2c2e0..7a5c7d34144 100644 --- a/source/tutorial/install-mongodb-enterprise-on-ubuntu-tarball.txt +++ b/source/tutorial/install-mongodb-enterprise-on-ubuntu-tarball.txt @@ -20,112 +20,4 @@ Install MongoDB Enterprise on Ubuntu using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on LTS (long-term support) releases of Ubuntu Linux using a -downloaded ``.tgz`` tarball. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the apt Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-ubuntu.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-ubuntu-from-tarball: - -Install MongoDB Enterprise Edition ----------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. tabs:: - - .. tab:: Ubuntu 20.04 (Focal) - :tabid: ubuntu-20-focal - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-ubuntu-20.rst - - .. tab:: Ubuntu 18.04 (Bionic) - :tabid: ubuntu-18-bionic - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-ubuntu-18.rst - - .. tab:: Ubuntu 16.04 (Xenial) - :tabid: ubuntu-16-xenial - - .. include:: /includes/extracts/install-mongodb-enterprise-manually-ubuntu-16.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-on-ubuntu-tarball.rst - -Run MongoDB Enterprise Edition ------------------------------- - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongodb`` -.. |mongod-datadir| replace:: ``/var/lib/mongodb`` - -Configuration - You can configure the MongoDB instance (such as the - data directory and log directory specifications) using - either the command-line options or a :ref:`configuration file - `. - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-enterprise-on-ubuntu.txt b/source/tutorial/install-mongodb-enterprise-on-ubuntu.txt index a8cf93aa60f..2042b6b9f16 100644 --- a/source/tutorial/install-mongodb-enterprise-on-ubuntu.txt +++ b/source/tutorial/install-mongodb-enterprise-on-ubuntu.txt @@ -19,114 +19,7 @@ Install MongoDB Enterprise Edition on Ubuntu .. |package-manager| replace:: ``apt`` .. |executable-name| replace:: ``mongod`` -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition on -LTS (long-term support) releases of Ubuntu Linux using the -|package-manager| package manager. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-ubuntu.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Official MongoDB Packages -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/important-dont-use-distro-packages.rst - -See :ref:`ubuntu-enterprise-package-content` for the complete list of -official packages. - -.. _install-enterprise-ubuntu-pkg: - -Install MongoDB Enterprise Edition ----------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. - -.. include:: /includes/steps/install-mongodb-enterprise-on-ubuntu.rst - -.. note:: - - .. include:: /includes/install-mongodb-apt-get-commands.rst - -Run MongoDB Enterprise Edition ------------------------------- - -.. |mongod-user| replace:: ``mongodb`` -.. |mongod-datadir| replace:: ``/var/lib/mongodb`` - -.. include:: /includes/fact-installation-directories.rst - -.. include:: /includes/fact-installation-ulimit.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition on your system. -These instructions assume that you are using the official |package-name| -package -- not the unofficial ``mongodb`` package provided by -|distro-name| -- and are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-debian-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-debian.rst - -Uninstall MongoDB ------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-enterprise-on-debian.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -.. _ubuntu-enterprise-package-content: - -MongoDB Enterprise Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-enterprise-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-enterprise-on-windows-unattended.txt b/source/tutorial/install-mongodb-enterprise-on-windows-unattended.txt index eba04e243a1..3464d48fee9 100644 --- a/source/tutorial/install-mongodb-enterprise-on-windows-unattended.txt +++ b/source/tutorial/install-mongodb-enterprise-on-windows-unattended.txt @@ -16,161 +16,4 @@ Install MongoDB Enterprise on Windows using ``msiexec.exe`` .. |executable-name| replace:: ``mongod.exe`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition on -Windows in an unattended fashion using ``msiexec.exe`` from the command -line. This is useful for system administrators who wish to -deploy MongoDB using automation. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -This tutorial installs MongoDB on Windows using the command-line tool -``msiexec.exe``. To install MongoDB using the graphical MSI Installer -instead, see :doc:`Install MongoDB using the MSI Installer -`. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-win.rst - - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-windows.rst - -Virtualization -~~~~~~~~~~~~~~ - -.. include:: /includes/fact-virtualbox-not-supported.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Enterprise Edition ----------------------------------- - -Procedure -~~~~~~~~~ - -Follow these steps to install MongoDB |edition| Edition unattended on -Windows from the `Windows command prompt/interpreter -`__ (``cmd.exe``) using ``msiexec.exe``. - -.. include:: /includes/steps/install-mongodb-enterprise-on-windows-unattended.rst - -Start MongoDB Enterprise Edition as a Windows Service ------------------------------------------------------ - -Starting in version 4.0, you can install and configure MongoDB as a -:guilabel:`Windows Service` during the install, and the MongoDB service -starts upon successful installation. - -To start/restart the MongoDB service, use the Services console: - -#. From the Services console, locate the MongoDB service. - -#. Right-click on the MongoDB service and click :guilabel:`Start`. - -You can also manually manage the service from the command line. To -start the MongoDB service from the command line, open a `Windows -command prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. include:: /includes/steps/create-manually-windows-service-for-mongodb.rst - -Stop MongoDB Enterprise Edition as a Windows Service ----------------------------------------------------- - -To stop/pause the MongoDB service, use the Services console: - -#. From the Services console, locate the MongoDB service. - -#. Right-click on the MongoDB service and click :guilabel:`Stop` (or :guilabel:`Pause`). - -You can also manage the service from the command line. To stop the -MongoDB service from the command line, open a `Windows command -prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. code-block:: bat - - net stop MongoDB - -Remove MongoDB Enterprise Edition as a Windows Service ------------------------------------------------------- - -To remove the MongoDB service, first use the Services console to stop -the service. Then open a `Windows command prompt/interpreter -`__ -(``cmd.exe``) as an :guilabel:`Administrator`, and run the following -command: - -.. code-block:: bat - - sc.exe delete MongoDB - -Start MongoDB Enterprise Edition from the Command Interpreter -------------------------------------------------------------- - -Open a `Windows command prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`. - -.. important:: - - You must open the command interpreter as an - :guilabel:`Administrator`. - -.. include:: /includes/steps/run-mongodb-on-windows.rst - -Additional Considerations -------------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -Point Releases and ``.msi`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you installed MongoDB with the Windows installer (``.msi``), the -``.msi`` automatically upgrades within the :ref:`same release series -` (e.g. 4.2.1 to 4.2.2). - -Upgrading a full release series (e.g. 4.0 to 4.2) requires a new -installation. - -Add MongoDB binaries to the System PATH -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -All command-line examples in this tutorial are provided as absolute -paths to the MongoDB binaries. You can add ``C:\Program -Files\MongoDB\Server\{+version+}\bin`` to your System ``PATH`` and then -omit the full path to the MongoDB binaries. +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-enterprise-on-windows.txt b/source/tutorial/install-mongodb-enterprise-on-windows.txt index 12f2f088354..e168fdd3508 100644 --- a/source/tutorial/install-mongodb-enterprise-on-windows.txt +++ b/source/tutorial/install-mongodb-enterprise-on-windows.txt @@ -19,199 +19,7 @@ Install MongoDB Enterprise Edition on Windows .. |executable-name| replace:: ``mongod.exe`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition on -Windows using the default installation wizard. - -:products:`MongoDB Enterprise Edition` -is available on select platforms and contains support for several -features related to security and monitoring. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -This tutorial installs MongoDB on Windows using the default MSI -installation wizard. To install MongoDB using the ``msiexec.exe`` -command-line tool instead, see :doc:`Install MongoDB using msiexec.exe -`. The -``msiexec.exe`` tool is useful for system administrators who wish to -deploy MongoDB in an unattended fashion using automation. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-win.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-enterprise-windows.rst - -Virtualization -~~~~~~~~~~~~~~ - -.. include:: /includes/fact-virtualbox-not-supported.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Enterprise Edition ----------------------------------- - -Procedure -~~~~~~~~~ - -Follow these steps to install MongoDB |edition| Edition using the -Windows Installation wizard. The installation process installs both the -MongoDB binaries as well as the default :doc:`configuration file -` :file:`\\bin\\mongod.cfg`. - -.. include:: /includes/steps/install-mongodb-on-windows-enterprise-interactive.rst - -If You Installed MongoDB as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The MongoDB service starts upon successful installation. Configure the -MongoDB instance with the configuration file -:file:`\\bin\\mongod.cfg`. - -If you have not already done so, follow the -:mongosh:`mongosh installation instructions ` to download and -install the MongoDB Shell (:mongosh:`mongosh `). - -Be sure to add the path to your ``mongosh.exe`` binary to your -``PATH`` environment variable during installation. - -Open a new :guilabel:`Command Interpreter` and enter ``mongosh.exe`` -to connect to MongoDB. - -For more information on connecting to ``mongod`` using -:mongosh:`mongosh.exe `, such as connecting to a MongoDB instance -running on a different host and/or port, see -:mongosh:`Connect to a Deployment `. - -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` - -If You Did Not Install MongoDB as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you only installed the executables and did not install MongoDB as a -Windows service, you must manually start the MongoDB instance. - -See :ref:`run-mongodb-enterprise-from-cmd` for instructions to start a -MongoDB instance. - -.. _run-mongodb-enterprise-from-cmd: - -Start MongoDB Enterprise Edition from the Command Interpreter -------------------------------------------------------------- - -.. include:: /includes/steps/run-mongodb-on-windows.rst - -.. _manually-create-windows-service-enterprise: - -Start MongoDB Enterprise Edition as a Windows Service ------------------------------------------------------ - -Starting in version 4.0, you can install and configure MongoDB as a -:guilabel:`Windows Service` during the install, the MongoDB service -starts upon successful installation. - -To start/restart the MongoDB service, use the Services console: - -#. From the Services console, locate the MongoDB service. - -#. Right-click on the MongoDB service and click :guilabel:`Start`. - -You can also manually manage the service from the command line. To -start the MongoDB service from the command line, open a `Windows -command prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. include:: /includes/steps/create-manually-windows-service-for-mongodb.rst - - -Stop MongoDB Enterprise Edition as a Windows Service ----------------------------------------------------- - -To stop/pause the MongoDB service, use the Services console: - -#. From the Services console, locate the MongoDB service. - -#. Right-click on the MongoDB service and click :guilabel:`Stop` (or :guilabel:`Pause`). - -You can also manage the service from the command line. To stop the -MongoDB service from the command line, open a `Windows command -prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. code-block:: bat - - net stop MongoDB - -Remove MongoDB Enterprise Edition as a Windows Service ------------------------------------------------------- - -To remove the MongoDB service, first use the Services console to stop -the service. Then open a `Windows command prompt/interpreter -`__ -(``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. code-block:: bat - - sc.exe delete MongoDB - -Additional Considerations -------------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -Point Releases and ``.msi`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you installed MongoDB with the Windows installer (``.msi``), that -``.msi`` automatically upgrades within its :ref:`release series -` (e.g. 4.2.1 to 4.2.2). - -Upgrading a full release series (e.g. 4.0 to 4.2) requires a new -installation. - -Add MongoDB binaries to the System PATH -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -All command-line examples in this tutorial are provided with absolute -paths to the MongoDB binaries. You can add ``C:\Program -Files\MongoDB\Server\{+version+}\bin`` to your System ``PATH`` and then -omit the full path to the MongoDB binaries. +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-enterprise-with-docker.txt b/source/tutorial/install-mongodb-enterprise-with-docker.txt index aab6fa1785b..98e3ff67f7b 100644 --- a/source/tutorial/install-mongodb-enterprise-with-docker.txt +++ b/source/tutorial/install-mongodb-enterprise-with-docker.txt @@ -6,66 +6,4 @@ Install MongoDB Enterprise with Docker .. _`MongoDB Download Center`: https://www.mongodb.com/try/download/enterprise?tck=docs_server - -.. important:: - - The recommended solutions for using containers with MongoDB are: - - - For development and testing use the - `MongoDB Community Docker container `__. - This image is supported by MongoDB. The image contains the - Community Edition of MongoDB. - - - For MongoDB Enterprise production installations, use - :opsmgr:`MongoDB Ops Manager ` to - configure Docker containers and Kubernetes. - -To manually configure :products:`MongoDB Enterprise -` with Docker, follow the -instructions on this page. - -Considerations --------------- - -A full description of `Docker `__ is beyond -the scope of this documentation. This page assumes prior knowledge of -Docker. - -This documentation only describes installing MongoDB Enterprise with -Docker, and does not replace other resources on Docker. We encourage -you to thoroughly familiarize yourself with Docker and its related -subject matter before installing MongoDB Enterprise with Docker. - -.. important:: - - This procedure uses the official `mongo image - `__. The image is supported - by MongoDB. - - The MongoDB community may contribute additional container images. - For a listing of all available images, see the `repositiory - `__. - -.. _create-docker-image-enterprise: - -Create a Docker Image with MongoDB Enterprise ---------------------------------------------- - -Install `Docker `__ and set up a -`Docker Hub `__ account before creating a -MongoDB Enterprise Docker image. - -.. include:: /includes/steps/install-mongodb-enterprise-with-docker.rst - -Push the Image to Docker Hub ----------------------------- - -Optionally, you can push your Docker image to a remote repository, like Docker -Hub, to use the image on other host machines. If you push the image to Docker -Hub, you can then run ``docker pull`` for each host machine on -which you want to install MongoDB Enterprise via Docker. For complete guidance -on using ``docker pull``, reference its documentation -`here `__. - -.. include:: /includes/steps/push-mongodb-with-docker-to-hub.rst - +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-on-amazon-tarball.txt b/source/tutorial/install-mongodb-on-amazon-tarball.txt index fb1391024fd..f929ca606a4 100644 --- a/source/tutorial/install-mongodb-on-amazon-tarball.txt +++ b/source/tutorial/install-mongodb-on-amazon-tarball.txt @@ -20,92 +20,4 @@ Install MongoDB Community on Amazon Linux using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on Amazon Linux using a downloaded ``.tgz`` tarball. - -Verify Linux Distribution -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-check-amazon-linux-community.rst - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the yum Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-amazon.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Community Edition ---------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. include:: /includes/extracts/install-mongodb-community-manually-redhat.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-on-amazon-tarball.rst - -Run MongoDB Community Edition ------------------------------ - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -Directories - .. include:: /includes/fact-installation-directories.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-on-amazon.txt b/source/tutorial/install-mongodb-on-amazon.txt index a9533b148ed..2a59bd65a26 100644 --- a/source/tutorial/install-mongodb-on-amazon.txt +++ b/source/tutorial/install-mongodb-on-amazon.txt @@ -17,116 +17,7 @@ Install MongoDB Community Edition on Amazon Linux .. |package-manager| replace:: ``yum`` .. |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 -Amazon Linux using the |package-manager| package manager. - -Verify Linux Distribution -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-check-amazon-linux-community.rst - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-amazon.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-community-amazon-pkg: - -Install MongoDB Community Edition ---------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. Select the tab for your version of -Amazon Linux: - -.. tabs:: - - .. tab:: Amazon Linux 2 - :tabid: amazon-linux-2 - - .. include:: /includes/steps/install-mongodb-on-amazon2.rst - - .. tab:: Amazon Linux (2013.03+) - :tabid: amazon-linux - - .. include:: /includes/steps/install-mongodb-on-amazon.rst - -Run MongoDB Community Edition ------------------------------ - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -Directories - .. include:: /includes/fact-installation-directories.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution.rst - - -Uninstall MongoDB Community Edition ------------------------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-on-amazon.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -.. _amazon-package-content: - -MongoDB Community Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-org-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-on-debian-tarball.txt b/source/tutorial/install-mongodb-on-debian-tarball.txt index 2e07c16351c..4badb265ef9 100644 --- a/source/tutorial/install-mongodb-on-debian-tarball.txt +++ b/source/tutorial/install-mongodb-on-debian-tarball.txt @@ -18,99 +18,4 @@ Install MongoDB Community on Debian using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on Debian Linux using a downloaded ``.tgz`` tarball. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the apt Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-debian.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-community-debian-from-tarball: - -Install MongoDB Community Edition ---------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. tabs:: - - .. tab:: Debian 10 (Buster) - :tabid: debian-10-buster - - .. include:: /includes/extracts/install-mongodb-community-manually-debian-10.rst - - .. tab:: Debian 9 (Stretch) - :tabid: debian-9-stretch - - .. include:: /includes/extracts/install-mongodb-community-manually-debian-9.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-on-linux.rst - -Run MongoDB Community Edition ------------------------------ - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongodb`` -.. |mongod-datadir| replace:: ``/var/lib/mongodb`` - -Directories - .. include:: /includes/fact-installation-directories.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-on-debian.txt b/source/tutorial/install-mongodb-on-debian.txt index 0a9b087c616..06aab1b9789 100644 --- a/source/tutorial/install-mongodb-on-debian.txt +++ b/source/tutorial/install-mongodb-on-debian.txt @@ -17,109 +17,7 @@ Install MongoDB Community Edition on Debian .. |package-manager| replace:: ``apt`` .. |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 using -the |package-manager| package manager. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-debian.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Official MongoDB Packages -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/important-dont-use-distro-packages.rst - -See :ref:`debian-package-content` for the complete list of official -packages. - -.. _install-community-debian-pkg: - -Install MongoDB Community Edition ---------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. - -.. include:: /includes/steps/install-mongodb-on-debian.rst - -Run MongoDB Community Edition ------------------------------ - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongodb`` -.. |mongod-datadir| replace:: ``/var/lib/mongodb`` - -Directories - .. include:: /includes/fact-installation-directories.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition on your system. -These instructions assume that you are using the official |package-name| -package -- not the unofficial ``mongodb`` package provided by -|distro-name| -- and are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-debian-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-debian.rst - -Uninstall MongoDB Community Edition ------------------------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-on-debian.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -.. _debian-package-content: - -MongoDB Community Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-org-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-on-os-x-tarball.txt b/source/tutorial/install-mongodb-on-os-x-tarball.txt index 8163cbe05d9..b4d662dbfcb 100644 --- a/source/tutorial/install-mongodb-on-os-x-tarball.txt +++ b/source/tutorial/install-mongodb-on-os-x-tarball.txt @@ -17,73 +17,4 @@ Install MongoDB Community on macOS using ``.tgz`` Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on macOS using a downloaded ``.tgz`` tarball. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the brew Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-macos.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-with-tarball: - -Install MongoDB Community Edition ---------------------------------- - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-on-osx-manually.rst - -Run MongoDB Community Edition ------------------------------ - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-osx.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-on-os-x.txt b/source/tutorial/install-mongodb-on-os-x.txt index be8a68acf8e..2f91b1dc379 100644 --- a/source/tutorial/install-mongodb-on-os-x.txt +++ b/source/tutorial/install-mongodb-on-os-x.txt @@ -16,340 +16,7 @@ Install MongoDB Community Edition on 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 `__ -package manager. - -Starting with MongoDB 4.4.1, installing MongoDB via Homebrew also -installs the :dbtools:`MongoDB Database Tools `. See -:ref:`brew-installs-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 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:: bash - - xcode-select --install - -Install Homebrew -```````````````` - -macOS does not include the Homebrew ``brew`` package by default. - -- Install ``brew`` using the official - `Homebrew installation instructions `_. - -.. _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 ` above before proceeding. - -#. Tap the `MongoDB Homebrew Tap - `_ to download the official - Homebrew formula for MongoDB and the Database Tools, by running the - following command in your macOS Terminal: - - .. code-block:: bash - - 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:: bash - - brew install mongodb-community@{+version+} - -.. tip:: - - 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 MongoDB Shell, :binary:`~bin.mongosh` - -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 ` - - ``/usr/local/etc/mongod.conf`` - - ``/opt/homebrew/etc/mongod.conf`` - - * - :setting:`log directory ` - - ``/usr/local/var/log/mongodb`` - - ``/opt/homebrew/var/log/mongodb`` - - * - :setting:`data directory ` - - ``/usr/local/var/mongodb`` - - ``/opt/homebrew/var/mongodb`` - -See `Apple's documentation `__ -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:: bash - - brew --prefix - -Starting with MongoDB 4.4.1, the installation also includes the -:dbtools:`MongoDB Database Tools `. -See :ref:`brew-installs-dbtools` for more information. - -.. _run-with-homebrew: - -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 ` for more information). - -- To run MongoDB (i.e. the :binary:`~bin.mongod` process) **as a - macOS service**, run: - - .. code-block:: bash - - 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:: bash - - brew services stop mongodb-community@{+version+} - -- To run MongoDB (i.e. the :binary:`~bin.mongod` process) **manually - as a background process**, run: - - - For macOS running Intel processors: - - .. code-block:: bash - - mongod --config /usr/local/etc/mongod.conf --fork - - - For macOS running on `Apple M1 processors - `__: - - .. code-block:: bash - - 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` using :mongosh:`mongosh `, - 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 ` to -this file as well. - -.. note:: macOS Prevents ``mongod`` From Opening - - .. 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:: bash - - brew services list - - You should see the service ``mongodb-community`` listed as - ``started``. - -- If you started MongoDB **manually as a background process**: - - .. code-block:: bash - - 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 :binary:`~bin.mongosh` to the -running instance. From a new terminal, issue the following: - -.. code-block:: bash - - mongosh - -.. note:: macOS Prevents ``mongosh`` From Opening - - .. 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-installs-dbtools: - -Using the MongoDB Database Tools --------------------------------- - -Starting in MongoDB 4.4.1, installing MongoDB via ``brew`` also installs -the MongoDB Database Tools. - -The :dbtools:`MongoDB 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`. - -Once you have installed the MongoDB Server in the steps above, the -Database Tools are available directly from the command line in your -macOS Terminal application. For example you could run :binary:`mongotop` -against your running MongoDB instance by invoking it in your -macOS Terminal like so: - -.. code-block:: bash - - mongotop - -It should start up, connect to your running :binary:`mongod`, and start -reporting usage statistics. - -See the :dbtools:`MongoDB Database Tools Documentation` 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:: bash - :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:: bash - - brew untap mongodb/brew && brew tap mongodb/brew - -#. Retry the install. - - .. code-block:: bash - - brew install mongodb-community@{+version+} +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-on-red-hat-tarball.txt b/source/tutorial/install-mongodb-on-red-hat-tarball.txt index b50f09f71f1..4d342c8660f 100644 --- a/source/tutorial/install-mongodb-on-red-hat-tarball.txt +++ b/source/tutorial/install-mongodb-on-red-hat-tarball.txt @@ -18,158 +18,4 @@ Install MongoDB Community on Red Hat or CentOS using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on Red Hat Enterprise Linux, CentOS Linux, or Oracle Linux -[#oracle-linux]_ using a downloaded ``.tgz`` tarball. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the yum Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-red-hat.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Community Edition ---------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. include:: /includes/extracts/install-mongodb-community-manually-redhat.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-on-linux.rst - - -Run MongoDB Community Edition ------------------------------ - -Prerequisites -~~~~~~~~~~~~~ - -ulimit -`````` - -.. include:: /includes/fact-installation-ulimit.rst - -Directory Paths -``````````````` - -To Use Default Directories -++++++++++++++++++++++++++ - -By default, MongoDB runs using the |mongod-user| user account and -uses the following default directories: - -- |mongod-datadir| (the data directory) - -- ``/var/log/mongodb`` (the log directory) - -Create the MongoDB data and log directories: - -.. code-block:: bash - - sudo mkdir -p /var/lib/mongo - sudo mkdir -p /var/log/mongodb - -By default, MongoDB runs using the |mongod-user| user account. Create -a |mongod-user| and a ``mongodb`` group. Ensure that the |mongod-user| -belongs to the group then set the owner and group of these directories -to |mongod-user|: - -.. code-block:: bash - - sudo chown -R mongod:mongod /var/lib/mongo - sudo chown -R mongod:mongod /var/log/mongodb - -To Use Non-Default Directories -++++++++++++++++++++++++++++++ - -To use a data directory and/or log directory other than the default -directories: - -#. Create the new directory or directories. - -#. Edit the configuration file ``/etc/mongod.conf`` and modify the - following fields accordingly: - - - :setting:`storage.dbPath` to specify a new data directory path (e.g. ``/some/data/directory``) - - - :setting:`systemLog.path` to specify a new log file path (e.g. ``/some/log/directory/mongod.log``) - -#. Ensure that the user running MongoDB has access to the directory or - directories: - - .. code-block:: bash - - sudo chown -R mongod:mongod - - If you change the user that runs the MongoDB process, you **must** - give the new user access to these directories. - -#. Configure SELinux if enforced. See :ref:`install-rhel-configure-selinux`. - -.. _install-tarball-selinux-data-directory: - -.. _install-tarball-rhel-configure-selinux: - -Configure SELinux -````````````````` - -.. include:: /includes/fact-selinux-redhat-options.rst -.. include:: /includes/important-selinux-customizations.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition on your system. -These instructions assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-on-red-hat.txt b/source/tutorial/install-mongodb-on-red-hat.txt index 9938d932f14..59788143c16 100644 --- a/source/tutorial/install-mongodb-on-red-hat.txt +++ b/source/tutorial/install-mongodb-on-red-hat.txt @@ -17,152 +17,7 @@ Install MongoDB Community Edition on Red Hat or CentOS .. |package-manager| replace:: ``yum`` .. |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 -Red Hat Enterprise Linux, CentOS Linux, or Oracle Linux -[#oracle-linux]_ using the |package-manager| package manager. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-red-hat.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -.. _install-community-redhat-pkg: - -Install MongoDB Community Edition ---------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. - -.. include:: /includes/steps/install-mongodb-on-red-hat.rst - -Run MongoDB Community Edition ------------------------------ - -Prerequisites -~~~~~~~~~~~~~ - -ulimit -`````` - -.. include:: /includes/fact-installation-ulimit.rst - -Directory Paths -``````````````` - -To Use Default Directories -++++++++++++++++++++++++++ - -By default, MongoDB runs using the |mongod-user| user account and -uses the following default directories: - -- |mongod-datadir| (the data directory) - -- ``/var/log/mongodb`` (the log directory) - -The package manager creates the default directories during -installation. The owner and group name are |mongod-user|. - -To Use Non-Default Directories -++++++++++++++++++++++++++++++ - -To use a data directory and/or log directory other than the default -directories: - -#. Create the new directory or directories. - -#. Edit the configuration file ``/etc/mongod.conf`` and modify the - following fields accordingly: - - - :setting:`storage.dbPath` to specify a new data directory path (e.g. ``/some/data/directory``) - - - :setting:`systemLog.path` to specify a new log file path (e.g. ``/some/log/directory/mongod.log``) - -#. Ensure that the user running MongoDB has access to the directory or - directories: - - .. code-block:: bash - - sudo chown -R mongod:mongod - - If you change the user that runs the MongoDB process, you **must** - give the new user access to these directories. - -#. Configure SELinux if enforced. See :ref:`install-rhel-configure-selinux`. - -.. _install-selinux-data-directory: - -.. _install-rhel-configure-selinux: - -Configure SELinux -````````````````` - -.. include:: /includes/fact-selinux-redhat-with-policy.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition on your system. -These instructions assume that you are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution.rst - -Uninstall MongoDB Community Edition ------------------------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-on-redhat.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -MongoDB Community Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-org-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-on-suse-tarball.txt b/source/tutorial/install-mongodb-on-suse-tarball.txt index 19e2ade6f19..5cff6c5be0e 100644 --- a/source/tutorial/install-mongodb-on-suse-tarball.txt +++ b/source/tutorial/install-mongodb-on-suse-tarball.txt @@ -18,86 +18,4 @@ Install MongoDB Community on SUSE using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on SUSE Linux Enterprise Server (SLES) using a downloaded -``.tgz`` tarball. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the zypper Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-suse.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Community Edition ---------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. tabs:: - - .. tab:: SUSE 15 - :tabid: suse-15 - - .. include:: /includes/extracts/install-mongodb-community-manually-suse-15.rst - - .. tab:: SUSE 12 - :tabid: suse-12 - - .. include:: /includes/extracts/install-mongodb-community-manually-suse-12.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-on-linux.rst - -Run MongoDB Community Edition ------------------------------ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-on-suse.txt b/source/tutorial/install-mongodb-on-suse.txt index b6115b3a706..ffa1d4b1c0c 100644 --- a/source/tutorial/install-mongodb-on-suse.txt +++ b/source/tutorial/install-mongodb-on-suse.txt @@ -17,96 +17,7 @@ Install MongoDB Community Edition on SUSE .. |package-manager| replace:: ``zypper`` .. |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 SUSE Linux Enterprise Server (SLES) using the -|package-manager| package manager. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations ---------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-suse.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Community Edition ---------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. - -.. include:: /includes/steps/install-mongodb-on-suse.rst - -Run MongoDB Community Edition ------------------------------ - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongod`` -.. |mongod-datadir| replace:: ``/var/lib/mongo`` - -Directories - .. include:: /includes/fact-installation-directories.rst - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-a-linux-distribution.rst - -Uninstall MongoDB Community Edition ------------------------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-on-suse.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -MongoDB Community Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-org-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-on-ubuntu-tarball.txt b/source/tutorial/install-mongodb-on-ubuntu-tarball.txt index 06f9be67df9..45ef60e7fa3 100644 --- a/source/tutorial/install-mongodb-on-ubuntu-tarball.txt +++ b/source/tutorial/install-mongodb-on-ubuntu-tarball.txt @@ -20,106 +20,4 @@ Install MongoDB Community on Ubuntu using .tgz Tarball .. |executable-name| replace:: ``mongod`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to manually install MongoDB {+version+} |edition| -Edition on LTS (long-term support) releases of Ubuntu Linux using a -downloaded ``.tgz`` tarball. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-use-package-manager.rst - -|arrow| See :doc:`Install MongoDB using the apt Package Manager` -for instructions. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-tgz.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-ubuntu.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Community Edition ---------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -.. include:: /includes/fact-tarball-dependencies.rst - -.. tabs:: - - .. tab:: Ubuntu 20.04 (Focal) - :tabid: ubuntu-20-focal - - .. include:: /includes/extracts/install-mongodb-community-manually-ubuntu-20.rst - - .. tab:: Ubuntu 18.04 (Bionic) - :tabid: ubuntu-18-bionic - - .. include:: /includes/extracts/install-mongodb-community-manually-ubuntu-18.rst - - .. tab:: Ubuntu 16.04 (Xenial) - :tabid: ubuntu-16-xenial - - .. include:: /includes/extracts/install-mongodb-community-manually-ubuntu-16.rst - -Procedure -~~~~~~~~~ - -Follow these steps to manually install MongoDB |edition| Edition from -the ``.tgz``. - -.. include:: /includes/steps/install-mongodb-on-ubuntu-tarball.rst - -Run MongoDB Community Edition ------------------------------ - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongodb`` -.. |mongod-datadir| replace:: ``/var/lib/mongodb`` - -Configuration - You can configure the MongoDB instance (such as the - data directory and log directory specifications) using - either the command-line options or a :ref:`configuration file - `. - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition. These instructions -assume that you are using the default settings. - -.. include:: /includes/steps/run-mongodb-on-linux-tarball.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-on-ubuntu.txt b/source/tutorial/install-mongodb-on-ubuntu.txt index 71fb8af4097..80692b7a684 100644 --- a/source/tutorial/install-mongodb-on-ubuntu.txt +++ b/source/tutorial/install-mongodb-on-ubuntu.txt @@ -19,129 +19,7 @@ Install MongoDB Community Edition on Ubuntu .. |package-manager| replace:: ``apt`` .. |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 -LTS (long-term support) releases of Ubuntu Linux using the -|package-manager| package manager. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Considerations --------------- - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-ubuntu.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Official MongoDB Packages -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/important-dont-use-distro-packages.rst - -See :ref:`ubuntu-package-content` for the complete list of official -packages. - -.. _install-community-ubuntu-pkg: - -Install MongoDB Community Edition ---------------------------------- - -Follow these steps to install MongoDB |edition| Edition using the -|package-manager| package manager. - -.. include:: /includes/steps/install-mongodb-on-ubuntu.rst - -For help with troubleshooting errors encountered while installing -MongoDB on Ubuntu, see our -:ref:`troubleshooting ` guide. - -Run MongoDB Community Edition ------------------------------ - -ulimit Considerations - .. include:: /includes/fact-installation-ulimit.rst - -.. |mongod-user| replace:: ``mongodb`` -.. |mongod-datadir| replace:: ``/var/lib/mongodb`` - -Directories - If you installed via the package manager, the data directory - |mongod-datadir| and the log directory ``/var/log/mongodb`` are - created during the installation. - - By default, MongoDB runs using the |mongod-user| user account. If - you change the user that runs the MongoDB process, you **must** also - modify the permission to the data and log directories to give this - user access to these directories. - -Configuration File - The official MongoDB package includes a :ref:`configuration file - ` (:file:`/etc/mongod.conf`). These settings (such as the - data directory and log directory specifications) take effect - upon startup. That is, if you change the configuration file while - the MongoDB instance is running, you must restart the instance for the - changes to take effect. - -Procedure -~~~~~~~~~ - -Follow these steps to run MongoDB |edition| Edition on your system. -These instructions assume that you are using the official |package-name| -package -- not the unofficial ``mongodb`` package provided by -|distro-name| -- and are using the default settings. - -**Init System** - -.. include:: /includes/fact-systemd-vs-initd.rst - -.. tabs:: - - .. tab:: systemd (systemctl) - :tabid: systemd-systemctl - - .. include:: /includes/steps/run-mongodb-on-debian-systemd.rst - - .. tab:: System V Init (service) - :tabid: systemvinit-service - - .. include:: /includes/steps/run-mongodb-on-debian.rst - -Uninstall MongoDB Community Edition ------------------------------------ - -.. include:: /includes/fact-uninstall.rst - -.. include:: /includes/steps/uninstall-mongodb-on-debian.rst - -Additional Information ----------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -.. _ubuntu-package-content: - -MongoDB Community Edition Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/list-mongodb-org-packages.rst +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/install-mongodb-on-windows-unattended.txt b/source/tutorial/install-mongodb-on-windows-unattended.txt index 5263099fb19..4166e0d1100 100644 --- a/source/tutorial/install-mongodb-on-windows-unattended.txt +++ b/source/tutorial/install-mongodb-on-windows-unattended.txt @@ -16,155 +16,4 @@ Install MongoDB Community on Windows using ``msiexec.exe`` .. |executable-name| replace:: ``mongod.exe`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition on -Windows in an unattended fashion using ``msiexec.exe`` from the command -line. This is useful for system administrators who wish to -deploy MongoDB using automation. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -This tutorial installs MongoDB on Windows using the command-line tool -``msiexec.exe``. To install MongoDB using the graphical MSI Installer -instead, see :doc:`Install MongoDB using the MSI Installer -`. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-win.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-windows.rst - -Virtualization -~~~~~~~~~~~~~~ - -.. include:: /includes/fact-virtualbox-not-supported.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Community Edition ---------------------------------- - -Procedure -~~~~~~~~~ - -Follow these steps to install MongoDB |edition| Edition unattended on -Windows from the `Windows command prompt/interpreter -`__ (``cmd.exe``) using ``msiexec.exe``. - -.. include:: /includes/steps/install-mongodb-on-windows-unattended.rst - -Start MongoDB Community Edition from the Command Interpreter ------------------------------------------------------------- - -Open a `Windows command prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`. - -.. important:: - - You must open the command interpreter as an - :guilabel:`Administrator`. - -.. include:: /includes/steps/run-mongodb-on-windows.rst - -Run MongoDB Community Edition as a Windows Service --------------------------------------------------- - -.. _manually-create-windows-service: - -Start MongoDB Community Edition as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Starting in version 4.0, you can install and configure MongoDB as a -:guilabel:`Windows Service` during the install, and the MongoDB service -starts upon successful installation. - -You can also manually manage the service from the command line. To -start the MongoDB service from the command line, open a `Windows -command prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. include:: /includes/steps/create-manually-windows-service-for-mongodb.rst - -Stop MongoDB Community Edition as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To stop/pause the MongoDB service, you can use the Services console: - -#. From the Services console, locate the MongoDB service. - -#. Right-click on the MongoDB service and click :guilabel:`Stop` (or :guilabel:`Pause`). - -You can also manage the service from the command line. To stop the -MongoDB service from the command line, open a `Windows command -prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. code-block:: bat - - net stop MongoDB - -Remove MongoDB Community Edition as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To remove the MongoDB service, first use the Services console to stop -the service. Then open a `Windows command prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. code-block:: bat - - sc.exe delete MongoDB - -Additional Considerations -------------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -Point Releases and ``.msi`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you installed MongoDB with the Windows installer (``.msi``), the -``.msi`` automatically upgrades within the :ref:`same release series -` (e.g. 4.2.1 to 4.2.2). - -Upgrading a full release series (e.g. 4.0 to 4.2) requires a new -installation. - -Add MongoDB binaries to the System PATH -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you add ``C:\Program Files\MongoDB\Server\{+version+}\bin`` to your -System ``PATH`` you can omit the full path to the MongoDB Server -binaries. You should also add the path to :mongosh:`mongosh ` if you -have not already done so. +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/install-mongodb-on-windows.txt b/source/tutorial/install-mongodb-on-windows.txt index f896b2f934c..60e2b45e682 100644 --- a/source/tutorial/install-mongodb-on-windows.txt +++ b/source/tutorial/install-mongodb-on-windows.txt @@ -16,197 +16,7 @@ Install MongoDB Community Edition on Windows .. |executable-name| replace:: ``mongod.exe`` .. |mdb-download-link| replace:: `MongoDB Download Center `__ -.. include:: /includes/fact-atlas-banner.rst - -Overview --------- - -Use this tutorial to install MongoDB {+version+} |edition| Edition on -Windows using the default installation wizard. - -MongoDB Version -~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-install-past-mongodb.rst - -Installation Method -~~~~~~~~~~~~~~~~~~~ - -This tutorial installs MongoDB on Windows using the default MSI -installation wizard. To install MongoDB using the ``msiexec.exe`` -command-line tool instead, see :doc:`Install MongoDB using msiexec.exe -`. The -``msiexec.exe`` tool is useful for system administrators who wish to -deploy MongoDB in an unattended fashion using automation. - -Considerations --------------- - -MongoDB Shell, ``mongosh`` -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-have-to-install-mongosh-win.rst - -Platform Support -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-platform-support-windows.rst - -Virtualization -~~~~~~~~~~~~~~ - -.. include:: /includes/fact-virtualbox-not-supported.rst - -Production Notes -~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-see-production-notes.rst - -Install MongoDB Community Edition ---------------------------------- - -Procedure -~~~~~~~~~ - -Follow these steps to install MongoDB |edition| Edition using the -MongoDB Installer wizard. The installation process installs both the -MongoDB binaries as well as the default :doc:`configuration file -` :file:`\\bin\\mongod.cfg`. - -.. include:: /includes/steps/install-mongodb-on-windows-interactive.rst - - -Install ``mongosh`` -~~~~~~~~~~~~~~~~~~~ - -The ``.msi`` installer does not include :mongosh:`mongosh `. Follow -the :mongosh:`mongosh installation instructions ` to download -and install the shell separately. - -If You Installed MongoDB as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The MongoDB service starts upon successful installation. Configure the -MongoDB instance with the configuration file -:file:`\\bin\\mongod.cfg`. - -If You Did Not Install MongoDB as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you only installed the executables and did not install MongoDB as a -Windows service, you must manually start the MongoDB instance. - -See :ref:`run-mongodb-from-cmd` for instructions to start a MongoDB -instance. - -Run MongoDB Community Edition as a Windows Service --------------------------------------------------- - -Starting in version 4.0, you can install and configure MongoDB as a -:guilabel:`Windows Service` during installation. The MongoDB service -starts upon successful installation. Configure the MongoDB instance -with the configuration file -:file:`\\bin\\mongod.cfg`. - -If you have not already done so, follow the -:mongosh:`mongosh installation instructions ` to download and -install the MongoDB Shell (:mongosh:`mongosh `). - -Be sure to add the path to your ``mongosh.exe`` binary to your -``PATH`` environment variable during installation. - -Open a new :guilabel:`Command Interpreter` and enter ``mongosh.exe`` -to connect to MongoDB. - -For more information on connecting to a :binary:`~bin.mongod` using -:mongosh:`mongosh.exe `, such as connecting to a MongoDB instance -running on a different host and/or port, see -:mongosh:`Connect to a Deployment `. - -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` - -Start MongoDB Community Edition as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To start/restart the MongoDB service, use the Services console: - -#. From the Services console, locate the MongoDB service. - -#. Right-click on the MongoDB service and click :guilabel:`Start`. - -Stop MongoDB Community Edition as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To stop/pause the MongoDB service, use the Services console: - -#. From the Services console, locate the MongoDB service. - -#. Right-click on the MongoDB service and click :guilabel:`Stop` (or :guilabel:`Pause`). - -Remove MongoDB Community Edition as a Windows Service -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To remove the MongoDB service, first use the Services console to stop -the service. Then open a `Windows command prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`, and -run the following command: - -.. code-block:: bat - - sc.exe delete MongoDB - -.. _run-mongodb-from-cmd: - -Run MongoDB Community Edition from the Command Interpreter ----------------------------------------------------------- - -You can run MongoDB Community Edition from the `Windows command prompt/interpreter -`__ (``cmd.exe``) instead of as a service. - -Open a `Windows command prompt/interpreter -`__ (``cmd.exe``) as an :guilabel:`Administrator`. - -.. important:: - - You must open the command interpreter as an - :guilabel:`Administrator`. - -.. include:: /includes/steps/run-mongodb-on-windows.rst - -Additional Considerations -------------------------- - -Localhost Binding by Default -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: /includes/fact-installation-bind-ip-default-in-config.rst - -Point Releases and ``.msi`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you installed MongoDB with the Windows installer (``.msi``), the -``.msi`` automatically upgrades within its :ref:`release series -` (e.g. 4.2.1 to 4.2.2). - -Upgrading a full release series (e.g. 4.0 to 4.2) requires a new -installation. - -Add MongoDB binaries to the System PATH -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you add ``C:\Program Files\MongoDB\Server\{+version+}\bin`` to your -System ``PATH`` you can omit the full path to the MongoDB Server -binaries. You should also add the path to :mongosh:`mongosh ` if you -have not already done so. +.. include:: /includes/rapid-release.rst .. toctree:: :hidden: diff --git a/source/tutorial/manage-mongodb-processes.txt b/source/tutorial/manage-mongodb-processes.txt index 7621e10f414..d4144965d44 100644 --- a/source/tutorial/manage-mongodb-processes.txt +++ b/source/tutorial/manage-mongodb-processes.txt @@ -13,9 +13,7 @@ Manage ``mongod`` Processes MongoDB runs as a standard program. You can start MongoDB from a command line by issuing the :binary:`~bin.mongod` command and specifying options. For a list of options, see the :binary:`~bin.mongod` -reference. MongoDB can also run as a Windows service. For details, see -:ref:`manually-create-windows-service`. To install MongoDB, see -:doc:`/installation`. +reference. The following examples assume the directory containing the :binary:`~bin.mongod` process is in your system paths. The diff --git a/source/tutorial/upgrade-revision.txt b/source/tutorial/upgrade-revision.txt index 784eea75028..c19801a7f8c 100644 --- a/source/tutorial/upgrade-revision.txt +++ b/source/tutorial/upgrade-revision.txt @@ -10,6 +10,8 @@ Upgrade to the Latest Revision of MongoDB :depth: 1 :class: singlecol +.. include:: /includes/rapid-release.rst + :ref:`MongoDB versioning ` have the form ``X.Y.Z`` where ``Z`` refers to the revision/patch number. Revisions provide security patches, bug fixes, and new or changed diff --git a/source/tutorial/upgrade-to-enterprise-replica-set.txt b/source/tutorial/upgrade-to-enterprise-replica-set.txt index d46eb1b5e66..72da7b7025a 100644 --- a/source/tutorial/upgrade-to-enterprise-replica-set.txt +++ b/source/tutorial/upgrade-to-enterprise-replica-set.txt @@ -12,34 +12,4 @@ Upgrade to MongoDB Enterprise (Replica Set) .. include:: /includes/extracts/enterprise-additional-features.rst -The following steps outline the procedure to upgrade a replica set from -the MongoDB Community Edition to the MongoDB Enterprise Edition. For -example, the steps can be used to upgrade MongoDB 6.0 Community to -MongoDB 6.0 Enterprise. - -Consideration -------------- - -.. warning:: - - .. include:: /includes/extracts/enterprise-upgrade-edition-only.rst - - -Download Enterprise Binaries ----------------------------- - -.. include:: /includes/extracts/enterprise-install-binaries.rst - -Procedure ---------- - -To minimize downtime, you can upgrade from MongoDB Community to -Enterprise Edition using a "rolling" upgrade by upgrading the members -individually while the other members are available. - -.. include:: /includes/steps/upgrade-enterprise-replica-set.rst - -.. important:: - - Before using any Enterprise features, ensure that all members have - been upgraded to Enterprise edition. +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/upgrade-to-enterprise-sharded-cluster.txt b/source/tutorial/upgrade-to-enterprise-sharded-cluster.txt index 166cb3a020b..04daca0a621 100644 --- a/source/tutorial/upgrade-to-enterprise-sharded-cluster.txt +++ b/source/tutorial/upgrade-to-enterprise-sharded-cluster.txt @@ -12,33 +12,4 @@ Upgrade to MongoDB Enterprise (Sharded Cluster) .. include:: /includes/extracts/enterprise-additional-features.rst -The following steps outline the procedure to upgrade a sharded cluster -from the MongoDB Community Edition to the MongoDB Enterprise Edition. -For example, the steps can be used to upgrade MongoDB 6.0 Community to -MongoDB 6.0 Enterprise. - -Consideration -------------- - -.. warning:: - - .. include:: /includes/extracts/enterprise-upgrade-edition-only.rst - -Download Enterprise Binaries ----------------------------- - -.. include:: /includes/extracts/enterprise-install-binaries.rst - -Procedure ---------- - -To minimize downtime, you can upgrade from MongoDB Community to -Enterprise Edition using a "rolling" upgrade by upgrading the members -individually while the other members are available. - -.. include:: /includes/steps/upgrade-enterprise-sharded-cluster.rst - -.. important:: - - Before using any Enterprise features, ensure that all members have - been upgraded to Enterprise edition. +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/upgrade-to-enterprise-standalone.txt b/source/tutorial/upgrade-to-enterprise-standalone.txt index ccc5809bb1c..1f75281cdc4 100644 --- a/source/tutorial/upgrade-to-enterprise-standalone.txt +++ b/source/tutorial/upgrade-to-enterprise-standalone.txt @@ -12,24 +12,4 @@ Upgrade to MongoDB Enterprise (Standalone) .. include:: /includes/extracts/enterprise-additional-features.rst -The following steps outline the procedure to upgrade a standalone -:binary:`~bin.mongod` from the MongoDB Community Edition to the MongoDB -Enterprise Edition. For example, the steps can be used to upgrade -MongoDB 6.0 Community to MongoDB 6.0 Enterprise. - -Consideration -------------- - -.. warning:: - - .. include:: /includes/extracts/enterprise-upgrade-edition-only.rst - -Download Enterprise Binaries ----------------------------- - -.. include:: /includes/extracts/enterprise-install-binaries.rst - -Procedure ---------- - -.. include:: /includes/steps/upgrade-enterprise-standalone.rst +.. include:: /includes/rapid-release.rst diff --git a/source/tutorial/verify-mongodb-packages.txt b/source/tutorial/verify-mongodb-packages.txt index 64867ec801a..79e46874578 100644 --- a/source/tutorial/verify-mongodb-packages.txt +++ b/source/tutorial/verify-mongodb-packages.txt @@ -12,39 +12,4 @@ Verify Integrity of MongoDB Packages .. |arrow| unicode:: U+27A4 -The MongoDB release team digitally signs all software packages to -certify that a particular MongoDB package is a valid and unaltered -MongoDB release. Before installing MongoDB, you should validate the -package using either the provided PGP signature or SHA-256 checksum. - -PGP signatures provide the strongest guarantees by checking both the -authenticity and integrity of a file to prevent tampering. - -Cryptographic checksums only validate file integrity to prevent network -transmission errors. - -Verify Linux/macOS Packages ---------------------------- - -Use PGP/GPG -~~~~~~~~~~~ - -MongoDB signs each release branch with a different PGP key. The public -key files for each release branch since MongoDB 2.2 are available for -download from the `key server `_ -in both textual ``.asc`` and binary ``.pub`` formats. - -.. include:: /includes/steps/install-verify-files-pgp.rst - -Use SHA-256 -~~~~~~~~~~~ - -.. include:: /includes/steps/install-verify-files-sha.rst - -Verify Windows Packages ------------------------ - -This verifies the MongoDB binary against its SHA256 key. - -.. include:: /includes/steps/install-verify-files-windows.rst - +.. include:: /includes/rapid-release.rst