DOCSP-26520 readOnly Settings (#479)

* DOCSP-26520 readOnly Settings

* add to TOC

* add default behavior

* JA edits

* typo fix

* add ref link

Author: ajhuh-mdb

source/settings.txt

@@ -43,6 +43,8 @@ Tasks
 
 - :ref:`compass-protect-connection-strings`
 
+- :ref:`compass-read-only`
+
 - :ref:`compass-force-connection-options`
 
 - :ref:`compass-enable-dev-tools`
@@ -64,5 +66,6 @@ Learn more
    /settings/config-file
    /settings/restrict-outgoing-connections
    /settings/protect-connection-strings
+   /settings/read-only
    /settings/specify-read-preference-tags
    /settings/enable-dev-tools

source/settings/read-only.txt

@@ -0,0 +1,110 @@
+.. _compass-read-only:
+
+====================================
+Restrict Write Operations to MongoDB
+====================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+You can use the ``readOnly`` option to prevent users from performing write 
+operations to your MongoDB deployment through |compass-short|. If you enable the 
+``readOnly`` option, users cannot modify documents, create indexes, or specify 
+validation rules.
+
+About This Task 
+---------------
+
+By default, |compass-short| disables the ``readOnly`` option.
+
+If the ``readOnly`` option is enabled, you cannot enable the following options: 
+
+- :ref:`enableShell <embedded-mongodb-shell>`
+- :ref:`enableDevtools <compass-enable-dev-tools>`
+
+Procedure
+---------
+
+You can enable the ``readOnly`` option in either: 
+
+- The |compass-short| :ref:`Settings panel <compass-settings-reference>`
+
+- The :ref:`command line <cli-options>`
+
+- A :ref:`configuration file <config-file>`
+
+|compass-short| Settings Panel
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. procedure:: 
+   :style: normal
+   
+   .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. 
+
+      .. figure:: /images/compass/settings-panel-location.png
+         :scale: 60% 
+         :alt: Settings panel location under the MongoDB Compass system menu
+      
+      Alternatively, you can use keyboard shortcuts to open the 
+      :guilabel:`Settings` panel: 
+      
+      - Windows / Linux: ``Ctrl`` + ``,``
+      
+      - Mac: ``⌘`` + ``,``
+
+   .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`.
+
+      |compass-short| opens a dialog box where you can configure your |compass| 
+      settings.
+
+   .. step:: Toggle :guilabel:`Set Read-Only Mode`.
+
+   .. step:: Click :guilabel:`Save`.
+
+Command Line
+~~~~~~~~~~~~
+
+The following command starts |compass-short| from the command line and sets
+the ``--readOnly`` option:
+
+.. code-block:: sh
+
+   <path-to-Compass-executable> --readOnly
+
+.. note::
+
+  The name and filepath of the |compass-short| executable depend on your
+  operating system.
+
+Configuration File
+~~~~~~~~~~~~~~~~~~
+
+You can specify the |compass-short| configuration file in either EJSON
+or YAML format. The following configurations set the 
+``readOnly`` option to ``true``:
+
+EJSON
+`````
+
+.. code-block:: json
+
+   { "readOnly": true }
+
+YAML
+````
+
+.. code-block:: yaml
+
+   readOnly: true
+
+Learn More
+----------
+
+To learn more about the |compass| configuration file, see
+:ref:`config-file`.
+

source/settings/settings-reference.txt

@@ -54,6 +54,8 @@ You can configure the following settings on the |compass| interface:
      - General
      - Remove all write and delete capabilities on |compass-short|. 
 
+       To learn more, see :ref:`compass-read-only`.
+
    * - Enable MongoDB Shell
      - General
      - Enable or disable the embedded MongoDB Shell on |compass-short|.