/ /

`install_compass`

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB.

New in version 3.6.

Synopsis

install_compass (Install-Compass in Windows) is a platform-specific installation script for MongoDB Compass.

If downloaded as a part of the MongoDB Enterprise Server package, the install_compass script installs the standard edition of MongoDB Compass.

If downloaded as part of the MongoDB Community Server package, the install_compass script installs MongoDB Compass Community edition.

Installation

Note

The install_compass script first removes and replaces any previously installed versions of the same MongoDB Compass edition (either MongoDB Compass or MongoDB 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 MongoDB Compass Community and installs a compatible version of Compass Community.

Linux / macOS

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.

Change to the bin directory under the MongoDB Server download directory:
```
cd <installDirectory>/bin
```
Install MongoDB Compass using the install_compass script:
```
./install_compass
```

Windows

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:

Change to the bin directory under the MongoDB Server download directory:
```
cd <installDirectory>\bin
```
Install MongoDB Compass using the install_compass script:
```
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 MongoDB Compass with MongoDB server. If checked, the installer automatically executes the install_compass script.

Back

mongofiles

Configuration File Options