Skip to content

DOCSP-14120 add macos security note mongo shell #4847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions source/includes/extracts-macos-prevent-from-launch.yaml
Original file line number Diff line number Diff line change
@@ -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"
...
14 changes: 14 additions & 0 deletions source/includes/extracts-macos-prevent-launch-base.yaml
Original file line number Diff line number Diff line change
@@ -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.
...
5 changes: 5 additions & 0 deletions source/includes/fact-download-mongo-shell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
</installation>`.
22 changes: 2 additions & 20 deletions source/includes/steps-run-mongodb-on-osx.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions source/mongo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
22 changes: 2 additions & 20 deletions source/tutorial/install-mongodb-on-os-x.txt
Original file line number Diff line number Diff line change
Expand Up @@ -197,16 +197,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:

Expand Down Expand Up @@ -243,16 +234,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:

Expand Down