configuration-options.txt

==========================
Configuration File Options
==========================

.. default-domain:: mongodb

.. versionchanged:: 2.6
   MongoDB introduces a YAML-based configuration file format.
   The :v2.4:`2.4 configuration file format
   </reference/configuration-options>` remains for backward
   compatibility.

Overview
--------

You can control :program:`mongod` and :program:`mongos` instances at
runtime using a configuration file. The configuration file contains
settings that are functionally equivalent to the :program:`mongod` and
:program:`mongos` command-line arguments but are easier to manage,
especially on large-scale deployments. Configuration files allow
commenting to describe the reasoning behind a server's settings.

If you installed from a package and have started MongoDB using
your system's :term:`control script`, you are already using a configuration
file.

Specifying the Configuration File when Starting MongoDB
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To start :program:`mongod` or :program:`mongos` using a config file,
specify the config file with the :option:`--config` option.

For example, the following specifies a config file for a
:program:`mongod`:

.. code-block:: sh

   mongod --config /etc/mongodb.conf

The following specifies a config file for a :program:`mongos` using the
``-f`` alias:

.. code-block:: sh

   mongos -f /etc/mongodb.conf

Config File Format
~~~~~~~~~~~~~~~~~~

The configuration file is in `YAML <http://www.yaml.org>`_ format.
The following is an example of several settings in a configuration file:

.. code-block:: yaml

   systemLog:
      destination: file
      path: "/var/log/mongodb/mongodb.log"
      quiet: true
      logAppend: true
   storage:
      journal:
         enabled: true
   processManagement:
      fork: true
   net:
      bindIp: 127.0.0.1
      port: 27017
   ...

Settings
--------

Core Options
~~~~~~~~~~~~

.. setting:: systemLog

.. include:: /includes/option/setting-conf-systemLog.verbosity.rst

.. include:: /includes/option/setting-conf-systemLog.quiet.rst

.. include:: /includes/option/setting-conf-systemLog.traceAllExceptions.rst

.. include:: /includes/option/setting-conf-systemLog.syslogFacility.rst

.. include:: /includes/option/setting-conf-systemLog.path.rst

.. include:: /includes/option/setting-conf-systemLog.logAppend.rst

.. include:: /includes/option/setting-conf-systemLog.destination.rst

.. include:: /includes/option/setting-conf-systemLog.timeStampFormat.rst

.. setting:: processManagement

.. include:: /includes/option/setting-conf-processManagement.pidFilePath.rst

.. include:: /includes/option/setting-conf-processManagement.fork.rst

.. setting:: net

.. include:: /includes/option/setting-conf-net.port.rst

.. include:: /includes/option/setting-conf-net.bindIp.rst

.. include:: /includes/option/setting-conf-net.maxIncomingConnections.rst

.. include:: /includes/option/setting-conf-net.wireObjectCheck.rst

.. include:: /includes/option/setting-conf-net.http.enabled.rst

.. PENDING SERVER-13097

   .. include:: /includes/option/setting-conf-net.http.port.rst

.. include:: /includes/option/setting-conf-net.unixDomainSocket.enabled.rst

.. include:: /includes/option/setting-conf-net.unixDomainSocket.pathPrefix.rst

.. include:: /includes/option/setting-conf-net.ipv6.rst

.. include:: /includes/option/setting-conf-net.http.JSONPEnabled.rst

.. include:: /includes/option/setting-conf-net.http.RESTInterfaceEnabled.rst

.. include:: /includes/option/setting-conf-net.ssl.sslOnNormalPorts.rst

.. include:: /includes/option/setting-conf-net.ssl.mode.rst

.. include:: /includes/option/setting-conf-net.ssl.PEMKeyFile.rst

.. include:: /includes/option/setting-conf-net.ssl.PEMKeyPassword.rst

.. include:: /includes/option/setting-conf-net.ssl.clusterFile.rst

.. include:: /includes/option/setting-conf-net.ssl.clusterPassword.rst

.. include:: /includes/option/setting-conf-net.ssl.CAFile.rst

.. include:: /includes/option/setting-conf-net.ssl.CRLFile.rst

.. include:: /includes/option/setting-conf-net.ssl.weakCertificateValidation.rst

.. include:: /includes/option/setting-conf-net.ssl.allowInvalidCertificates.rst

.. include:: /includes/option/setting-conf-net.ssl.FIPSMode.rst

.. include:: /includes/option/setting-conf-setParameter.rst

.. setting:: security

.. include:: /includes/option/setting-conf-security.keyFile.rst

.. include:: /includes/option/setting-conf-security.clusterAuthMode.rst

.. include:: /includes/option/setting-conf-security.authorization.rst

.. Hide non-operative options pending SERVER-12892

   .. include: /includes/option/setting-conf-security.authenticationMechanisms.rst
   .. include: /includes/option/setting-conf-security.authSchemaVersion.rst
   .. include: /includes/option/setting-conf-security.enableLocalhostAuthBypass.rst
   .. include: /includes/option/setting-conf-security.supportCompatibilityFormPrivilegeDocuments.rst

.. include:: /includes/option/setting-conf-security.sasl.hostName.rst

.. include:: /includes/option/setting-conf-security.sasl.serviceName.rst

.. include:: /includes/option/setting-conf-security.sasl.saslauthdSocketPath.rst

.. include:: /includes/option/setting-conf-security.javascriptEnabled.rst

.. setting:: operationProfiling

.. include:: /includes/option/setting-conf-operationProfiling.slowOpThresholdMs.rst

.. include:: /includes/option/setting-conf-operationProfiling.mode.rst

.. setting:: storage

.. include:: /includes/option/setting-conf-storage.dbPath.rst

.. include:: /includes/option/setting-conf-storage.directoryPerDB.rst

.. include:: /includes/option/setting-conf-storage.indexBuildRetry.rst

.. include:: /includes/option/setting-conf-storage.preallocDataFiles.rst

.. include:: /includes/option/setting-conf-storage.nsSize.rst

.. include:: /includes/option/setting-conf-storage.quota.enforced.rst

.. include:: /includes/option/setting-conf-storage.quota.maxFilesPerDB.rst

.. include:: /includes/option/setting-conf-storage.smallFiles.rst

.. include:: /includes/option/setting-conf-storage.syncPeriodSecs.rst

.. include:: /includes/option/setting-conf-storage.repairPath.rst

.. include:: /includes/option/setting-conf-storage.journal.enabled.rst

.. include:: /includes/option/setting-conf-storage.journal.debugFlags.rst

.. include:: /includes/option/setting-conf-storage.journal.commitIntervalMs.rst

.. setting:: replication

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

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

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

.. setting:: sharding

.. include:: /includes/option/setting-conf-sharding.clusterRole.rst

.. include:: /includes/option/setting-conf-sharding.archiveMovedChunks.rst

.. setting:: auditLog

.. include:: /includes/option/setting-conf-auditLog.destination.rst

.. include:: /includes/option/setting-conf-auditLog.format.rst

.. include:: /includes/option/setting-conf-auditLog.path.rst

.. include:: /includes/option/setting-conf-auditLog.filter.rst

.. setting:: snmp

.. include:: /includes/option/setting-conf-snmp.subagent.rst

.. include:: /includes/option/setting-conf-snmp.master.rst

``mongos``\ -only Options
~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. include:: /includes/option/setting-conf-sharding.autoSplit.rst

.. include:: /includes/option/setting-conf-sharding.configDB.rst

.. include:: /includes/option/setting-conf-sharding.chunkSize.rst

Windows Service Options
~~~~~~~~~~~~~~~~~~~~~~~

.. include:: /includes/option/setting-conf-processManagement.windowsService.serviceName.rst

.. include:: /includes/option/setting-conf-processManagement.windowsService.displayName.rst

.. include:: /includes/option/setting-conf-processManagement.windowsService.description.rst

.. include:: /includes/option/setting-conf-processManagement.windowsService.serviceUser.rst

.. include:: /includes/option/setting-conf-processManagement.windowsService.servicePassword.rst