Docs Home → View & Analyze Data → MongoDB Compass
Restrict Write Operations to MongoDB
You can use the readOnly option to prevent users from performing write
operations to your MongoDB deployment through Compass. If you enable the
readOnly option, users cannot modify documents, create indexes, or specify
validation rules.
About This Task
By default, Compass disables the readOnly option.
If the readOnly option is enabled, you cannot enable the following options:
Procedure
You can enable the readOnly option in either:
The Compass Settings panel
The command line
Compass Settings Panel
In the Compass top menu bar, click MongoDB Compass.
Alternatively, you can use keyboard shortcuts to open the Settings panel:
Windows / Linux:
Ctrl+,Mac:
⌘+,
In the MongoDB Compass menu, click Settings.
Compass opens a dialog box where you can configure your MongoDB Compass settings.
Toggle Set Read-Only Mode.
Click Save.
Command Line
The following command starts Compass from the command line and sets
the --readOnly option:
<path-to-Compass-executable> --readOnly
Note
The name and filepath of the Compass executable depend on your operating system.
Configuration File
You can specify the Compass configuration file in either EJSON
or YAML format. The following configurations set the
readOnly option to true:
EJSON
{ "readOnly": true }
YAML
readOnly: true
Learn More
To learn more about the MongoDB Compass configuration file, see Configuration File Settings.