|
1 | 1 | .. _install-compass:
|
2 | 2 |
|
3 |
| -:orphan: |
4 |
| - |
5 | 3 | ===================
|
6 | 4 | ``install_compass``
|
7 | 5 | ===================
|
|
19 | 17 | Synopsis
|
20 | 18 | --------
|
21 | 19 |
|
22 |
| -:binary:`~bin.install_compass` is a platform-specific installation script |
23 |
| -for :ref:`MongoDB Compass Community Edition <compass-index>`. |
| 20 | +:binary:`~bin.install_compass` (``Install-Compass`` in Windows) is a |
| 21 | +platform-specific installation script for |
| 22 | +:ref:`MongoDB Compass <compass-index>`. |
| 23 | + |
| 24 | +If downloaded as a part of the |
| 25 | +`MongoDB Enterprise Server <https://www.mongodb.com/download-center#enterprise>`_ |
| 26 | +package, the ``install_compass`` script installs the standard edition |
| 27 | +of :ref:`MongoDB Compass <compass-index>`. |
| 28 | + |
| 29 | +If downloaded as part of the |
| 30 | +`MongoDB Community Server <https://www.mongodb.com/download-center#community>`_ |
| 31 | +package, the ``install_compass`` script installs |
| 32 | +:ref:`MongoDB Compass Community edition <compass-index>`. |
24 | 33 |
|
25 | 34 | Installation
|
26 | 35 | ------------
|
27 | 36 |
|
28 |
| -Linux / MacOS |
| 37 | +.. note:: |
| 38 | + |
| 39 | + The ``install_compass`` script first removes and replaces any |
| 40 | + previously installed versions of the same |compass| edition (either |
| 41 | + |compass| or |compass| Community). |
| 42 | + |
| 43 | + .. example:: |
| 44 | + |
| 45 | + If you run the ``install_compass`` script installed as part of |
| 46 | + MongoDB Community Server 3.6, the script removes any installed |
| 47 | + versions of |compass| Community and installs a compatible |
| 48 | + version of Compass Community. |
| 49 | + |
| 50 | +Linux / macOS |
29 | 51 | ~~~~~~~~~~~~~
|
30 | 52 |
|
31 |
| -On Linux / MacOS systems, navigate to the directory where the |
32 |
| -``install_compass`` script was downloaded and run the following command |
33 |
| -to execute the script and install MongoDB Compass: |
| 53 | +On Linux and macOS platforms the ``install_compass`` script is a Unix |
| 54 | +executable script included in the MongoDB Server download. The script |
| 55 | +is packaged with the download for each platform. |
| 56 | + |
| 57 | +1. Change to the ``bin`` directory under the MongoDB Server |
| 58 | + download directory: |
34 | 59 |
|
35 |
| -.. class:: copyable-code |
36 |
| -.. code-block:: sh |
| 60 | + .. class:: copyable-code |
| 61 | + .. code-block:: sh |
37 | 62 |
|
38 |
| - python install_compass |
| 63 | + cd <installDirectory>/bin |
| 64 | + |
| 65 | +2. Install |compass| using the ``install_compass`` script: |
| 66 | + |
| 67 | + .. class:: copyable-code |
| 68 | + .. code-block:: sh |
| 69 | + |
| 70 | + ./install_compass |
39 | 71 |
|
40 | 72 | Windows
|
41 | 73 | ~~~~~~~
|
42 | 74 |
|
43 |
| -On Windows systems, the ``install_compass`` script is a PowerShell |
44 |
| -script included in the the MongoDB Server archive download. |
| 75 | +On Windows platforms the ``Install-Compass`` script is a PowerShell |
| 76 | +script included in both the MongoDB Server ``.zip`` archive and |
| 77 | +``.msi`` installer downloads. |
| 78 | + |
| 79 | +From the Windows Command Prompt: |
| 80 | + |
| 81 | +1. Change to the ``bin`` directory under the MongoDB Server |
| 82 | + download directory: |
| 83 | + |
| 84 | + .. class:: copyable-code |
| 85 | + .. code-block:: none |
| 86 | + |
| 87 | + cd <installDirectory>\bin |
45 | 88 |
|
46 |
| -Navigate to the directory where the ``Install-Compass.ps1`` file was |
47 |
| -downloaded and run the following command to execute the script and |
48 |
| -install MongoDB Compass: |
| 89 | +2. Install |compass| using the ``install_compass`` script: |
49 | 90 |
|
50 |
| -.. class:: copyable-code |
51 |
| -.. code-block:: none |
| 91 | + .. class:: copyable-code |
| 92 | + .. code-block:: none |
52 | 93 |
|
53 |
| - powershell .\Install-Compass.ps1 |
| 94 | + powershell .\Install-Compass.ps1 |
54 | 95 |
|
| 96 | +Alternatively, if using the ``.msi`` installer for MongoDB Server for |
| 97 | +Windows, during installation you are presented with a checkbox |
| 98 | +indicating whether to install |compass| with MongoDB server. If |
| 99 | +checked, the installer automatically executes the ``install_compass`` |
| 100 | +script. |
0 commit comments