Skip to content

DOCS-10906 - Add Compass Installer to MongoDB packaging #3130

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
Nov 30, 2017
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
3 changes: 3 additions & 0 deletions source/includes/fact-install-windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ installation option.
These instructions assume that you have installed MongoDB
to ``C:\Program Files\MongoDB\Server\3.6\``.

During the installation process you will be given the option to install
:ref:`MongoDB Compass <compass-index>` in addition to MongoDB Server.

MongoDB is self-contained and does not have any other system
dependencies. You can run MongoDB from any folder you choose. You may
install MongoDB in any folder (e.g. ``D:\test\mongodb``).
9 changes: 9 additions & 0 deletions source/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ MongoDB.

For upgrade instructions, see :ref:`3.6-upgrade` instead.

.. note::

.. versionadded:: 3.6

Each MongoDB installer is packaged with a platform-specific
:ref:`MongoDB Compass <compass-index>` installation script. This
script installs MongoDB Compass as part of the MongoDB Server
installation process.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we'll actually need to include a install_compass for the installation script under
https://docs.mongodb.com/master/reference/program/

Then, basically, this new page just state that this is the installer for Compass Community edition and how to run.

Then link to: https://docs.mongodb.com/compass/current/#compass-and-compass-community-editions


Supported Platforms
-------------------

Expand Down
18 changes: 16 additions & 2 deletions source/reference/program.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ Binary Import and Export Tools
dump files from the :program:`mongod` instances, while
:program:`mongorestore` makes it possible to restore these
dumps. :program:`bsondump` converts BSON dump files into
:term:`JSON`.
:term:`JSON`.

.. deprecated:: 3.2
.. deprecated:: 3.2

:program:`mongooplog`

Expand Down Expand Up @@ -116,3 +116,17 @@ GridFS
:maxdepth: 1

/reference/program/mongofiles

MongoDB Compass
---------------

.. versionadded:: 3.6

MongoDB is packaged with an :program:`install_compass` script, which
is a platform-specific installer for
:ref:`MongoDB Compass Community Edition <compass-index>`.

.. toctree::
:maxdepth: 1

/reference/program/install_compass
54 changes: 54 additions & 0 deletions source/reference/program/install_compass.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
.. _install-compass:

:orphan:

===================
``install_compass``
===================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

.. versionadded:: 3.6

Synopsis
--------

:program:`install_compass` is a platform-specific installation script
for :ref:`MongoDB Compass Community Edition <compass-index>`.

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

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:

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

python install_compass

Windows
~~~~~~~

On Windows systems, the ``install_compass`` script is a PowerShell
script included in the the MongoDB Server archive download.

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:

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

powershell .\Install-Compass.ps1

9 changes: 9 additions & 0 deletions source/release-notes/3.6.txt
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,15 @@ Sharded Clusters
General Enhancements
--------------------

MongoDB Compass Packaging
~~~~~~~~~~~~~~~~~~~~~~~~~

The MongoDB Server download is packaged with a platform-specific
:doc:`installation script </reference/program/install_compass>` for
:ref:`MongoDB Compass Community Edition <compass-index>`. This
script installs MongoDB Compass as part of the MongoDB Server
installation process.

Collection Identifier
~~~~~~~~~~~~~~~~~~~~~

Expand Down
1 change: 0 additions & 1 deletion source/tutorial/install-mongodb-enterprise-on-windows.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ support for several features related to security and monitoring.

.. include:: /includes/fact-default-bind-ip-change.rst


Prerequisites
-------------

Expand Down