Skip to content

Commit 85f0f5f

Browse files
author
Dave Cuthbert
authored
DOCSP-30933 macos install instructions (#275)
1 parent 51382ad commit 85f0f5f

File tree

4 files changed

+85
-73
lines changed

4 files changed

+85
-73
lines changed

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

Lines changed: 1 addition & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,7 @@ content: |
77
Open the `MongoDB Download Center
88
<https://www.mongodb.com/try/download/shell?jmp=docs>`__.
99
---
10-
title: "Download the ``mongosh`` installation archive for your
11-
operating system."
12-
ref: download-archive
13-
level: 4
14-
content: |
15-
16-
Download the appropriate version of ``mongosh`` for your operating
17-
system. MongoDB also provides versions of ``mongosh`` that use the
18-
system's OpenSSL installation. For details, see the `MongoDB Download
19-
Center <https://www.mongodb.com/try/download/shell?jmp=docs>`__.
20-
---
21-
title: "Extract the files from the downloaded archive."
22-
ref: extract-archive
23-
level: 4
24-
content: |
25-
26-
Extract the files from the downloaded archive. For example, run the
27-
following command from the directory containing the downloaded
28-
``.tgz`` package:
29-
30-
.. code-block:: sh
31-
32-
tar -zxvf mongosh-{+version+}-linux-x64.tgz
3310

34-
You will need to provide your exact ``.tgz`` package in the command,
35-
which may vary depending on the package version you downloaded. For
36-
example, the ``mongosh`` OpenSSL 3 package is:
37-
38-
.. code-block:: sh
39-
40-
mongosh-{+version+}-linux-x64-openssl3.tgz
41-
42-
The extracted ``bin`` folder contains two binaries: ``mongosh`` and
43-
``mongosh_csfle_v1.so``.
44-
45-
For ``mongosh`` packages that support OpenSSL, you will see a
46-
different ``.so`` file. For example, ``mongosh_crypt_v1.so``.
47-
48-
If your web browser automatically extracts the archive as part of the
49-
download or you extract the archive without the ``tar`` command,
50-
you may need to make the binary executable. Run the following
51-
command from the directory where you extracted the archive:
52-
53-
.. code-block:: sh
54-
55-
chmod +x bin/mongosh
56-
---
5711
title: "Add the downloaded binaries to your ``PATH`` environment
5812
variable."
5913
ref: add-shell-to-path
@@ -69,11 +23,7 @@ content: |
6923
.. code-block:: sh
7024
7125
sudo cp mongosh /usr/local/bin/
72-
sudo cp mongosh_csfle_v1.so /usr/local/lib/
73-
74-
For ``mongosh`` packages that support OpenSSL, you will see a
75-
different ``.so`` file. For example, ``mongosh_crypt_v1.so``. Use
76-
that file instead in the previous command.
26+
sudo cp mongosh_crypt_v1.so /usr/local/lib/
7727
7828
- Create symbolic links to the ``MongoDB Shell``. Switch to the
7929
directory where you extracted the files from the ``.tgz`` archive.

source/includes/steps-install-shell-linux-generic.yaml

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,48 @@ source:
55
ref: navigate-dlc-generic-linux
66
---
77
title: "Download the Linux 64-bit ``.tgz`` package."
8-
ref: download-archive-rhel
8+
ref: download-archive-generic
99
level: 4
1010
content: |
1111
1212
Download the appropriate version of ``mongosh`` for your operating
13-
system. MongoDB also provides versions of ``mongosh`` that use the
14-
system's OpenSSL installation. For details, see the `MongoDB Download
15-
Center <https://www.mongodb.com/try/download/shell?jmp=docs>`__.
13+
system. MongoDB also provides versions of ``mongosh`` that use your
14+
system's OpenSSL installation.
15+
16+
See the `MongoDB Download Center
17+
<https://www.mongodb.com/try/download/shell?jmp=docs>`__.
1618
---
17-
source:
18-
file: steps-install-shell-base.yaml
19-
ref: extract-archive
19+
title: "Extract the files from the downloaded archive."
2020
ref: extract-archive-generic-linux
21+
level: 4
22+
content: |
23+
Go to the directory that contains the ``.tgz`` archive, then unpack
24+
the archive.
25+
26+
The name of the ``.tgz`` package varies depending on the version you
27+
downloaded. Replace the ``.tgz`` package name in the following
28+
command with the name of the package you downloaded and run the
29+
command.
30+
31+
.. code-block:: sh
32+
33+
tar -zxvf mongosh-{+version+}-linux-x64.tgz
34+
35+
36+
The extracted archive has a ``bin`` folder that contains two files,
37+
``mongosh`` and ``mongosh_crypt_v1.so``.
38+
39+
If your web browser automatically extracts the archive as part of the
40+
download, or if you extract the archive without using the ``tar``
41+
command, you may need to make the binary executable.
42+
43+
To make the binary executable, run the following command in the
44+
directory where you extracted the archive:
45+
46+
.. code-block:: sh
47+
48+
chmod +x bin/mongosh
49+
2150
---
2251
source:
2352
file: steps-install-shell-base.yaml

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

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,48 @@ source:
44
ref: navigate-dlc
55
ref: navigate-dlc-macos
66
---
7-
source:
8-
file: steps-install-shell-base.yaml
9-
ref: download-archive
7+
title: "Download the ``mongosh`` installation archive for your
8+
operating system."
109
ref: download-archive-macos
10+
level: 4
11+
content: |
12+
Download the appropriate version of ``mongosh`` for your operating
13+
system. MongoDB provides versions of ``mongosh`` for Intel and ARM
14+
architectures.
15+
16+
See the `MongoDB Download Center
17+
<https://www.mongodb.com/try/download/shell?jmp=docs>`__.
18+
1119
---
1220
title: "Extract the files from the downloaded archive."
1321
ref: extract-zip-macos
1422
level: 4
1523
content: |
16-
17-
Run the following command from the directory containing the
18-
``mongosh`` ``.zip`` archive:
24+
Go to the directory that contains the ``mongosh`` ``.zip`` archive,
25+
then unpack the ``.zip`` file.
26+
27+
If your computer is Intel based, run:
1928
2029
.. code-block:: sh
2130
2231
unzip mongosh-{+version+}-darwin-x64.zip
2332
24-
The extracted ``bin`` folder contains two binaries: ``mongosh`` and
25-
``mongosh_csfle_v1.dylib``.
33+
If your computer is ARM based (M1 or M2), run:
34+
35+
.. code-block:: sh
36+
37+
unzip mongosh-{+version+}-darwin-arm64.zip
38+
39+
40+
The extracted archive has a ``bin`` folder that contains two files,
41+
``mongosh`` and ``mongosh_crypt_v1.dylib``.
2642
2743
If your web browser automatically extracts the archive as part of the
28-
download or you extract the archive without the ``unzip`` command,
29-
you may need to make the binary executable. Run the following
30-
command from the directory where you extracted the archive:
44+
download, or if you extract the archive without using the ``unzip``
45+
command, you may need to make the binary executable.
46+
47+
To make the binary executable, run the following command in the
48+
directory where you extracted the archive:
3149
3250
.. code-block:: sh
3351

source/includes/steps-install-shell-windows.yaml

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,29 @@ source:
44
ref: navigate-dlc
55
ref: navigate-dlc-windows
66
---
7-
source:
8-
file: steps-install-shell-base.yaml
9-
ref: download-archive
7+
title: "Download the ``mongosh`` installation archive for your
8+
operating system."
109
ref: download-archive-windows
10+
level: 4
11+
content: |
12+
Download ``mongosh`` from the `MongoDB Download Center
13+
<https://www.mongodb.com/try/download/shell?jmp=docs>`__.
14+
1115
---
1216
title: "Extract the files from the downloaded archive."
13-
ref: extract-archive
17+
ref: extract-zip-windows
1418
level: 4
19+
content: |
20+
Open a ``cmd`` terminal and run the following command from the
21+
directory that has the ``mongosh`` ``.zip`` archive:
22+
23+
.. code-block:: sh
24+
25+
tar -xf mongosh-{+version+}-win32-x64.zip
26+
27+
The extracted archive has a ``bin`` folder that contains two files,
28+
``mongosh.exe`` and ``mongosh_crypt_v1.dll``.
29+
1530
---
1631
title: "Add the ``mongosh`` binary to your ``PATH`` environment
1732
variable."

0 commit comments

Comments
 (0)