Skip to content

Commit e3ea8c5

Browse files
jeff-allen-mongojeff-allen-mongo
authored
(DOCSP-10539): Install tweaks for Homebrew (#15)
* (DOCSP-10539): Install tweaks for Homebrew * indentation tweak * updates per Andrew's feedback * copy tweaks
1 parent 373e976 commit e3ea8c5

File tree

5 files changed

+146
-35
lines changed

5 files changed

+146
-35
lines changed

‎source/includes/steps-install-shell-base.yaml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,18 @@ ref: extract-archive
2323
level: 4
2424
content: |
2525
26-
.. code-block::
26+
.. code-block:: sh
2727
2828
tar -zxvf path/to/archive
2929
30-
Skip this step if your web browser automatically unzips the file as
31-
part of the download.
30+
If your web browser automatically extracts the archive as
31+
part of the download or you extract the archive without the
32+
``tar`` command, you may need to run the following command to
33+
make ``mongosh`` executable:
34+
35+
.. code-block:: sh
36+
37+
chmod +x /path/to/mongosh
3238
---
3339
title: "Add the MongoDB Shell binary to your ``PATH`` environment
3440
variable."

‎source/includes/steps-install-shell-macos-homebrew.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "Install Homebrew."
3+
ref: install-homebrew
4+
level: 4
5+
content: |
6+
7+
Refer to the `Homebrew <https://brew.sh/>`__ website
8+
for the steps to install Homebrew on macOS.
9+
---
10+
title: "Tap the MongoDB Homebrew Tap."
11+
ref: tab-mongodb
12+
level: 4
13+
content: |
14+
15+
Issue the following command from the terminal to tap the official
16+
`MongoDB Homebrew Tap <https://github.com/mongodb/homebrew-brew>`__:
17+
18+
.. code-block:: sh
19+
20+
brew tap mongodb/brew
21+
---
22+
title: "Install the ``mongosh`` package."
23+
ref: install-mongosh-package
24+
level: 4
25+
content: |
26+
27+
Issue the following command from the terminal to install the
28+
``mongosh`` package:
29+
30+
.. code-block:: sh
31+
32+
brew install mongosh
33+
...

‎source/includes/steps-install-shell-macos.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,21 @@ source:
2323
file: steps-install-shell-base.yaml
2424
ref: add-shell-to-path
2525
ref: add-shell-to-path-macos
26+
---
27+
title: "Allow macOS to Run ``mongosh``."
28+
ref: remove-quarantine-macos
29+
level: 4
30+
content: |
31+
macOS may prevent ``mongosh`` from running after installation. If
32+
you receive a security error when starting ``mongosh`` indicating
33+
that the developer could not be identified or verified, perform
34+
the following actions:
35+
36+
a. Open *System Preferences*.
37+
38+
#. Select the *Security and Privacy* pane.
2639
40+
#. Under the *General* tab, click the button to the right of the
41+
message about ``mongosh``, labelled either :guilabel:`Open Anyway`
42+
or :guilabel:`Allow Anyway` depending on your version of macOS.
2743
...

‎source/index.txt

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -24,37 +24,8 @@ download center.
2424
Download and Install the |mdb-shell|
2525
------------------------------------
2626

27-
Prerequisites
28-
~~~~~~~~~~~~~
29-
30-
To use the |mdb-shell|, you must have a MongoDB deployment to connect
31-
to.
32-
33-
- For a free cloud-hosted deployment, you can use
34-
`MongoDB Atlas <https://www.mongodb.com/cloud/atlas?tck=docs_vsce>`__.
35-
36-
- To learn how to run a local MongoDB deployment, see
37-
:manual:`Install MongoDB </installation/>`.
38-
39-
Procedure
40-
~~~~~~~~~
41-
42-
.. tabs-platforms::
43-
44-
.. tab::
45-
:tabid: windows
46-
47-
.. include:: /includes/steps/install-shell-windows.rst
48-
49-
.. tab::
50-
:tabid: macOS
51-
52-
.. include:: /includes/steps/install-shell-macos.rst
53-
54-
.. tab::
55-
:tabid: linux
56-
57-
.. include:: /includes/steps/install-shell-generic-linux.rst
27+
To learn how to download and install the |mdb-shell|, see
28+
:ref:`mdb-shell-install`.
5829

5930
Connect to a MongoDB Deployment
6031
-------------------------------
@@ -138,7 +109,8 @@ Learn More
138109

139110
.. toctree::
140111
:titlesonly:
141-
112+
113+
/install
142114
/connect
143115
/crud
144116
/run-agg-pipelines

‎source/install.txt

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
.. _mdb-shell-install:
2+
3+
=======================
4+
Install the |mdb-shell|
5+
=======================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
.. include:: /includes/admonitions/fact-mdb-shell-beta.rst
16+
17+
Prerequisites
18+
-------------
19+
20+
To use the |mdb-shell|, you must have a MongoDB deployment to connect
21+
to.
22+
23+
- For a free cloud-hosted deployment, you can use
24+
`MongoDB Atlas <https://www.mongodb.com/cloud/atlas?tck=docs_vsce>`__.
25+
26+
- To learn how to run a local MongoDB deployment, see
27+
:manual:`Install MongoDB </installation/>`.
28+
29+
Procedure
30+
---------
31+
32+
.. tabs-platforms::
33+
34+
.. tab::
35+
:tabid: windows
36+
37+
.. include:: /includes/steps/install-shell-windows.rst
38+
39+
.. tab::
40+
:tabid: macOS
41+
42+
.. _macos-install-homebrew:
43+
44+
Install with Homebrew
45+
~~~~~~~~~~~~~~~~~~~~~
46+
47+
.. important::
48+
49+
To install ``mongosh`` with Homebrew on macOS, you must have a
50+
minimum `node.JS <https://nodejs.org/en/download/>`__ version
51+
of ``12.0.0``.
52+
53+
To view the complete list of system requirements for Homebrew,
54+
see the
55+
`Homebrew Website <https://docs.brew.sh/Installation>`__.
56+
57+
The Homebrew package manager is the recommended installation
58+
method for ``mongosh`` on macOS. To learn how to manually install
59+
``mongosh`` from an archive, see :ref:`macos-install-archive`.
60+
61+
To install ``mongosh`` with Homebrew:
62+
63+
.. include:: /includes/steps/install-shell-macos-homebrew.rst
64+
65+
.. _macos-install-archive:
66+
67+
Install from Tarball
68+
~~~~~~~~~~~~~~~~~~~~
69+
70+
To manually install ``mongosh`` using a downloaded ``.tgz``
71+
tarball:
72+
73+
.. include:: /includes/steps/install-shell-macos.rst
74+
75+
.. tab::
76+
:tabid: linux
77+
78+
.. include:: /includes/steps/install-shell-generic-linux.rst
79+
80+
Next Steps
81+
----------
82+
83+
Once you successfully install ``mongosh``, learn how to
84+
:ref:`connect to your MongoDB deployment <mdb-shell-connect>`.

0 commit comments

Comments
 (0)