install_compass

New in version 3.6.

Synopsis

install_compass (Install-Compass in Windows) is aplatform-specific installation script forMongoDB Compass.

If downloaded as a part of theMongoDB Enterprise Serverpackage, the install_compass script installs the standard editionof MongoDB Compass.

If downloaded as part of theMongoDB Community Serverpackage, the install_compass script installsMongoDB Compass Community edition.

Installation

Note

The install_compass script first removes and replaces anypreviously installed versions of the same MongoDB Compass edition (eitherMongoDB Compass or MongoDB Compass Community).

Example

If you run the install_compass script installed as part ofMongoDB Community Server 3.6, the script removes any installedversions of MongoDB Compass Community and installs a compatibleversion of Compass Community.

Linux / macOS

On Linux and macOS platforms the install_compass script is a Unixexecutable script included in the MongoDB Server download. The scriptis packaged with the download for each platform.

  • Change to the bin directory under the MongoDB Serverdownload directory:
  1. cd <installDirectory>/bin
  • Install MongoDB Compass using the install_compass script:
  1. ./install_compass

Windows

On Windows platforms the Install-Compass script is a PowerShellscript 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 Serverdownload directory:
  1. cd <installDirectory>\bin
  • Install MongoDB Compass using the install_compass script:
  1. powershell .\Install-Compass.ps1

Alternatively, if using the .msi installer for MongoDB Server forWindows, during installation you are presented with a checkboxindicating whether to install MongoDB Compass with MongoDB server. Ifchecked, the installer automatically executes the install_compassscript.