From b14b901f08f51a1fd1b7e36ee2dbb72fb06282c5 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Wed, 27 Jan 2021 12:22:59 -0500 Subject: [PATCH] DOCSP-14120 add macos security note mongo shell --- .../extracts-macos-prevent-from-launch.yaml | 14 ++++++++++++ .../extracts-macos-prevent-launch-base.yaml | 14 ++++++++++++ source/includes/fact-download-mongo-shell.rst | 5 +++++ source/includes/steps-run-mongodb-on-osx.yaml | 22 ++----------------- source/mongo.txt | 7 ++++++ source/tutorial/install-mongodb-on-os-x.txt | 22 ++----------------- 6 files changed, 44 insertions(+), 40 deletions(-) create mode 100644 source/includes/extracts-macos-prevent-from-launch.yaml create mode 100644 source/includes/extracts-macos-prevent-launch-base.yaml diff --git a/source/includes/extracts-macos-prevent-from-launch.yaml b/source/includes/extracts-macos-prevent-from-launch.yaml new file mode 100644 index 00000000000..6d0518c441c --- /dev/null +++ b/source/includes/extracts-macos-prevent-from-launch.yaml @@ -0,0 +1,14 @@ +ref: macos-prevent-launch-mongod +source: + ref: _macos-prevent-launch + file: extracts-macos-prevent-launch-base.yaml +replacement: + binary_name: ":binary:`~bin.mongod`" +--- +ref: macos-prevent-launch-mongo +source: + ref: _macos-prevent-launch + file: extracts-macos-prevent-launch-base.yaml +replacement: + binary_name: "the :binary:`~bin.mongo` shell" +... diff --git a/source/includes/extracts-macos-prevent-launch-base.yaml b/source/includes/extracts-macos-prevent-launch-base.yaml new file mode 100644 index 00000000000..9950caae6af --- /dev/null +++ b/source/includes/extracts-macos-prevent-launch-base.yaml @@ -0,0 +1,14 @@ +ref: _macos-prevent-launch +content: | + macOS may prevent {{binary_name}} from running after installation. If + you receive a security error when starting {{binary_name}} + indicating that the developer could not be identified or verified, + do the following to grant {{binary_name}} access to run: + + - Open *System Preferences* + - Select the *Security and Privacy* pane. + - Under the *General* tab, click the button to the right of the + message about {{binary_name}}, labelled either :guilabel:`Open + Anyway` or :guilabel:`Allow Anyway` depending on your version of + macOS. +... diff --git a/source/includes/fact-download-mongo-shell.rst b/source/includes/fact-download-mongo-shell.rst index ca8c57f9672..0954611b0da 100644 --- a/source/includes/fact-download-mongo-shell.rst +++ b/source/includes/fact-download-mongo-shell.rst @@ -47,3 +47,8 @@ a standalone package by following these steps: 4. Copy the :binary:`~bin.mongo` shell from the archive to a location on your filesystem. + +For additional installation guidance specific to your platform, or to +install the :binary:`~bin.mongo` shell as part of a MongoDB Server +installation, see the :doc:`installation guide for your platform +`. diff --git a/source/includes/steps-run-mongodb-on-osx.yaml b/source/includes/steps-run-mongodb-on-osx.yaml index 261279dcf78..a18e9208ac3 100644 --- a/source/includes/steps-run-mongodb-on-osx.yaml +++ b/source/includes/steps-run-mongodb-on-osx.yaml @@ -80,16 +80,7 @@ post: | .. admonition:: macOS Prevents ``mongod`` From Opening :class: note - macOS may prevent ``mongod`` from running after installation. If - you receive a security error when starting ``mongod`` - indicating that the developer could not be identified or verified, - do the following to grant ``mongod`` access to run: - - - Open *System Preferences* - - Select the *Security and Privacy* pane. - - Under the *General* tab, click the button to the right of the - message about ``mongod``, labelled either :guilabel:`Open Anyway` - or :guilabel:`Allow Anyway` depending on your version of macOS. + .. include:: /includes/extracts/macos-prevent-launch-mongod.rst # End-for-getting-started-guide --- @@ -123,16 +114,7 @@ post: | .. admonition:: macOS Prevents ``mongo`` From Opening :class: note - macOS may prevent ``mongo`` from running after installation. If - you receive a security error when starting ``mongo`` - indicating that the developer could not be identified or verified, - do the following to grant ``mongo`` access to run: - - - Open *System Preferences* - - Select the *Security and Privacy* pane. - - Under the *General* tab, click the button to the right of the - message about ``mongo``, labelled either :guilabel:`Open Anyway` - or :guilabel:`Allow Anyway` depending on your version of macOS. + .. include:: /includes/extracts/macos-prevent-launch-mongo.rst For more information on connecting using the :binary:`~bin.mongo` shell, such as to connect to a :binary:`~bin.mongod` instance running diff --git a/source/mongo.txt b/source/mongo.txt index c050e98483b..1af0424700e 100644 --- a/source/mongo.txt +++ b/source/mongo.txt @@ -56,6 +56,13 @@ Prerequisites can copy the ``mongo`` shell to a location on your filesystem that is already present in your ``PATH``, such as ``/usr/bin`` on Linux. +macOS Security Verification +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +*For macOS users:* + +.. include:: /includes/extracts/macos-prevent-launch-mongo.rst + Local MongoDB Instance on Default Port ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/tutorial/install-mongodb-on-os-x.txt b/source/tutorial/install-mongodb-on-os-x.txt index 4e6a9510d8c..4d66d3beb60 100644 --- a/source/tutorial/install-mongodb-on-os-x.txt +++ b/source/tutorial/install-mongodb-on-os-x.txt @@ -204,16 +204,7 @@ this file as well. .. admonition:: macOS Prevents ``mongod`` From Opening :class: note - macOS may prevent ``mongod`` from running after installation. If - you receive a security error when starting ``mongod`` - indicating that the developer could not be identified or verified, - do the following to grant ``mongod`` access to run: - - - Open *System Preferences* - - Select the *Security and Privacy* pane. - - Under the *General* tab, click the button to the right of the - message about ``mongod``, labelled either :guilabel:`Open Anyway` - or :guilabel:`Allow Anyway` depending on your version of macOS. + .. include:: /includes/extracts/macos-prevent-launch-mongod.rst To verify that MongoDB is running, perform one of the following: @@ -250,16 +241,7 @@ running instance. From a new terminal, issue the following: .. admonition:: macOS Prevents ``mongo`` From Opening :class: note - macOS may prevent ``mongo`` from running after installation. If - you receive a security error when starting ``mongo`` - indicating that the developer could not be identified or verified, - do the following to grant ``mongo`` access to run: - - - Open *System Preferences* - - Select the *Security and Privacy* pane. - - Under the *General* tab, click the button to the right of the - message about ``mongo``, labelled either :guilabel:`Open Anyway` - or :guilabel:`Allow Anyway` depending on your version of macOS. + .. include:: /includes/extracts/macos-prevent-launch-mongo.rst For information on CRUD (Create,Read,Update,Delete) operations, see: