Skip to content

DOCS-4662: Note that YAML is a superset of JSON #2340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions source/reference/configuration-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,10 @@ File Format

.. versionchanged:: 2.6

The configuration file is in `YAML <http://www.yaml.org>`_ format. For
example, the following contains various
:program:`mongod` configuration settings in YAML format:
MongoDB configuration files use the `YAML <http://www.yaml.org>`_ format
[#yaml-json]_.
The following example configuration file contains several
:program:`mongod` settings:

.. note::

Expand All @@ -63,6 +64,9 @@ example, the following contains various
enableLocalhostAuthBypass: false
...

.. [#yaml-json] YAML is a superset of :term:`JSON` with syntax that is easier to
edit by hand.

Use the Configuration File
~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -110,7 +114,7 @@ Core Options
logRotate: <string>
destination: <string>
timeStampFormat: <string>
component:
component:
accessControl:
verbosity: <int>
command:
Expand Down Expand Up @@ -142,7 +146,7 @@ Core Options
.. code-block:: yaml

systemLog:
component:
component:
accessControl:
verbosity: <int>
command:
Expand Down Expand Up @@ -502,7 +506,7 @@ Core Options
replication:
oplogSizeMB: <int>
replSetName: <string>
secondaryIndexPrefetch: <string>
secondaryIndexPrefetch: <string>

.. include:: /includes/option/setting-conf-replication.oplogSizeMB.rst

Expand Down Expand Up @@ -584,7 +588,7 @@ Windows Service Options
.. code-block:: yaml

processManagement:
windowsService:
windowsService:
serviceName: <string>
displayName: <string>
description: <string>
Expand Down