Skip to content

DOCS-11200 - Updating install_compass install docs for Linux and Mac #3203

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 23, 2018
Merged
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
84 changes: 65 additions & 19 deletions source/reference/program/install_compass.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. _install-compass:

:orphan:

===================
``install_compass``
===================
Expand All @@ -19,36 +17,84 @@
Synopsis
--------

:binary:`~bin.install_compass` is a platform-specific installation script
for :ref:`MongoDB Compass Community Edition <compass-index>`.
:binary:`~bin.install_compass` (``Install-Compass`` in Windows) is a
platform-specific installation script for
:ref:`MongoDB Compass <compass-index>`.

If downloaded as a part of the
`MongoDB Enterprise Server <https://www.mongodb.com/download-center#enterprise>`_
package, the ``install_compass`` script installs the standard edition
of :ref:`MongoDB Compass <compass-index>`.

If downloaded as part of the
`MongoDB Community Server <https://www.mongodb.com/download-center#community>`_
package, the ``install_compass`` script installs
:ref:`MongoDB Compass Community edition <compass-index>`.

Installation
------------

Linux / MacOS
.. note::

The ``install_compass`` script first removes and replaces any
previously installed versions of the same |compass| edition (either
|compass| or |compass| Community).

.. example::

If you run the ``install_compass`` script installed as part of
MongoDB Community Server 3.6, the script removes any installed
versions of |compass| Community and installs a compatible
version of Compass Community.

Linux / macOS
~~~~~~~~~~~~~

On Linux / MacOS systems, navigate to the directory where the
``install_compass`` script was downloaded and run the following command
to execute the script and install MongoDB Compass:
On Linux and macOS platforms the ``install_compass`` script is a Unix
executable script included in the MongoDB Server download. The script
is packaged with the download for each platform.

1. Change to the ``bin`` directory under the MongoDB Server
download directory:

.. class:: copyable-code
.. code-block:: sh
.. class:: copyable-code
.. code-block:: sh

python install_compass
cd <installDirectory>/bin

2. Install |compass| using the ``install_compass`` script:

.. class:: copyable-code
.. code-block:: sh

./install_compass

Windows
~~~~~~~

On Windows systems, the ``install_compass`` script is a PowerShell
script included in the the MongoDB Server archive download.
On Windows platforms the ``Install-Compass`` script is a PowerShell
script included in both the MongoDB Server ``.zip`` archive and
``.msi`` installer downloads.

From the Windows Command Prompt:

1. Change to the ``bin`` directory under the MongoDB Server
download directory:

.. class:: copyable-code
.. code-block:: none

cd <installDirectory>\bin

Navigate to the directory where the ``Install-Compass.ps1`` file was
downloaded and run the following command to execute the script and
install MongoDB Compass:
2. Install |compass| using the ``install_compass`` script:

.. class:: copyable-code
.. code-block:: none
.. class:: copyable-code
.. code-block:: none

powershell .\Install-Compass.ps1
powershell .\Install-Compass.ps1

Alternatively, if using the ``.msi`` installer for MongoDB Server for
Windows, during installation you are presented with a checkbox
indicating whether to install |compass| with MongoDB server. If
checked, the installer automatically executes the ``install_compass``
script.