|
| 1 | +.. _compass-kerberos-password: |
| 2 | + |
| 3 | +=================================== |
| 4 | +Display the Kerberos Password Field |
| 5 | +=================================== |
| 6 | + |
| 7 | +.. default-domain:: mongodb |
| 8 | + |
| 9 | +.. contents:: On this page |
| 10 | + :local: |
| 11 | + :backlinks: none |
| 12 | + :depth: 2 |
| 13 | + :class: singlecol |
| 14 | + |
| 15 | +If you use :manual:`Kerberos authentication </core/kerberos/>` to connect to |
| 16 | +your MongoDB deployment, you can enable the ``showKerberosPasswordField`` |
| 17 | +option on |compass|. |
| 18 | + |
| 19 | +About This Task |
| 20 | +--------------- |
| 21 | + |
| 22 | +The password field is not necessary for Kerberos authentication, so |
| 23 | +|compass-short| disables the ``showKerberosPasswordField`` option by default. |
| 24 | + |
| 25 | +If you enable the ``showKerberosPasswordField``, |compass| displays the |
| 26 | +:guilabel:`Provide password directly` option, which contains the |
| 27 | +:guilabel:`Password` field. You can find the Kerberos :guilabel:`Password` |
| 28 | +under the :guilabel:`Advanced Connection Options > Authentication` tab on the |
| 29 | +|compass-short| connection form. |
| 30 | + |
| 31 | +Procedure |
| 32 | +--------- |
| 33 | + |
| 34 | +You can enable the ``showKerberosPasswordField`` option in either: |
| 35 | + |
| 36 | +- The |compass-short| :ref:`Settings panel <compass-settings-reference>`. |
| 37 | + |
| 38 | +- The :ref:`command line <cli-options>`. |
| 39 | + |
| 40 | +- A :ref:`configuration file <config-file>`. |
| 41 | + |
| 42 | +|compass-short| Settings Panel |
| 43 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 44 | + |
| 45 | +.. procedure:: |
| 46 | + :style: normal |
| 47 | + |
| 48 | + .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. |
| 49 | + |
| 50 | + .. figure:: /images/compass/settings-panel-location.png |
| 51 | + :scale: 60% |
| 52 | + :alt: Settings panel location under the MongoDB Compass system menu |
| 53 | + |
| 54 | + Alternatively, you can use keyboard shortcuts to open the |
| 55 | + :guilabel:`Settings` panel: |
| 56 | + |
| 57 | + - Windows or Linux: ``Ctrl`` + ``,`` |
| 58 | + |
| 59 | + - MacOS: ``⌘`` + ``,`` |
| 60 | + |
| 61 | + .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`. |
| 62 | + |
| 63 | + |compass-short| opens a dialog box where you can configure your |compass| |
| 64 | + settings. |
| 65 | + |
| 66 | + .. step:: Toggle :guilabel:`Show Kerberos Password Field`. |
| 67 | + |
| 68 | + .. step:: Click :guilabel:`Save`. |
| 69 | + |
| 70 | +Command Line |
| 71 | +~~~~~~~~~~~~ |
| 72 | + |
| 73 | +The following command starts |compass-short| from the command line and sets |
| 74 | +the ``--showKerberosPasswordField`` option: |
| 75 | + |
| 76 | +.. code-block:: sh |
| 77 | + |
| 78 | + <path-to-Compass-executable> --readOnly |
| 79 | + |
| 80 | +.. note:: |
| 81 | + |
| 82 | + The name and filepath of the |compass-short| executable depend on your |
| 83 | + operating system. |
| 84 | + |
| 85 | +Configuration File |
| 86 | +~~~~~~~~~~~~~~~~~~ |
| 87 | + |
| 88 | +You can specify the |compass-short| configuration file in either EJSON |
| 89 | +or YAML format. The following configurations set the |
| 90 | +``showKerberosPasswordField`` option to ``true``: |
| 91 | + |
| 92 | +EJSON |
| 93 | +````` |
| 94 | + |
| 95 | +.. code-block:: json |
| 96 | + |
| 97 | + { "showKerberosPasswordField": true } |
| 98 | + |
| 99 | +YAML |
| 100 | +```` |
| 101 | + |
| 102 | +.. code-block:: yaml |
| 103 | + |
| 104 | + showKerberosPasswordField: true |
| 105 | + |
| 106 | +Learn More |
| 107 | +---------- |
| 108 | + |
| 109 | +To learn more about the |compass| configuration file, see |
| 110 | +:ref:`config-file`. |
| 111 | + |
0 commit comments