Skip to content

Commit ac4c33a

Browse files
jeff-allen-mongokay-kim
authored andcommitted
Updates per Kay's feedback
1 parent 225ff9a commit ac4c33a

File tree

6 files changed

+91
-3
lines changed

6 files changed

+91
-3
lines changed

source/includes/fact-install-windows.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ installation option.
1111
These instructions assume that you have installed MongoDB
1212
to ``C:\Program Files\MongoDB\Server\3.6\``.
1313

14+
During the installation process you will be given the option to install
15+
:ref:`MongoDB Compass <compass-index>` in addition to MongoDB Server.
16+
1417
MongoDB is self-contained and does not have any other system
1518
dependencies. You can run MongoDB from any folder you choose. You may
1619
install MongoDB in any folder (e.g. ``D:\test\mongodb``).

source/installation.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ MongoDB.
2323

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

26+
.. note::
27+
28+
.. versionadded:: 3.6
29+
30+
Each MongoDB installer is packaged with a platform-specific
31+
:ref:`MongoDB Compass <compass-index>` installation script. This
32+
script installs MongoDB Compass as part of the MongoDB Server
33+
installation process.
34+
2635
Supported Platforms
2736
-------------------
2837

source/reference/program.txt

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ Binary Import and Export Tools
4747
dump files from the :program:`mongod` instances, while
4848
:program:`mongorestore` makes it possible to restore these
4949
dumps. :program:`bsondump` converts BSON dump files into
50-
:term:`JSON`.
50+
:term:`JSON`.
5151

52-
.. deprecated:: 3.2
52+
.. deprecated:: 3.2
5353

5454
:program:`mongooplog`
5555

@@ -116,3 +116,17 @@ GridFS
116116
:maxdepth: 1
117117

118118
/reference/program/mongofiles
119+
120+
MongoDB Compass
121+
---------------
122+
123+
.. versionadded:: 3.6
124+
125+
MongoDB is packaged with an :program:`install_compass` script, which
126+
is a platform-specific installer for
127+
:ref:`MongoDB Compass Community Edition <compass-index>`.
128+
129+
.. toctree::
130+
:maxdepth: 1
131+
132+
/reference/program/install_compass
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
.. _install-compass:
2+
3+
:orphan:
4+
5+
===================
6+
``install_compass``
7+
===================
8+
9+
.. default-domain:: mongodb
10+
11+
.. contents:: On this page
12+
:local:
13+
:backlinks: none
14+
:depth: 1
15+
:class: singlecol
16+
17+
.. versionadded:: 3.6
18+
19+
Synopsis
20+
--------
21+
22+
:program:`install_compass` is a platform-specific installation script
23+
for :ref:`MongoDB Compass Community Edition <compass-index>`.
24+
25+
Installation
26+
------------
27+
28+
Linux / MacOS
29+
~~~~~~~~~~~~~
30+
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:
34+
35+
.. class:: copyable-code
36+
.. code-block:: sh
37+
38+
python install_compass
39+
40+
Windows
41+
~~~~~~~
42+
43+
On Windows systems, the ``install_compass`` script is a PowerShell
44+
script included in the the MongoDB Server archive download.
45+
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:
49+
50+
.. class:: copyable-code
51+
.. code-block:: none
52+
53+
powershell .\Install-Compass.ps1
54+

source/release-notes/3.6.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -483,6 +483,15 @@ Sharded Clusters
483483
General Enhancements
484484
--------------------
485485

486+
MongoDB Compass Packaging
487+
~~~~~~~~~~~~~~~~~~~~~~~~~
488+
489+
The MongoDB Server download is packaged with a platform-specific
490+
:doc:`installation script </reference/program/install_compass>` for
491+
:ref:`MongoDB Compass Community Edition <compass-index>`. This
492+
script installs MongoDB Compass as part of the MongoDB Server
493+
installation process.
494+
486495
Collection Identifier
487496
~~~~~~~~~~~~~~~~~~~~~
488497

source/tutorial/install-mongodb-enterprise-on-windows.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ support for several features related to security and monitoring.
2424

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

27-
2827
Prerequisites
2928
-------------
3029

0 commit comments

Comments
 (0)