www.mongodb.com Open in urlscan Pro
2600:9000:2490:9e00:7:7859:3840:93a1 Public Scan

Back to summary

Submitted URL:
http://docs.mongodb.org/manual/reference/configuration-options/
Effective URL:
https://www.mongodb.com/docs/manual/reference/configuration-options/
Submission: On January 23 via api (January 23rd 2024, 6:35:43 pm UTC) from US — Scanned from DE

Form analysis
1 forms found in the DOM

GET https://mongodb.com/docs/search/

<form role="search" method="GET" action="https://mongodb.com/docs/search/" class="css-1c69emu">
  <div class="css-1q5aj3">
    <div class="css-36i4c2"><input type="text" placeholder="Search all documentation..." class="css-etrcff" value=""></div>
    <div class="css-1hc92ka">
      <div class="css-aef77t"><button role="button" type="button" class="css-14k7wrz"><span data-testid="selected-value" class="css-6k4l2y">All Documentation</span>
          <div class="css-109dpaz"><svg data-testid="icon" width="16" height="9" viewBox="0 0 16 9" fill="none" xmlns="http://www.w3.org/2000/svg" class="css-1yzkxhp">
              <path d="M1.06689 0.799988L8.00023 7.73332L14.9336 0.799988" stroke-linecap="round" stroke-linejoin="round" class="css-1tlq8q9"></path>
            </svg></div>
        </button>
        <div class="css-hn9qqo">
          <ul data-testid="options" role="listbox" class="css-ac9zo2">
            <li role="option" tabindex="0" class="css-11dtrvq">General Information</li>
            <li role="option" tabindex="0" class="css-11dtrvq">All Documentation</li>
            <li role="option" tabindex="0" class="css-11dtrvq">Realm Documentation</li>
            <li role="option" tabindex="0" class="css-11dtrvq">Developer Articles &amp; Topics</li>
            <li role="option" tabindex="0" class="css-11dtrvq">Community Forums</li>
            <li role="option" tabindex="0" class="css-11dtrvq">Blog</li>
            <li role="option" tabindex="0" class="css-11dtrvq">University</li>
          </ul>
        </div>
      </div><input type="hidden" id="q" name="q" value="">
      <div class="css-1myrko"><button type="submit" tabindex="0" class=" css-13l1z36" data-track="true"><img alt="search icon" src="https://webimages.mongodb.com/_com_assets/cms/krc3hljsdwdfd2w5d-web-actions-search.svg?auto=format%252Ccompress"
            class="css-r9fohf"></button></div>
    </div>
  </div>
</form>

Text Content

All Documentation

* General Information
* All Documentation
* Realm Documentation
* Developer Articles & Topics
* Community Forums
* Blog
* University

* Products
Platform
AtlasBuild on a developer data platform
Platform Services
DatabaseDeploy a multi-cloud databaseSearchDeliver engaging search
experiencesVector SearchDesign intelligent apps with GenAIStream Processing
(Preview)Unify data in motion and data at rest
Tools
CompassWork with MongoDB data in a GUIIntegrationsIntegrations with
third-party servicesRelational MigratorMigrate to MongoDB with confidence
Self Managed
Enterprise AdvancedRun and manage MongoDB yourselfCommunity EditionDevelop
locally with MongoDB
Build with MongoDB Atlas
Get started for free in minutes
Sign Up
Test Enterprise Advanced
Develop with MongoDB on-premises
Download
Try Community Edition
Explore the latest version of MongoDB
Download
* Resources
Documentation
Atlas DocumentationGet started using AtlasServer DocumentationLearn to use
MongoDBStart With GuidesGet step-by-step guidance for key tasks

Tools and ConnectorsLearn how to connect to MongoDBMongoDB DriversUse drivers
and libraries for MongoDB
AI Resources HubGet help building the next big thing in AI with
MongoDBarrow-right
Connect
Developer CenterExplore a wide range of developer resourcesCommunityJoin a
global community of developersCourses and CertificationLearn for free from
MongoDBWebinars and EventsFind a webinar or event near you
* Solutions
Use cases
Artificial IntelligenceEdge ComputingInternet of
ThingsMobilePaymentsServerless Development
Industries
Financial ServicesTelecommunicationsHealthcareRetailPublic
SectorManufacturing
Solutions LibraryOrganized and tailored solutions to kick-start
projectsarrow-right
Developer Data Platform
Accelerate innovation at scale
Learn morearrow-right
Startups and AI Innovators
For world-changing ideas and AI pioneers
Learn morearrow-right
Customer Case Studies
Hear directly from our users
See Storiesarrow-right
* Company
CareersStart your next adventureBlogRead articles and
announcementsNewsroomRead press releases and news stories
PartnersLearn about our partner ecosystemLeadershipMeet our executive
teamCompanyLearn more about who we are
Contact Us
Reach out to MongoDB
Let’s chatarrow-right
Investors
Visit our investor portal
Learn morearrow-right
* Pricing

SupportSign In
Try Free
menu-vertical

Docs Menu

MongoDB Documentation

--------------------------------------------------------------------------------

Back to Develop Applications
* MongoDB Manual
7.0 (current)
* Introduction
* Installation
* MongoDB Shell (mongosh)
* MongoDB CRUD Operations
* Aggregation Operations
* Data Modeling
* Indexes
* Security
* Replication
* Sharding
* Change Streams
* Time Series
* Transactions
* Administration
* Storage
* Frequently Asked Questions
* Reference
* Collation
* Configuration File Options
* Externally Sourced Configuration File Values
* Convert Command-Line Options to YAML
* Configuration File Settings and Command-Line Options Mapping
* Connection Strings
* Database Commands
* Default MongoDB Port
* Default MongoDB Read Concerns/Write Concerns
* Exit Codes and Statuses
* Error Codes
* Explain Results
* Glossary
* Log Messages
* MongoDB Cluster Parameters
* MongoDB Limits and Thresholds
* MongoDB Package Components
* MongoDB Server Parameters
* MongoDB Wire Protocol
* mongosh Methods
* Operators
* Server Sessions
* Slot-Based Query Execution Engine
* Stable API
* System Collections
* Legacy mongo Shell
* Release Notes
* Technical Support

Docs Home → Develop Applications → MongoDB Manual

CONFIGURATION FILE OPTIONS

On this page

* Configuration File
* File Format
* Use the Configuration File
* Core Options
* systemLog Options
* processManagement Options
* net Options
* security Options
* setParameter Option
* storage Options
* operationProfiling Options
* replication Options
* sharding Options
* auditLog Options
* mongos -only Options
* Windows Service Options
* Removed MMAPv1 Options

The following page describes the configuration options available in MongoDB 7.0.
For configuration file options for other versions of MongoDB, see the
appropriate version of the MongoDB Manual.

NOTE

If you're using MongoDB Atlas to manage your MongoDB deployments in the cloud,
you don't need to create a configuration file. To learn how to configure
settings for your MongoDB Atlas deployment, see Configure Additional Settings.

CONFIGURATION FILE

You can configure mongod and mongos instances at startup using a configuration
file. The configuration file contains settings that are equivalent to the mongod
and mongos command-line options. See Configuration File Settings and
Command-Line Options Mapping.

Using a configuration file makes managing mongod and mongos options easier,
especially for large-scale deployments. You can also add comments to the
configuration file to explain the server's settings.

* If you installed MongoDB with a package manager such as yum or apt on Linux
or brew on macOS, or with the MSI installer on Windows, a default
configuration file has been provided as part of your installation:

Platform
Method
Configuration File
Linux
apt, yum, or zypper Package Manager
/etc/mongod.conf
macOS
brew Package Manager

/usr/local/etc/mongod.conf (on Intel processors), or

/opt/homebrew/etc/mongod.conf (on Apple M1 processors)

Windows
MSI Installer
<install directory>\bin\mongod.cfg

* If you installed MongoDB via a downloaded TGZ or ZIP file, you will need to
create your own configuration file. The basic example configuration is a good
place to start.

FILE FORMAT

MongoDB configuration files use the YAML format [1].

The following sample configuration file contains several mongod settings that
you may adapt to your local configuration:

NOTE

YAML does not support tab characters for indentation: use spaces instead.

systemLog: destination: file path: "/var/log/mongodb/mongod.log" logAppend: trueprocessManagement: fork: truenet: bindIp: 127.0.0.1 port: 27017setParameter: enableLocalhostAuthBypass: false...

The Linux package init scripts included in the official MongoDB packages depend
on specific values for systemLog.path, storage.dbPath, and
processManagement.fork. If you modify these settings in the default
configuration file, mongod may not start.

[1] YAML is a superset of JSON.

EXTERNALLY SOURCED VALUES

New in version 4.2: MongoDB supports using expansion directives in configuration
files to load externally sourced values. Expansion directives can load values
for specific configuration file options or load the entire configuration file.

The following expansion directives are available:

Expansion Directive
Description
__rest

Allows users to specify a REST endpoint as the external source for configuration
file options or the full configuration file.

If the configuration file includes the __rest expansion, on Linux/macOS, the
read access to the configuration file must be limited to the user running the
mongod / mongos process only.

__exec

Allows users to specify a shell or terminal command as the external source for
configuration file options or the full configuration file.

If the configuration file includes the __exec expansion, on Linux/macOS, the
write access to the configuration file must be limited to the user running the
mongod / mongos process only.

For complete documentation, see Externally Sourced Configuration File Values.

USE THE CONFIGURATION FILE

To configure mongod or mongos using a config file, specify the config file with
the --config option or the -f option, as in the following examples:

For example, the following uses mongod --config <configuration file> mongos
--config <configuration file>:

mongod --config /etc/mongod.conf
mongos --config /etc/mongos.conf

You can also use the -f alias to specify the configuration file, as in the
following:

mongod -f /etc/mongod.conf
mongos -f /etc/mongos.conf

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

EXPANSION DIRECTIVES AND --CONFIGEXPAND

If you are using expansion directives in the configuration file, you must
include the --configExpand option when starting the mongod or mongos. For
example:

mongod --config /etc/mongod.conf --configExpand "rest,exec"mongos --config /etc/mongos.conf --configExpand "rest,exec"

If the configuration file includes an expansion directive and you start the
mongod / mongos without specifying that directive in the --configExpand option,
the mongod / mongos fails to start.

For complete documentation, see Externally Sourced Configuration File Values.

CORE OPTIONS

SYSTEMLOG OPTIONS

systemLog: verbosity: <int> quiet: <boolean> traceAllExceptions: <boolean> syslogFacility: <string> path: <string> logAppend: <boolean> logRotate: <string> destination: <string> timeStampFormat: <string> component: accessControl: verbosity: <int> command: verbosity: <int>
# COMMENT additional component verbosity settings omitted for brevity

systemLog.verbosity

Type: integer

Default: 0

The default log message verbosity level for components. The verbosity level
determines the amount of Informational and Debug messages MongoDB outputs. [2]

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

To use a different verbosity level for a named component, use the component's
verbosity setting. For example, use the
systemLog.component.accessControl.verbosity to set the verbosity level
specifically for ACCESS components.

See the systemLog.component.<name>.verbosity settings for specific component
verbosity settings.

For various ways to set the log verbosity level, see Configure Log Verbosity
Levels.

[2] Starting in version 4.2, MongoDB includes the Debug verbosity level (1-5) in
the log messages. For example, if the verbosity level is 2, MongoDB logs D2. In
previous versions, MongoDB log messages only specified D for Debug level.

systemLog.quiet

Type: boolean

Default: false

Run mongos or mongod in a quiet mode that attempts to limit the amount of
output.

systemLog.quiet is not recommended for production systems as it may make
tracking problems during particular connections much more difficult.

systemLog.traceAllExceptions

Type: boolean

Default: false

Print verbose information for debugging. Use for additional logging for
support-related troubleshooting.

systemLog.syslogFacility

Type: string

Default: user

The facility level used when logging messages to syslog. The value you specify
must be supported by your operating system's implementation of syslog. To use
this option, you must set systemLog.destination to syslog.

systemLog.path

Type: string

The path of the log file to which mongod or mongos should send all diagnostic
logging information, rather than the standard output or the host's syslog.
MongoDB creates the log file at the specified path.

The Linux package init scripts do not expect systemLog.path to change from the
defaults. If you use the Linux packages and change systemLog.path, you will have
to use your own init scripts and disable the built-in scripts.

systemLog.logAppend

Type: boolean

Default: false

When true, mongos or mongod appends new entries to the end of the existing log
file when the mongos or mongod instance restarts. Without this option, mongod
will back up the existing log and create a new file.

systemLog.logRotate

Type: string

Default: rename

Determines the behavior for the logRotate command when rotating the server log
and/or the audit log. Specify either rename or reopen:

* rename renames the log file.

* reopen closes and reopens the log file following the typical Linux/Unix log
rotate behavior. Use reopen when using the Linux/Unix logrotate utility to
avoid log loss.

If you specify reopen, you must also set systemLog.logAppend to true.

systemLog.destination

Type: string

The destination to which MongoDB sends all log output. Specify either file or
syslog. If you specify file, you must also specify systemLog.path.

If you do not specify systemLog.destination, MongoDB sends all log output to
standard output.

WARNING

The syslog daemon generates timestamps when it logs a message, not when MongoDB
issues the message. This can lead to misleading timestamps for log entries,
especially when the system is under heavy load. We recommend using the file
option for production systems to ensure accurate timestamps.

systemLog.timeStampFormat

Type: string

Default: iso8601-local

The time format for timestamps in log messages. Specify one of the following
values:

Value
Description
iso8601-utc
Displays timestamps in Coordinated Universal Time (UTC) in the ISO-8601 format.
For example, for New York at the start of the Epoch: 1970-01-01T00:00:00.000Z
iso8601-local
Displays timestamps in local time in the ISO-8601 format. For example, for New
York at the start of the Epoch: 1969-12-31T19:00:00.000-05:00

NOTE

Starting in MongoDB 4.4, systemLog.timeStampFormat no longer supports ctime. An
example of ctime formatted date is: Wed Dec 31 18:17:54.811.

SYSTEMLOG.COMPONENT OPTIONS

systemLog: component: accessControl: verbosity: <int> command: verbosity: <int>
# COMMENT some component verbosity settings omitted for brevity
replication: verbosity: <int> election: verbosity: <int> heartbeats: verbosity: <int> initialSync: verbosity: <int> rollback: verbosity: <int> storage: verbosity: <int> journal: verbosity: <int> recovery: verbosity: <int> write: verbosity: <int>

NOTE

Starting in version 4.2, MongoDB includes the Debug verbosity level (1-5) in the
log messages. For example, if the verbosity level is 2, MongoDB logs D2. In
previous versions, MongoDB log messages only specified D for Debug level.

systemLog.component.accessControl.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to access control. See
ACCESS components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.command.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to commands. See COMMAND
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.control.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to control operations.
See CONTROL components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.ftdc.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to diagnostic data
collection operations. See FTDC components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.geo.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to geospatial parsing
operations. See GEO components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.index.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to indexing operations.
See INDEX components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.network.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to networking operations.
See NETWORK components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.query.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to query operations. See
QUERY components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to replication. See REPL
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.election.verbosity

Type: integer

Default: 0

New in version 4.2.

The log message verbosity level for components related to election. See ELECTION
components.

If systemLog.component.replication.election.verbosity is unset,
systemLog.component.replication.verbosity level also applies to election
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.heartbeats.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to heartbeats. See
REPL_HB components.

If systemLog.component.replication.heartbeats.verbosity is unset,
systemLog.component.replication.verbosity level also applies to heartbeats
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.initialSync.verbosity

Type: integer

Default: 0

New in version 4.2.

The log message verbosity level for components related to initialSync. See
INITSYNC components.

If systemLog.component.replication.initialSync.verbosity is unset,
systemLog.component.replication.verbosity level also applies to initialSync
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.rollback.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to rollback. See ROLLBACK
components.

If systemLog.component.replication.rollback.verbosity is unset,
systemLog.component.replication.verbosity level also applies to rollback
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.sharding.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to sharding. See SHARDING
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to storage. See STORAGE
components.

If systemLog.component.storage.journal.verbosity is unset,
systemLog.component.storage.verbosity level also applies to journaling
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.journal.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to journaling. See
JOURNAL components.

If systemLog.component.storage.journal.verbosity is unset, the journaling
components have the same verbosity level as the parent storage components: i.e.
either the systemLog.component.storage.verbosity level if set or the default
verbosity level.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.recovery.verbosity

Type: integer

Default: 0

New in version 4.0.

The log message verbosity level for components related to recovery. See RECOVERY
components.

If systemLog.component.storage.recovery.verbosity is unset,
systemLog.component.storage.verbosity level also applies to recovery components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity level for components related to the WiredTiger storage
engine. See WT components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtBackup.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity level for components related to backup operations
performed by the WiredTiger storage engine. See WTBACKUP components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtCheckpoint.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to checkpoint operations
performed by the WiredTiger storage engine. See WTCHKPT components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtCompact.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to compaction operations
performed by the WiredTiger storage engine. See WTCMPCT components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtEviction.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to eviction operations
performed by the WiredTiger storage engine. See WTEVICT components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtHS.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to history store operations
performed by the WiredTiger storage engine. See WTHS components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtRecovery.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to recovery operations
performed by the WiredTiger storage engine. See WTRECOV components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtRTS.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to rollback to stable (RTS)
operations performed by the WiredTiger storage engine. See WTRTS components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtSalvage.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to salvage operations performed
by the WiredTiger storage engine. See WTSLVG components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtTiered.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to tiered storage operations
performed by the WiredTiger storage engine. See WTTIER components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtTimestamp.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to timestamps used by the
WiredTiger storage engine. See WTTS components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtTransaction.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to transaction operations
performed by the WiredTiger storage engine. See WTTXN components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtVerify.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to verification operations
performed by the WiredTiger storage engine. See WTVRFY components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtWriteLog.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to log write operations
performed by the WiredTiger storage engine. See WTWRTLOG components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.transaction.verbosity

Type: integer

Default: 0

New in version 4.0.2.

The log message verbosity level for components related to transaction. See TXN
components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.write.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to write operations. See
WRITE components.

The verbosity level can range from 0 to 5:

* 0 is the MongoDB's default log verbosity level, to include Informational
messages.

* 1 to 5 increases the verbosity level to include Debug messages.

PROCESSMANAGEMENT OPTIONS

processManagement: fork: <boolean> pidFilePath: <string> timeZoneInfo: <string>

processManagement.fork

Type: boolean

Default: false

Enable a daemon mode that runs the mongos or mongod process in the background.
By default mongos or mongod does not run as a daemon: typically you will run
mongos or mongod as a daemon, either by using processManagement.fork or by using
a controlling process that handles the daemonization process (e.g. as with
upstart and systemd).

The processManagement.fork option is not supported on Windows.

The Linux package init scripts do not expect processManagement.fork to change
from the defaults. If you use the Linux packages and change
processManagement.fork, you will have to use your own init scripts and disable
the built-in scripts.

processManagement.pidFilePath

Type: string

Specifies a file location to store the process ID (PID) of the mongos or mongod
process. The user running the mongod or mongos process must be able to write to
this path. If the processManagement.pidFilePath option is not specified, the
process does not create a PID file. This option is generally only useful in
combination with the processManagement.fork setting.

NOTE

LINUX

On Linux, PID file management is generally the responsibility of your distro's
init system: usually a service file in the /etc/init.d directory, or a systemd
unit file registered with systemctl. Only use the processManagement.pidFilePath
option if you are not using one of these init systems. For more information,
please see the respective Installation Guide for your operating system.

NOTE

MACOS

On macOS, PID file management is generally handled by brew. Only use the
processManagement.pidFilePath option if you are not using brew on your macOS
system. For more information, please see the respective Installation Guide for
your operating system.

processManagement.timeZoneInfo

Type: string

The full path from which to load the time zone database. If this option is not
provided, then MongoDB will use its built-in time zone database.

The configuration file included with Linux and macOS packages sets the time zone
database path to /usr/share/zoneinfo by default.

The built-in time zone database is a copy of the Olson/IANA time zone database.
It is updated along with MongoDB releases, but the time zone database release
cycle differs from the MongoDB release cycle. The most recent release of the
time zone database is available on our download site.

WARNING

MongoDB uses the third party timelib library to provide accurate conversions
between timezones. Due to a recent update, timelib could create inaccurate time
zone conversions in older versions of MongoDB.

To explicitly link to the time zone database in versions of MongoDB prior to
5.0, 4.4.7, and 4.2.14, download the time zone database. and use the
timeZoneInfo parameter.

NET OPTIONS

Changed in version 4.2: MongoDB 4.2 deprecates ssl options in favor of tls
options with identical functionality.

Changed in version 5.0: MongoDB removes the net.serviceExecutor configuration
option and the corresponding --serviceExecutor command-line option.

net: port: <int> bindIp: <string> bindIpAll: <boolean> maxIncomingConnections: <int> wireObjectCheck: <boolean> ipv6: <boolean> unixDomainSocket: enabled: <boolean> pathPrefix: <string> filePermissions: <int> tls: certificateSelector: <string> clusterCertificateSelector: <string> mode: <string> certificateKeyFile: <string> certificateKeyFilePassword: <string> clusterFile: <string> clusterPassword: <string> CAFile: <string> clusterCAFile: <string> clusterAuthX509: attributes: <string> extensionValue: <string> CRLFile: <string> allowConnectionsWithoutCertificates: <boolean> allowInvalidCertificates: <boolean> allowInvalidHostnames: <boolean> disabledProtocols: <string> FIPSMode: <boolean> logVersions: <string> compression: compressors: <string>

net.port

Type: integer

Default:

* 27017 for mongod (if not a shard member or a config server member) or mongos
instance

* 27018 if mongod is a shard member

* 27019 if mongod is a config server member

The TCP port on which the MongoDB instance listens for client connections.

Changed in version 7.0.3: The net.port option accepts a range of values between
0 and 65535. Setting the port to 0 configures mongos or mongod to use an
arbitrary port assigned by the operating system.

net.bindIp

Type: string

Default: localhost

The hostnames and/or IP addresses and/or full Unix domain socket paths on which
mongos or mongod should listen for client connections. You may attach mongos or
mongod to any interface. To bind to multiple addresses, enter a list of
comma-separated values.

EXAMPLE

localhost,/tmp/mongod.sock

You can specify both IPv4 and IPv6 addresses, or hostnames that resolve to an
IPv4 or IPv6 address.

EXAMPLE

localhost, 2001:0DB8:e132:ba26:0d5c:2774:e7f9:d513

NOTE

If specifying an IPv6 address or a hostname that resolves to an IPv6 address to
net.bindIp, you must start mongos or mongod with net.ipv6 : true to enable IPv6
support. Specifying an IPv6 address to net.bindIp does not enable IPv6 support.

If specifying a link-local IPv6 address (fe80::/10), you must append the zone
index to that address (i.e. fe80::<address>%<adapter-name>).

EXAMPLE

localhost,fe80::a00:27ff:fee0:1fcf%enp0s3

IMPORTANT

To avoid configuration updates due to IP address changes, use DNS hostnames
instead of IP addresses. It is particularly important to use a DNS hostname
instead of an IP address when configuring replica set members or sharded cluster
members.

Use hostnames instead of IP addresses to configure clusters across a split
network horizon. Starting in MongoDB 5.0, nodes that are only configured with an
IP address will fail startup validation and will not start.

WARNING

Before you bind your instance to a publicly-accessible IP address, you must
secure your cluster from unauthorized access. For a complete list of security
recommendations, see Security Checklist. At minimum, consider enabling
authentication and hardening network infrastructure.

For more information about IP Binding, refer to the IP Binding documentation.

To bind to all IPv4 addresses, enter 0.0.0.0.

To bind to all IPv4 and IPv6 addresses, enter ::,0.0.0.0 or starting in MongoDB
4.2, an asterisk "*" (enclose the asterisk in quotes to distinguish from YAML
alias nodes). Alternatively, use the net.bindIpAll setting.

NOTE

* net.bindIp and net.bindIpAll are mutually exclusive. That is, you can specify
one or the other, but not both.

* The command-line option --bind_ip overrides the configuration file setting
net.bindIp.

To configure cluster nodes for split horizon DNS, use host names instead of IP
addresses.

Starting in MongoDB v5.0, replSetInitiate and replSetReconfig reject
configurations that use IP addresses instead of hostnames.

Use disableSplitHorizonIPCheck to modify nodes that cannot be updated to use
host names. The parameter only applies to the configuration commands.

mongod and mongos do not rely on disableSplitHorizonIPCheck for validation at
startup. Legacy mongod and mongos instances that use IP addresses instead of
host names will start after an upgrade.

Instances that are configured with IP addresses log a warning to use host names
instead of IP addresses.

net.bindIpAll

Type: boolean

Default: false

If true, the mongos or mongod instance binds to all IPv4 addresses (i.e.
0.0.0.0). If mongos or mongod starts with net.ipv6 : true, net.bindIpAll also
binds to all IPv6 addresses (i.e. ::).

mongos or mongod only supports IPv6 if started with net.ipv6 : true. Specifying
net.bindIpAll alone does not enable IPv6 support.

WARNING

For more information about IP Binding, refer to the IP Binding documentation.

Alternatively, set net.bindIp to ::,0.0.0.0 or, starting in MongoDB 4.2, to an
asterisk "*" (enclose the asterisk in quotes to distinguish from YAML alias
nodes) to bind to all IP addresses.

NOTE

net.bindIp and net.bindIpAll are mutually exclusive. Specifying both options
causes mongos or mongod to throw an error and terminate.

net.maxIncomingConnections

Type: integer

Default (Windows): 1,000,000
Default (Linux): (RLIMIT_NOFILE) * 0.8

The maximum number of simultaneous connections that mongos or mongod will
accept. This setting has no effect if it is higher than your operating system's
configured maximum connection tracking threshold.

Do not assign too low of a value to this option, or you will encounter errors
during normal application operation.

This is particularly useful for a mongos if you have a client that creates
multiple connections and allows them to timeout rather than closing them.

In this case, set maxIncomingConnections to a value slightly higher than the
maximum number of connections that the client creates, or the maximum size of
the connection pool.

This setting prevents the mongos from causing connection spikes on the
individual shards. Spikes like these may disrupt the operation and memory
allocation of the sharded cluster.

net.wireObjectCheck

Type: boolean

Default: true

When true, the mongod or mongos instance validates all requests from clients
upon receipt to prevent clients from inserting malformed or invalid BSON into a
MongoDB database.

For objects with a high degree of sub-document nesting, net.wireObjectCheck can
have a small impact on performance.

net.ipv6

Type: boolean

Default: false

Set net.ipv6 to true to enable IPv6 support. mongos/mongod disables IPv6 support
by default.

Setting net.ipv6 does not direct the mongos/mongod to listen on any local IPv6
addresses or interfaces. To configure the mongos/mongod to listen on an IPv6
interface, you must either:

* Configure net.bindIp with one or more IPv6 addresses or hostnames that
resolve to IPv6 addresses, or

* Set net.bindIpAll to true.

NET.UNIXDOMAINSOCKET OPTIONS

net: unixDomainSocket: enabled: <boolean> pathPrefix: <string> filePermissions: <int>

net.unixDomainSocket.enabled

Type: boolean

Default: true

Enable or disable listening on the UNIX domain socket.
net.unixDomainSocket.enabled applies only to Unix-based systems.

When net.unixDomainSocket.enabled is true, mongos or mongod listens on the UNIX
socket.

The mongos or mongod process always listens on the UNIX socket unless one of the
following is true:

* net.unixDomainSocket.enabled is false

* --nounixsocket is set. The command line option takes precedence over the
configuration file setting.

* net.bindIp is not set

* net.bindIp does not specify localhost or its associated IP address

mongos or mongod installed from official .deb and .rpm packages have the bind_ip
configuration set to 127.0.0.1 by default.

net.unixDomainSocket.pathPrefix

Type: string

Default: /tmp

The path for the UNIX socket. net.unixDomainSocket.pathPrefix applies only to
Unix-based systems.

If this option has no value, the mongos or mongod process creates a socket with
/tmp as a prefix. MongoDB creates and listens on a UNIX socket unless one of the
following is true:

* net.unixDomainSocket.enabled is false

* --nounixsocket is set

* net.bindIp is not set

* net.bindIp does not specify localhost or its associated IP address

net.unixDomainSocket.filePermissions

Type: int

Default: 0700

Sets the permission for the UNIX domain socket file.

net.unixDomainSocket.filePermissions applies only to Unix-based systems.

NET.HTTP OPTIONS

Changed in version 3.6: MongoDB 3.6 removes the deprecated net.http options. The
options have been deprecated since version 3.2.

NET.TLS OPTIONS

New in version 4.2: The tls options provide identical functionality as the
previous ssl options.

net: tls: mode: <string> certificateKeyFile: <string> certificateKeyFilePassword: <string> certificateSelector: <string> clusterCertificateSelector: <string> clusterFile: <string> clusterPassword: <string> clusterAuthX509: attributes: <string> extensionValue: <string> CAFile: <string> clusterCAFile: <string> CRLFile: <string> allowConnectionsWithoutCertificates: <boolean> allowInvalidCertificates: <boolean> allowInvalidHostnames: <boolean> disabledProtocols: <string> FIPSMode: <boolean> logVersions: <string>

net.tls.mode

Type: string

New in version 4.2.

Enables TLS used for all network connections. The argument to the net.tls.mode
setting can be one of the following:

Value
Description
disabled
The server does not use TLS.
allowTLS
Connections between servers do not use TLS. For incoming connections, the server
accepts both TLS and non-TLS.
preferTLS
Connections between servers use TLS. For incoming connections, the server
accepts both TLS and non-TLS.
requireTLS
The server uses and accepts only TLS encrypted connections.

If --tlsCAFile or tls.CAFile is not specified and you are not using x.509
authentication, the system-wide CA certificate store will be used when
connecting to an TLS-enabled server.

If using x.509 authentication, --tlsCAFile or tls.CAFile must be specified
unless using --tlsCertificateSelector.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.certificateKeyFile

Type: string

New in version 4.2: The .pem file that contains both the TLS certificate and
key.

Starting with MongoDB 4.0 on macOS or Windows, you can use the
net.tls.certificateSelector setting to specify a certificate from the operating
system's secure certificate store instead of a PEM key file. certificateKeyFile
and net.tls.certificateSelector are mutually exclusive. You can only specify
one.

* On Linux/BSD, you must specify net.tls.certificateKeyFile when TLS is
enabled.

* On Windows or macOS, you must specify either net.tls.certificateKeyFile or
net.tls.certificateSelector when TLS is enabled.

IMPORTANT

For Windows only, MongoDB 4.0 and later do not support encrypted PEM files.
The mongod fails to start if it encounters an encrypted PEM file. To securely
store and access a certificate for use with TLS on Windows, use
net.tls.certificateSelector.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.certificateKeyFilePassword

Type: string

New in version 4.2: The password to de-crypt the certificate-key file (i.e.
certificateKeyFile). Use the net.tls.certificateKeyFilePassword option only if
the certificate-key file is encrypted. In all cases, the mongos or mongod will
redact the password from all logging and reporting output.

Starting in MongoDB 4.0:

* On Linux/BSD, if the private key in the PEM file is encrypted and you do not
specify the net.tls.certificateKeyFilePassword option, MongoDB will prompt
for a passphrase. See TLS/SSL Certificate Passphrase.

* On macOS, if the private key in the PEM file is encrypted, you must
explicitly specify the net.tls.certificateKeyFilePassword option.
Alternatively, you can use a certificate from the secure system store (see
net.tls.certificateSelector) instead of a PEM key file or use an unencrypted
PEM file.

* On Windows, MongoDB does not support encrypted certificates. The mongod fails
if it encounters an encrypted PEM file. Use net.tls.certificateSelector
instead.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.certificateSelector

Type: string

New in version 4.2: Available on Windows and macOS as an alternative to
net.tls.certificateKeyFile. In MongoDB 4.0, see net.ssl.certificateSelector.

Specifies a certificate property in order to select a matching certificate from
the operating system's certificate store to use for TLS/SSL.

net.tls.certificateKeyFile and net.tls.certificateSelector options are mutually
exclusive. You can only specify one.

net.tls.certificateSelector accepts an argument of the format <property>=<value>
where the property can be one of the following:

Property
Value type
Description
subject
ASCII string
Subject name or common name on certificate
thumbprint
hex string

A sequence of bytes, expressed as hexadecimal, used to identify a public key by
its SHA-1 digest.

The thumbprint is sometimes referred to as a fingerprint.

When using the system SSL certificate store, OCSP (Online Certificate Status
Protocol) is used to validate the revocation status of certificates.

The mongod searches the operating system's secure certificate store for the CA
certificates required to validate the full certificate chain of the specified
TLS certificate. Specifically, the secure certificate store must contain the
root CA and any intermediate CA certificates required to build the full
certificate chain to the TLS certificate. Do not use net.tls.CAFile or
net.tls.clusterFile to specify the root and intermediate CA certificate

For example, if the TLS certificate was signed with a single root CA
certificate, the secure certificate store must contain that root CA certificate.
If the TLS certificate was signed with an intermediate CA certificate, the
secure certificate store must contain the intermedia CA certificate and the root
CA certificate.

NOTE

You cannot use the rotateCertificates command or the db.rotateCertificates()
shell method when using net.tls.certificateSelector or --tlsCertificateSelector
set to thumbprint

net.tls.clusterCertificateSelector

Type: string

New in version 4.2: Available on Windows and macOS as an alternative to
net.tls.clusterFile.

Specifies a certificate property to select a matching certificate from the
operating system's secure certificate store to use for internal x.509 membership
authentication.

net.tls.clusterFile and net.tls.clusterCertificateSelector options are mutually
exclusive. You can only specify one.

net.tls.clusterCertificateSelector accepts an argument of the format
<property>=<value> where the property can be one of the following:

Property
Value type
Description
subject
ASCII string
Subject name or common name on certificate
thumbprint
hex string

A sequence of bytes, expressed as hexadecimal, used to identify a public key by
its SHA-1 digest.

The thumbprint is sometimes referred to as a fingerprint.

The mongod searches the operating system's secure certificate store for the CA
certificates required to validate the full certificate chain of the specified
cluster certificate. Specifically, the secure certificate store must contain the
root CA and any intermediate CA certificates required to build the full
certificate chain to the cluster certificate. Do not use net.tls.CAFile or
net.tls.clusterCAFile to specify the root and intermediate CA certificate.

For example, if the cluster certificate was signed with a single root CA
certificate, the secure certificate store must contain that root CA certificate.
If the cluster certificate was signed with an intermediate CA certificate, the
secure certificate store must contain the intermediate CA certificate and the
root CA certificate.

Changed in version 4.4: mongod / mongos logs a warning on connection if the
presented x.509 certificate expires within 30 days of the mongod/mongos host
system time. See x.509 Certificates Nearing Expiry Trigger Warnings for more
information.

net.tls.clusterFile

Type: string

New in version 4.2: The .pem file that contains the x.509 certificate-key file
for membership authentication for the cluster or replica set.

Starting with MongoDB 4.0 on macOS or Windows, you can use the
net.tls.clusterCertificateSelector option to specify a certificate from the
operating system's secure certificate store instead of a PEM key file.
net.tls.clusterFile and net.tls.clusterCertificateSelector options are mutually
exclusive. You can only specify one.

If net.tls.clusterFile does not specify the .pem file for internal cluster
authentication or the alternative net.tls.clusterCertificateSelector, the
cluster uses the .pem file specified in the certificateKeyFile setting or the
certificate returned by the net.tls.certificateSelector.

If using x.509 authentication, --tlsCAFile or tls.CAFile must be specified
unless using --tlsCertificateSelector.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

IMPORTANT

For Windows only, MongoDB 4.0 and later do not support encrypted PEM files. The
mongod fails to start if it encounters an encrypted PEM file. To securely store
and access a certificate for use with membership authentication on Windows, use
net.tls.clusterCertificateSelector.

net.tls.clusterPassword

Type: string

New in version 4.2: The password to de-crypt the x.509 certificate-key file
specified with --sslClusterFile. Use the net.tls.clusterPassword option only if
the certificate-key file is encrypted. In all cases, the mongos or mongod will
redact the password from all logging and reporting output.

Starting in MongoDB 4.0:

* On Linux/BSD, if the private key in the x.509 file is encrypted and you do
not specify the net.tls.clusterPassword option, MongoDB will prompt for a
passphrase. See TLS/SSL Certificate Passphrase.

* On macOS, if the private key in the x.509 file is encrypted, you must
explicitly specify the net.tls.clusterPassword option. Alternatively, you can
either use a certificate from the secure system store (see
net.tls.clusterCertificateSelector) instead of a cluster PEM file or use an
unencrypted PEM file.

* On Windows, MongoDB does not support encrypted certificates. The mongod fails
if it encounters an encrypted PEM file. Use
net.tls.clusterCertificateSelector.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.clusterAuthX509

New in version 7.0.

net: tls: clusterAuthX509: attributes: <string> extensionValue: <string>

net.tls.clusterAuthX509.attributes

Type: string

New in version 7.0.

Specifies a set of X.509 Distinguished Name (DN) attributes and values that the
server expects cluster member nodes to contain in their certificate subject
names. This lets you use certificates that don't contain DC, O, and OU values to
authenticate cluster members.

When attributes is set, MongoDB matches certificates using the DN and ignores
extension values.

net.tls.clusterAuthX509.extensionValue

Type: string

New in version 7.0.

Specifies an extension value that corresponds to the MongoDB cluster membership
extension OID, 1.3.6.1.4.1.34601.2.1.2, that the server expects cluster member
nodes to contain in their certificates. This allows you to use certificates that
don't contain DC, O, and OU values to authenticate cluster members.

When extensionValue is set, MongoDB matches certificates using certificate
extension values and ignores the Distinguished Name (DN).

net.tls.CAFile

Type: string

New in version 4.2: The .pem file that contains the root certificate chain from
the Certificate Authority. Specify the file name of the .pem file using relative
or absolute paths.

Windows/macOS OnlyIf using net.tls.certificateSelector and/or
net.tls.clusterCertificateSelector, do not use net.tls.CAFile to specify the
root and intermediate CA certificates. Store all CA certificates required to
validate the full trust chain of the net.tls.certificateSelector and/or
net.tls.clusterCertificateSelector certificates in the secure certificate store.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.clusterCAFile

Type: string

New in version 4.2: The .pem file that contains the root certificate chain from
the Certificate Authority used to validate the certificate presented by a client
establishing a connection. Specify the file name of the .pem file using relative
or absolute paths. net.tls.clusterCAFile requires that net.tls.CAFile is set.

If net.tls.clusterCAFile does not specify the .pem file for validating the
certificate from a client establishing a connection, the cluster uses the .pem
file specified in the net.tls.CAFile option.

net.tls.clusterCAFile lets you use separate Certificate Authorities to verify
the client to server and server to client portions of the TLS handshake.

Starting in 4.0, on macOS or Windows, you can use a certificate from the
operating system's secure store instead of a PEM key file. See
net.tls.clusterCertificateSelector. When using the secure store, you do not need
to, but can, also specify the net.tls.clusterCAFile.

Windows/macOS OnlyIf using net.tls.certificateSelector and/or
net.tls.clusterCertificateSelector, do not use net.tls.clusterCAFile to specify
the root and intermediate CA certificates. Store all CA certificates required to
validate the full trust chain of the net.tls.certificateSelector and/or
net.tls.clusterCertificateSelector certificates in the secure certificate store.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.CRLFile

Type: string

New in version 4.2: In MongoDB 4.0 and earlier, see net.ssl.CRLFile.

The .pem file that contains the Certificate Revocation List. Specify the file
name of the .pem file using relative or absolute paths.

NOTE

* Starting in MongoDB 4.0, you cannot specify net.tls.CRLFile on macOS.
Instead, you can use the system SSL certificate store, which uses OCSP
(Online Certificate Status Protocol) to validate the revocation status of
certificates. See net.ssl.certificateSelector in MongoDB 4.0 and
net.tls.certificateSelector in MongoDB 4.2+ to use the system SSL certificate
store.

* Starting in version 4.4, to check for certificate revocation, MongoDB enables
the use of OCSP (Online Certificate Status Protocol) by default as an
alternative to specifying a CRL file or using the system SSL certificate
store.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.allowConnectionsWithoutCertificates

Type: boolean

New in version 4.2.

By default, the server bypasses client certificate validation unless the server
is configured to use a CA file. If a CA file is provided, the following rules
apply:

* For clients that don't provide certificates, mongod or mongos encrypts the
TLS/SSL connection, assuming the connection is successfully made.

* For clients that present a certificate, mongos or mongod performs certificate
validation using the root certificate chain specified by CAFile and reject
clients with invalid certificates.

Use the net.tls.allowConnectionsWithoutCertificates option if you have a mixed
deployment that includes clients that do not or cannot present certificates to
the mongos or mongod.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.allowInvalidCertificates

Type: boolean

New in version 4.2.

Enable or disable the validation checks for TLS certificates on other servers in
the cluster and allows the use of invalid certificates to connect.

NOTE

If you specify --tlsAllowInvalidCertificates or tls.allowInvalidCertificates:
true when using x.509 authentication, an invalid certificate is only sufficient
to establish a TLS connection but is insufficient for authentication.

When using the net.tls.allowInvalidCertificates setting, MongoDB logs a warning
regarding the use of the invalid certificate.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.allowInvalidHostnames

Type: boolean

Default: false

When net.tls.allowInvalidHostnames is true, MongoDB disables the validation of
the hostnames in TLS certificates, allowing mongod to connect to MongoDB
instances if the hostname their certificates do not match the specified
hostname.

For more information about TLS and MongoDB, see Configure mongod and mongos for
TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.disabledProtocols

Type: string

Prevents a MongoDB server running with TLS from accepting incoming connections
that use a specific protocol or protocols. To specify multiple protocols, use a
comma separated list of protocols, but do not use spaces after the commas. If
you include a space before a protocol name, the server interprets it as an
unrecognized protocol and doesn't start.

net.tls.disabledProtocols recognizes the following protocols: TLS1_0, TLS1_1,
TLS1_2, and TLS1_3.

* On macOS, you cannot disable TLS1_1 and leave both TLS1_0 and TLS1_2 enabled.
You must disable at least one of the other two, for example, TLS1_0,TLS1_1.

* To list multiple protocols, specify as a comma separated list of protocols
without spaces after the commas. For example TLS1_0,TLS1_1.

* Specifying an unrecognized protocol or including a space after a comma
prevents the server from starting.

* The specified disabled protocols overrides any default disabled protocols.

MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To
enable TLS 1.0, specify none to net.tls.disabledProtocols. See Disable TLS 1.0.

Members of replica sets and sharded clusters must speak at least one protocol in
common.

TIP

SEE ALSO:

KMIP Master Key Rotation

security.kmip.serverName

Type: string

Hostname or IP address of the KMIP server to connect to. Requires
security.enableEncryption to be true.

Starting in MongoDB 4.2.1 (and 4.0.14), you can specify multiple KMIP servers as
a comma-separated list, e.g. server1.example.com,server2.example.com. On
startup, the mongod will attempt to establish a connection to each server in the
order listed, and will select the first server to which it can successfully
establish a connection. KMIP server selection occurs only at startup.

mongod verifies the connection to the KMIP server on startup.

The server name specified in --kmipServerName must match either the Subject
Alternative Name SAN or the Common Name CN on the certificate presented by the
KMIP server. SAN can be a system name or an IP address.

If SAN is present, mongod does not try to match against CN.

If the hostname or IP address of the KMIP server does does not match either SAN
or CN, mongod does not start.

Starting in MongoDB 4.2, when performing comparison of SAN, MongoDB supports
comparison of DNS names or IP addresses. In previous versions, MongoDB only
supports comparisons of DNS names.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

security.kmip.port

Type: string

Default: 5696

Port number to use to communicate with the KMIP server. Requires
security.kmip.serverName. Requires security.enableEncryption to be true.

If specifying multiple KMIP servers with security.kmip.serverName, the mongod
will use the port specified with security.kmip.port for all provided KMIP
servers.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

security.kmip.clientCertificateFile

Type: string

Path to the .pem file used to authenticate MongoDB to the KMIP server. The
specified .pem file must contain both the TLS/SSL certificate and key.

To use this setting, you must also specify the security.kmip.serverName setting.

NOTE

Starting in 4.0, on macOS or Windows, you can use a certificate from the
operating system's secure store instead of a PEM key file. See
security.kmip.clientCertificateSelector.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

security.kmip.clientCertificatePassword

Type: string

The password to decrypt the client certificate (i.e.
security.kmip.clientCertificateFile), used to authenticate MongoDB to the KMIP
server. Use the option only if the certificate is encrypted.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

security.kmip.clientCertificateSelector

Type: string

New in version 4.0: (and 4.2.15, 4.4.7, and 5.0)

Available on Windows and macOS as an alternative to
security.kmip.clientCertificateFile.

security.kmip.clientCertificateFile and security.kmip.clientCertificateSelector
options are mutually exclusive. You can only specify one.

Specifies a certificate property in order to select a matching certificate from
the operating system's certificate store to authenticate MongoDB to the KMIP
server.

security.kmip.clientCertificateSelector accepts an argument of the format
<property>=<value> where the property can be one of the following:

Property
Value type
Description
subject
ASCII string
Subject name or common name on certificate
thumbprint
hex string

A sequence of bytes, expressed as hexadecimal, used to identify a public key by
its SHA-1 digest.

The thumbprint is sometimes referred to as a fingerprint.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

security.kmip.serverCAFile

Type: string

Path to CA File. Used for validating secure client connection to KMIP server.

NOTE

Starting in 4.0, on macOS or Windows, you can use a certificate from the
operating system's secure store instead of a PEM key file. See
security.kmip.clientCertificateSelector. When using the secure store, you do not
need to, but can, also specify the security.kmip.serverCAFile.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

security.kmip.connectRetries

Type: int

Default: 0

New in version 4.4.

How many times to retry the initial connection to the KMIP server. Use together
with connectTimeoutMS to control how long the mongod waits for a response
between each retry.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

security.kmip.connectTimeoutMS

Type: int

Default: 5000

New in version 4.4.

Timeout in milliseconds to wait for a response from the KMIP server. If the
connectRetries setting is specified, the mongod will wait up to the value
specified with connectTimeoutMS for each retry.

Value must be 1000 or greater.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

security.kmip.activateKeys

Type: boolean

Default: true

New in version 5.3.

Activates all newly created KMIP keys upon creation and then periodically checks
those keys are in an active state.

When security.kmip.activateKeys is true and you have existing keys on a KMIP
server, the key must be activated first or the mongod node will fail to start.

If the key being used by the mongod transitions into a non-active state, the
mongod node will shut down unless kmipActivateKeys is false. To ensure you have
an active key, rotate the KMIP master key by using
security.kmip.rotateMasterKey.

security.kmip.keyStatePollingSeconds

Type: int

Default: 900 seconds

New in version 5.3.

Frequency in seconds at which mongod polls the KMIP server for active keys.

To disable disable polling, set the value to -1.

security.kmip.useLegacyProtocol

Type: boolean

Default: false

New in version 7.0: (and 6.0.6)

When true, mongod uses KMIP protocol version 1.0 or 1.1 instead of the default
version. The default KMIP protocol is version 1.2.

To use audit log encryption with KMIP version 1.0 or 1.1, you must specify
auditEncryptKeyWithKMIPGet at startup.

To use KMIP protocol version 1.0 or 1.1, substitute your local values and add an
entry like this to your mongod configuration file:

security: enableEncryption: true kmip: serverName: "mdbhost.somecompany.com" serverCAFile: "security/libs/trusted-ca.pem" clientCertificateFile: "security/libs/trusted-client.pem" useLegacyProtocol: true

SECURITY.SASL OPTIONS

security: sasl: hostName: <string> serviceName: <string> saslauthdSocketPath: <string>

security.sasl.hostName

Type: string

A fully qualified server domain name for the purpose of configuring SASL and
Kerberos authentication. The SASL hostname overrides the hostname only for the
configuration of SASL and Kerberos.

security.sasl.serviceName

Type: string

Registered name of the service using SASL. This option allows you to override
the default Kerberos service name component of the Kerberos principal name, on a
per-instance basis. If unspecified, the default value is mongodb.

MongoDB permits setting this option only at startup. The setParameter can not
change this setting.

This option is available only in MongoDB Enterprise.

IMPORTANT

Ensure that your driver supports alternate service names. For mongosh and other
MongoDB tools to connect to the new serviceName, see the gssapiServiceName
option.

security.sasl.saslauthdSocketPath

Type: string

The path to the UNIX domain socket file for saslauthd.

SECURITY.LDAP OPTIONS

security: ldap: servers: <string> bind: method: <string> saslMechanisms: <string> queryUser: <string> queryPassword: <string | array> useOSDefaults: <boolean> transportSecurity: <string> timeoutMS: <int> retryCount: <int> userToDNMapping: <string> authz: queryTemplate: <string> validateLDAPServerConfig: <boolean>

security.ldap.servers

Type: string

Available in MongoDB Enterprise only.

The LDAP server against which the mongod or mongos authenticates users or
determines what actions a user is authorized to perform on a given database. If
the LDAP server specified has any replicated instances, you may specify the host
and port of each replicated server in a comma-delimited list.

If your LDAP infrastructure partitions the LDAP directory over multiple LDAP
servers, specify one LDAP server or any of its replicated instances to
security.ldap.servers. MongoDB supports following LDAP referrals as defined in
RFC 4511 4.1.10. Do not use security.ldap.servers for listing every LDAP server
in your infrastructure.

This setting can be configured on a running mongod or mongos using setParameter.

If unset, mongod or mongos cannot use LDAP authentication or authorization.

security.ldap.bind.queryUser

Type: string

Available in MongoDB Enterprise only.

The identity with which mongod or mongos binds as, when connecting to or
performing queries on an LDAP server.

Only required if any of the following are true:

* Using LDAP authorization.

* Using an LDAP query for security.ldap.userToDNMapping.

* The LDAP server disallows anonymous binds

You must use queryUser with queryPassword.

If unset, mongod or mongos will not attempt to bind to the LDAP server.

This setting can be configured on a running mongod or mongos using setParameter.

NOTE

Windows MongoDB deployments can use useOSDefaults instead of queryUser and
queryPassword. You cannot specify both queryUser and useOSDefaults at the same
time.

security.ldap.bind.queryPassword

Type: string or array

Available in MongoDB Enterprise only.

The password used to bind to an LDAP server when using queryUser. You must use
queryPassword with queryUser.

If not set, mongod or mongos does not attempt to bind to the LDAP server.

You can configure this setting on a running mongod or mongos using setParameter.

Starting in MongoDB 4.4, the ldapQueryPassword setParameter command accepts
either a string or an array of strings. If ldapQueryPassword is set to an array,
MongoDB tries each password in order until one succeeds. Use a password array to
roll over the LDAP account password without downtime.

NOTE

Windows MongoDB deployments can use useOSDefaults instead of queryUser and
queryPassword. You cannot specify both queryPassword and useOSDefaults at the
same time.

security.ldap.bind.useOSDefaults

Type: boolean

Default: false

Available in MongoDB Enterprise for the Windows platform only.

Allows mongod or mongos to authenticate, or bind, using your Windows login
credentials when connecting to the LDAP server.

Only required if:

* Using LDAP authorization.

* Using an LDAP query for username transformation.

* The LDAP server disallows anonymous binds

Use useOSDefaults to replace queryUser and queryPassword.

security.ldap.bind.method

Type: string

Default: simple

Available in MongoDB Enterprise only.

The method mongod or mongos uses to authenticate to an LDAP server. Use with
queryUser and queryPassword to connect to the LDAP server.

method supports the following values:

* simple - mongod or mongos uses simple authentication.

* sasl - mongod or mongos uses SASL protocol for authentication

If you specify sasl, you can configure the available SASL mechanisms using
security.ldap.bind.saslMechanisms. mongod or mongos defaults to using DIGEST-MD5
mechanism.

security.ldap.bind.saslMechanisms

Type: string

Default: DIGEST-MD5

Available in MongoDB Enterprise only.

A comma-separated list of SASL mechanisms mongod or mongos can use when
authenticating to the LDAP server. The mongod or mongos and the LDAP server must
agree on at least one mechanism. The mongod or mongos dynamically loads any SASL
mechanism libraries installed on the host machine at runtime.

Install and configure the appropriate libraries for the selected SASL
mechanism(s) on both the mongod or mongos host and the remote LDAP server host.
Your operating system may include certain SASL libraries by default. Defer to
the documentation associated with each SASL mechanism for guidance on
installation and configuration.

If using the GSSAPI SASL mechanism for use with Kerberos Authentication, verify
the following for the mongod or mongos host machine:

Linux

* The KRB5_CLIENT_KTNAME environment variable resolves to the name of the
client Linux Keytab Files for the host machine. For more on Kerberos
environment variables, please defer to the Kerberos documentation.

* The client keytab includes a User Principal for the mongod or mongos to use
when connecting to the LDAP server and execute LDAP queries.

WindowsIf connecting to an Active Directory server, the Windows Kerberos
configuration automatically generates a Ticket-Granting-Ticket when the user
logs onto the system. Set useOSDefaults to true to allow mongod or mongos to use
the generated credentials when connecting to the Active Directory server and
execute queries.

Set method to sasl to use this option.

NOTE

For a complete list of SASL mechanisms see the IANA listing. Defer to the
documentation for your LDAP or Active Directory service for identifying the SASL
mechanisms compatible with the service.

MongoDB is not a source of SASL mechanism libraries, nor is the MongoDB
documentation a definitive source for installing or configuring any given SASL
mechanism. For documentation and support, defer to the SASL mechanism library
vendor or owner.

For more information on SASL, defer to the following resources:

* For Linux, please see the Cyrus SASL documentation.

* For Windows, please see the Windows SASL documentation.

security.ldap.transportSecurity

Type: string

Default: tls

Available in MongoDB Enterprise only.

By default, mongod or mongos creates a TLS/SSL secured connection to the LDAP
server.

For Linux deployments, you must configure the appropriate TLS Options in
/etc/openldap/ldap.conf file. Your operating system's package manager creates
this file as part of the MongoDB Enterprise installation, via the libldap
dependency. See the documentation for TLS Options in the ldap.conf OpenLDAP
documentation for more complete instructions.

For Windows deployment, you must add the LDAP server CA certificates to the
Windows certificate management tool. The exact name and functionality of the
tool may vary depending on operating system version. Please see the
documentation for your version of Windows for more information on certificate
management.

Set transportSecurity to none to disable TLS/SSL between mongod or mongos and
the LDAP server.

WARNING

Setting transportSecurity to none transmits plaintext information and possibly
credentials between mongod or mongos and the LDAP server.

security.ldap.timeoutMS

Type: int

Default: 10000

Available in MongoDB Enterprise only.

The amount of time in milliseconds mongod or mongos should wait for an LDAP
server to respond to a request.

Increasing the value of timeoutMS may prevent connection failure between the
MongoDB server and the LDAP server, if the source of the failure is a connection
timeout. Decreasing the value of timeoutMS reduces the time MongoDB waits for a
response from the LDAP server.

This setting can be configured on a running mongod or mongos using setParameter.

security.ldap.retryCount

New in version 6.1.

Type: int

Default: 0

Available in MongoDB Enterprise only.

Number of operation retries by the server LDAP manager after a network error.

This setting can be configured on a running mongod or mongos using setParameter.

security.ldap.userToDNMapping

Type: string

Available in MongoDB Enterprise only.

Maps the username provided to mongod or mongos for authentication to a LDAP
Distinguished Name (DN). You may need to use userToDNMapping to transform a
username into an LDAP DN in the following scenarios:

* Performing LDAP authentication with simple LDAP binding, where users
authenticate to MongoDB with usernames that are not full LDAP DNs.

* Using an LDAP authorization query template that requires a DN.

* Transforming the usernames of clients authenticating to Mongo DB using
different authentication mechanisms (e.g. x.509, kerberos) to a full LDAP DN
for authorization.

userToDNMapping expects a quote-enclosed JSON-string representing an ordered
array of documents. Each document contains a regular expression match and either
a substitution or ldapQuery template used for transforming the incoming
username.

Each document in the array has the following form:

{ match: "<regex>" substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>"}

Field
Description
Example
match
An ECMAScript-formatted regular expression (regex) to match against a provided
username. Each parenthesis-enclosed section represents a regex capture group
used by substitution or ldapQuery.
"(.+)ENGINEERING" "(.+)DBA"
substitution

An LDAP distinguished name (DN) formatting template that converts the
authentication name matched by the match regex into a LDAP DN. Each curly
bracket-enclosed numeric value is replaced by the corresponding regex capture
group extracted from the authentication username via the match regex.

The result of the substitution must be an RFC4514 escaped string.

"cn={0},ou=engineering, dc=example,dc=com"
ldapQuery
A LDAP query formatting template that inserts the authentication name matched by
the match regex into an LDAP query URI encoded respecting RFC4515 and RFC4516.
Each curly bracket-enclosed numeric value is replaced by the corresponding regex
capture group extracted from the authentication username via the match
expression. mongod or mongos executes the query against the LDAP server to
retrieve the LDAP DN for the authenticated user. mongod or mongos requires
exactly one returned result for the transformation to be successful, or mongod
or mongos skips this transformation.
"ou=engineering,dc=example, dc=com??one?(user={0})"

NOTE

An explanation of RFC4514, RFC4515, RFC4516, or LDAP queries is out of scope for
the MongoDB Documentation. Please review the RFC directly or use your preferred
LDAP resource.

For each document in the array, you must use either substitution or ldapQuery.
You cannot specify both in the same document.

When performing authentication or authorization, mongod or mongos steps through
each document in the array in the given order, checking the authentication
username against the match filter. If a match is found, mongod or mongos applies
the transformation and uses the output for authenticating the user. mongod or
mongos does not check the remaining documents in the array.

If the given document does not match the provided authentication name, mongod or
mongos continues through the list of documents to find additional matches. If no
matches are found in any document, or the transformation the document describes
fails, mongod or mongos returns an error.

Starting in MongoDB 4.4, mongod or mongos also returns an error if one of the
transformations cannot be evaluated due to networking or authentication failures
to the LDAP server. mongod or mongos rejects the connection request and does not
check the remaining documents in the array.

Starting in MongoDB 5.0, userToDNMapping accepts an empty string "" or empty
array [ ] in place of a mapping document. If providing an empty string or empty
array to userToDNMapping, MongoDB will map the authenticated username as the
LDAP DN. Previously, providing an empty mapping document would cause mapping to
fail.

EXAMPLE

The following shows two transformation documents. The first document matches
against any string ending in @ENGINEERING, placing anything preceding the suffix
into a regex capture group. The second document matches against any string
ending in @DBA, placing anything preceding the suffix into a regex capture
group.

IMPORTANT

YOU MUST PASS THE ARRAY TO USERTODNMAPPING AS A STRING.

"[ { match: "(.+)@ENGINEERING.EXAMPLE.COM", substitution: "cn={0},ou=engineering,dc=example,dc=com" }, { match: "(.+)@DBA.EXAMPLE.COM", ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})"
}
]"

A user with username alice@ENGINEERING.EXAMPLE.COM matches the first document.
The regex capture group {0} corresponds to the string alice. The resulting
output is the DN "cn=alice,ou=engineering,dc=example,dc=com".

A user with username bob@DBA.EXAMPLE.COM matches the second document. The regex
capture group {0} corresponds to the string bob. The resulting output is the
LDAP query "ou=dba,dc=example,dc=com??one?(user=bob)". mongod or mongos executes
this query against the LDAP server, returning the result
"cn=bob,ou=dba,dc=example,dc=com".

If userToDNMapping is unset, mongod or mongos applies no transformations to the
username when attempting to authenticate or authorize a user against the LDAP
server.

This setting can be configured on a running mongod or mongos using the
setParameter database command.

security.ldap.authz.queryTemplate

Type: string

Available in MongoDB Enterprise only.

A relative LDAP query URL formatted conforming to RFC4515 and RFC4516 that
mongod executes to obtain the LDAP groups to which the authenticated user
belongs to. The query is relative to the host or hosts specified in
security.ldap.servers.

In the URL, you can use the following substitution tokens:

Substitution Token
Description
{USER}
Substitutes the authenticated username, or the transformed username if a
userToDNMapping is specified.
{PROVIDED_USER}

Substitutes the supplied username, i.e. before either authentication or LDAP
transformation.

New in version 4.2.

When constructing the query URL, ensure that the order of LDAP parameters
respects RFC4516:

[ dn [ ? [attributes] [ ? [scope] [ ? [filter] [ ? [Extensions] ] ] ] ] ]

If your query includes an attribute, mongod assumes that the query retrieves a
list of the DNs which this entity is a member of.

If your query does not include an attribute, mongod assumes the query retrieves
all entities which the user is member of.

For each LDAP DN returned by the query, mongod assigns the authorized user a
corresponding role on the admin database. If a role on the on the admin database
exactly matches the DN, mongod grants the user the roles and privileges assigned
to that role. See the db.createRole() method for more information on creating
roles.

EXAMPLE

This LDAP query returns any groups listed in the LDAP user object's memberOf
attribute.

"{USER}?memberOf?base"

Your LDAP configuration may not include the memberOf attribute as part of the
user schema, may possess a different attribute for reporting group membership,
or may not track group membership through attributes. Configure your query with
respect to your own unique LDAP configuration.

If unset, mongod cannot authorize users using LDAP.

This setting can be configured on a running mongod using the setParameter
database command.

NOTE

An explanation of RFC4515, RFC4516 or LDAP queries is out of scope for the
MongoDB Documentation. Please review the RFC directly or use your preferred LDAP
resource.

security.ldap.validateLDAPServerConfig

Type: boolean

Default: true

Available in MongoDB Enterprise

A flag that determines if the mongod or mongos instance checks the availability
of the LDAP server(s) as part of its startup:

* If true, the mongod or mongos instance performs the availability check and
only continues to start up if the LDAP server is available.

* If false, the mongod or mongos instance skips the availability check; i.e.
the instance starts up even if the LDAP server is unavailable.

SETPARAMETER OPTION

setParameter

Set MongoDB parameter or parameters described in MongoDB Server Parameters

To set parameters in the YAML configuration file, use the following format:

setParameter: <parameter1>: <value1> <parameter2>: <value2>

For example, to specify the enableLocalhostAuthBypass in the configuration file:

setParameter: enableLocalhostAuthBypass: false

LDAP PARAMETERS

setParameter.ldapUserCacheInvalidationInterval

Type: int

Default: 30

For use with mongod servers using LDAP Authorization.

The interval (in seconds) mongod waits between external user cache flushes.
After mongod flushes the external user cache, MongoDB reacquires authorization
data from the LDAP server the next time an LDAP-authorized user issues an
operation.

Increasing the value specified increases the amount of time mongod and the LDAP
server can be out of sync, but reduces the load on the LDAP server. Conversely,
decreasing the value specified decreases the time mongod and the LDAP server can
be out of sync while increasing the load on the LDAP server.

setParameter: ldapUserCacheInvalidationInterval: <int>

STORAGE OPTIONS

Changed in version 6.1:

* MongoDB always enables journaling. As a result, MongoDB removes the
storage.journal.enabled option and the corresponding --journal and
--nojournal command-line options.

Changed in version 4.4:

* MongoDB removes the storage.indexBuildRetry option and the corresponding
--noIndexBuildRetry command-line option.

* MongoDB deprecates storage.wiredTiger.engineConfig.maxCacheOverflowFileSizeGB
option. The option has no effect starting in MongoDB 4.4.

storage: dbPath: <string> journal: commitIntervalMs: <num> directoryPerDB: <boolean> syncPeriodSecs: <int> engine: <string> wiredTiger: engineConfig: cacheSizeGB: <number> journalCompressor: <string> directoryForIndexes: <boolean> maxCacheOverflowFileSizeGB: <number> // deprecated in MongoDB 4.4 collectionConfig: blockCompressor: <string> indexConfig: prefixCompression: <boolean> inMemory: engineConfig: inMemorySizeGB: <number> oplogMinRetentionHours: <double>

storage.dbPath

Type: string

Default:

* /data/db on Linux and macOS

* \data\db on Windows

The directory where the mongod instance stores its data.

The storage.dbPath setting is available only for mongod.

NOTE

CONFIGURATION FILES

The default mongod.conf configuration file included with package manager
installations uses the following platform-specific default values for
storage.dbPath:

Platform
Package Manager
Default storage.dbPath
RHEL / CentOS and Amazon
yum
/var/lib/mongo
SUSE
zypper
/var/lib/mongo
Ubuntu and Debian
apt
/var/lib/mongodb
macOS
brew
/usr/local/var/mongodb

The Linux package init scripts do not expect storage.dbPath to change from the
defaults. If you use the Linux packages and change storage.dbPath, you will have
to use your own init scripts and disable the built-in scripts.

storage.journal.commitIntervalMs

Type: number

Default: 100

The maximum amount of time in milliseconds that the mongod process allows
between journal operations. Values can range from 1 to 500 milliseconds. Lower
values increase the durability of the journal, at the expense of disk
performance.

On WiredTiger, the default journal commit interval is 100 milliseconds.
Additionally, a write that includes or implies j:true will cause an immediate
sync of the journal. For details or additional conditions that affect the
frequency of the sync, see Journaling Process.

The storage.journal.commitIntervalMs setting is available only for mongod.

Not available for mongod instances that use the in-memory storage engine.

NOTE

Known Issue in 4.2.0: The storage.journal.commitIntervalMs is missing in 4.2.0.

storage.directoryPerDB

Type: boolean

Default: false

When true, MongoDB uses a separate directory to store data for each database.
The directories are under the storage.dbPath directory, and each subdirectory
name corresponds to the database name.

The storage.directoryPerDB setting is available only for mongod.

Not available for mongod instances that use the in-memory storage engine.

Starting in MongoDB 5.0, dropping the final collection in a database (or
dropping the database itself) when storage.directoryPerDB is enabled deletes the
newly empty subdirectory for that database.

To change the storage.directoryPerDB option for existing deployments:

* For standalone instances:

1. Use mongodump on the existing mongod instance to generate a backup.

2. Stop the mongod instance.

3. Add the storage.directoryPerDB value and configure a new data directory

4. Restart the mongod instance.

5. Use mongorestore to populate the new data directory.

* For replica sets:

1. Stop a secondary member.

2. Add the storage.directoryPerDB value and configure a new data directory to
that secondary member.

3. Restart that secondary.

4. Use initial sync to populate the new data directory.

5. Update remaining secondaries in the same fashion.

6. Step down the primary, and update the stepped-down member in the same
fashion.

storage.syncPeriodSecs

Type: number

Default: 60

The amount of time that can pass before MongoDB flushes data to the data files
via an fsync operation.

Do not set this value on production systems. In almost every situation, you
should use the default setting.

WARNING

If you set storage.syncPeriodSecs to 0, MongoDB will not sync the memory mapped
files to disk.

The mongod process writes data very quickly to the journal and lazily to the
data files. storage.syncPeriodSecs has no effect on Journaling, but if
storage.syncPeriodSecs is set to 0 the journal will eventually consume all
available disk space.

The storage.syncPeriodSecs setting is available only for mongod.

Not available for mongod instances that use the in-memory storage engine.

storage.engine

Default: wiredTiger

NOTE

Starting in version 4.2, MongoDB removes the deprecated MMAPv1 storage engine.

The storage engine for the mongod database. Available values include:

Value
Description
wiredTiger
To specify the WiredTiger Storage Engine.
inMemory

To specify the In-Memory Storage Engine.

Available in MongoDB Enterprise only.

If you attempt to start a mongod with a storage.dbPath that contains data files
produced by a storage engine other than the one specified by storage.engine,
mongod will refuse to start.

storage.oplogMinRetentionHours

Type: double

New in version 4.4: Specifies the minimum number of hours to preserve an oplog
entry, where the decimal values represent the fractions of an hour. For example,
a value of 1.5 represents one hour and thirty minutes.

The value must be greater than or equal to 0. A value of 0 indicates that the
mongod should truncate the oplog starting with the oldest entries to maintain
the configured maximum oplog size.

Defaults to 0.

A mongod started with oplogMinRetentionHours only removes an oplog entry if:

* The oplog has reached the maximum configured oplog size and

* The oplog entry is older than the configured number of hours based on the
host system clock.

The mongod has the following behavior when configured with a minimum oplog
retention period:

* The oplog can grow without constraint so as to retain oplog entries for the
configured number of hours. This may result in reduction or exhaustion of
system disk space due to a combination of high write volume and large
retention period.

* If the oplog grows beyond its maximum size, the mongod may continue to hold
that disk space even if the oplog returns to its maximum size or is
configured for a smaller maximum size. See Reducing Oplog Size Does Not
Immediately Return Disk Space.

* The mongod compares the system wall clock to an oplog entries creation wall
clock time when enforcing oplog entry retention. Clock drift between cluster
components may result in unexpected oplog retention behavior. See Clock
Synchronization for more information on clock synchronization across cluster
members.

To change the minimum oplog retention period after starting the mongod, use
replSetResizeOplog. replSetResizeOplog enables you to resize the oplog
dynamically without restarting the mongod process. To persist the changes made
using replSetResizeOplog through a restart, update the value of
oplogMinRetentionHours.

STORAGE.WIREDTIGER OPTIONS

storage: wiredTiger: engineConfig: cacheSizeGB: <number> journalCompressor: <string> directoryForIndexes: <boolean> maxCacheOverflowFileSizeGB: <number> // Deprecated in MongoDB 4.4 collectionConfig: blockCompressor: <string> indexConfig: prefixCompression: <boolean>

storage.wiredTiger.engineConfig.cacheSizeGB

Type: float

Defines the maximum size of the internal cache that WiredTiger will use for all
data. The memory consumed by an index build (see
maxIndexBuildMemoryUsageMegabytes) is separate from the WiredTiger cache memory.

Values can range from 0.25 GB to 10000 GB.

Starting in MongoDB 3.4, the default WiredTiger internal cache size is the
larger of either:

* 50% of (RAM - 1 GB), or

* 256 MB.

For example, on a system with a total of 4GB of RAM the WiredTiger cache will
use 1.5GB of RAM (0.5 * (4 GB - 1 GB) = 1.5 GB). Conversely, a system with a
total of 1.25 GB of RAM will allocate 256 MB to the WiredTiger cache because
that is more than half of the total RAM minus one gigabyte (0.5 * (1.25 GB - 1
GB) = 128 MB < 256 MB).

NOTE

In some instances, such as when running in a container, the database can have
memory constraints that are lower than the total system memory. In such
instances, this memory limit, rather than the total system memory, is used as
the maximum RAM available.

To see the memory limit, see hostInfo.system.memLimitMB.

Avoid increasing the WiredTiger internal cache size above its default value.

With WiredTiger, MongoDB utilizes both the WiredTiger internal cache and the
filesystem cache.

Via the filesystem cache, MongoDB automatically uses all free memory that is not
used by the WiredTiger cache or by other processes.

NOTE

The storage.wiredTiger.engineConfig.cacheSizeGB limits the size of the
WiredTiger internal cache. The operating system will use the available free
memory for filesystem cache, which allows the compressed MongoDB data files to
stay in memory. In addition, the operating system will use any free RAM to
buffer file system blocks and file system cache.

To accommodate the additional consumers of RAM, you may have to decrease
WiredTiger internal cache size.

The default WiredTiger internal cache size value assumes that there is a single
mongod instance per machine. If a single machine contains multiple MongoDB
instances, then you should decrease the setting to accommodate the other mongod
instances.

If you run mongod in a container (e.g. lxc, cgroups, Docker, etc.) that does not
have access to all of the RAM available in a system, you must set
storage.wiredTiger.engineConfig.cacheSizeGB to a value less than the amount of
RAM available in the container. The exact amount depends on the other processes
running in the container. See memLimitMB.

storage.wiredTiger.engineConfig.journalCompressor

Default: snappy

Specifies the type of compression to use to compress WiredTiger journal data.

Available compressors are:

* none

* snappy

* zlib

* zstd (Available starting in MongoDB 4.2)

storage.wiredTiger.engineConfig.directoryForIndexes

Type: boolean

Default: false

When storage.wiredTiger.engineConfig.directoryForIndexes is true, mongod stores
indexes and collections in separate subdirectories under the data (i.e.
storage.dbPath) directory. Specifically, mongod stores the indexes in a
subdirectory named index and the collection data in a subdirectory named
collection.

By using a symbolic link, you can specify a different location for the indexes.
Specifically, when mongod instance is not running, move the index subdirectory
to the destination and create a symbolic link named index under the data
directory to the new destination.

storage.wiredTiger.engineConfig.maxCacheOverflowFileSizeGB

Type: float

NOTE

DEPRECATED IN MONGODB 4.4

MongoDB deprecates the
storage.wiredTiger.engineConfig.maxCacheOverflowFileSizeGB option. The option
has no effect starting in MongoDB 4.4.

Specifies the maximum size (in GB) for the "lookaside (or cache overflow) table"
file WiredTigerLAS.wt for MongoDB 4.2.1-4.2.x and 4.0.12-4.0.x. The file no
longer exists starting in version 4.4.

The setting can accept the following values:

Value
Description
0
The default value. If set to 0, the file size is unbounded.
number >= 0.1
The maximum size (in GB). If the WiredTigerLAS.wt file exceeds this size, mongod
exits with a fatal assertion. You can clear the WiredTigerLAS.wt file and
restart mongod.

To change the maximum size during runtime, use the
wiredTigerMaxCacheOverflowSizeGB parameter.

Available starting in MongoDB 4.2.1 (and 4.0.12)

storage.wiredTiger.engineConfig.zstdCompressionLevel

Type: integer

Default: 6

Specifies the level of compression applied when using the zstd compressor.

Values can range from 1 to 22.

The higher the specified value for zstdCompressionLevel the higher the
compression which is applied.

Only applicable when blockCompressor is set to zstd.

Available starting in MongoDB 5.0

storage.wiredTiger.collectionConfig.blockCompressor

Default: snappy

Specifies the default compression for collection data. You can override this on
a per-collection basis when creating collections.

Available compressors are:

* none

* snappy

* zlib

* zstd (Available starting MongoDB 4.2)

storage.wiredTiger.collectionConfig.blockCompressor affects all collections
created. If you change the value of
storage.wiredTiger.collectionConfig.blockCompressor on an existing MongoDB
deployment, all new collections will use the specified compressor. Existing
collections will continue to use the compressor specified when they were
created, or the default compressor at that time.

storage.wiredTiger.indexConfig.prefixCompression

Default: true

Enables or disables prefix compression for index data.

Specify true for storage.wiredTiger.indexConfig.prefixCompression to enable
prefix compression for index data, or false to disable prefix compression for
index data.

The storage.wiredTiger.indexConfig.prefixCompression setting affects all indexes
created. If you change the value of
storage.wiredTiger.indexConfig.prefixCompression on an existing MongoDB
deployment, all new indexes will use prefix compression. Existing indexes are
not affected.

STORAGE.INMEMORY OPTIONS

storage: inMemory: engineConfig: inMemorySizeGB: <number>

storage.inMemory.engineConfig.inMemorySizeGB

Type: float

Default: 50% of physical RAM less 1 GB

Values can range from 256MB to 10TB and can be a float.

Maximum amount of memory to allocate for in-memory storage engine data,
including indexes, oplog if the mongod is part of replica set, replica set or
sharded cluster metadata, etc.

By default, the in-memory storage engine uses 50% of physical RAM minus 1 GB.

NOTE

ENTERPRISE FEATURE

Available in MongoDB Enterprise only.

OPERATIONPROFILING OPTIONS

operationProfiling: mode: <string> slowOpThresholdMs: <int> slowOpSampleRate: <double> filter: <string>

operationProfiling.mode

Type: string

Default: off

Specifies which operations should be profiled. The following profiler levels are
available:

Level
Description
off
The profiler is off and does not collect any data. This is the default profiler
level.
slowOp
The profiler collects data for operations that take longer than the value of
slowms.
all
The profiler collects data for all operations.

WARNING

Profiling can degrade performance and expose unencrypted query data in the
system log. Carefully consider any performance and security implications before
configuring and enabling the profiler on a production deployment.

See Profiler Overhead for more information on potential performance degradation.

operationProfiling.slowOpThresholdMs

Type: integer

Default: 100

The slow operation time threshold, in milliseconds. Operations that run for
longer than this threshold are considered slow.

When logLevel is set to 0, MongoDB records slow operations to the diagnostic log
at a rate determined by slowOpSampleRate.

At higher logLevel settings, all operations appear in the diagnostic log
regardless of their latency with the following exception: the logging of slow
oplog entry messages by the secondaries. The secondaries log only the slow oplog
entries; increasing the logLevel does not log all oplog entries.

This setting is available for mongod and mongos.

* For mongod instances, the setting affects both the diagnostic log and, if
enabled, the profiler.

* For mongos instances, the setting affects the diagnostic log only and not the
profiler, since profiling is not available on mongos.

operationProfiling.slowOpSampleRate

Type: double

Default: 1.0

The fraction of slow operations that should be profiled or logged.
operationProfiling.slowOpSampleRate accepts values between 0 and 1, inclusive.

Changed in version 4.0: The slowOpSampleRate setting is available for mongod and
mongos. In earlier versions, slowOpSampleRate is available for mongod only.

* For mongod instances, the setting affects both the diagnostic log and, if
enabled, the profiler.

* For mongos instances, the setting affects the diagnostic log only and not the
profiler since profiling is not available on mongos.

operationProfiling.filter

Type: string representation of a query document

A filter expression that controls which operations are profiled and logged.

When filter is set, slowOpThresholdMs and slowOpSampleRate are not used for
profiling and slow-query log lines.

When you set a profile filter in the configuration file, the filter applies to
all databases in the deployment. To set a profile filter for a specific
database, use the db.setProfilingLevel() method.

The option takes a string representation of a query document of the form:

{ <field1>: <expression1>, ... }

The <field> can be any field in the profiler output. The <expression> is a query
condition expression.

To specify a profiling filter in a configuration file, you must:

* Enclose the filter document in single quotes to pass the document as a
string.

* Use the YAML format of the configuration file.

For example, the following filter configures the profiler to log query
operations that take longer than 2 seconds:

operationProfiling: mode: all filter: '{ op: "query", millis: { $gt: 2000 } }'

New in version 4.4.2.

REPLICATION OPTIONS

replication: oplogSizeMB: <int> replSetName: <string> enableMajorityReadConcern: <boolean>

replication.oplogSizeMB

Type: integer

The maximum size in megabytes for the replication operation log (i.e., the
oplog).

NOTE

The oplog can grow past its configured size limit to avoid deleting the majority
commit point.

By default, the mongod process creates an oplog based on the maximum amount of
space available. For 64-bit systems, the oplog is typically 5% of available disk
space.

Once the mongod has created the oplog for the first time, changing the
replication.oplogSizeMB option will not affect the size of the oplog. To change
the maximum oplog size after starting the mongod, use replSetResizeOplog.
replSetResizeOplog enables you to resize the oplog dynamically without
restarting the mongod process. To persist the changes made using
replSetResizeOplog through a restart, update the value of oplogSizeMB.

See Oplog Size for more information.

The replication.oplogSizeMB setting is available only for mongod.

replication.replSetName

Type: string

The name of the replica set that the mongod is part of. All hosts in the replica
set must have the same set name.

If your application connects to more than one replica set, each set must have a
distinct name. Some drivers group replica set connections by replica set name.

The replication.replSetName setting is available only for mongod.

Starting in MongoDB 4.0:

* The setting replication.replSetName cannot be used in conjunction with
storage.indexBuildRetry.

replication.enableMajorityReadConcern

Default: true

Configures support for "majority" read concern.

Starting in MongoDB 5.0, enableMajorityReadConcern cannot be changed and is
always set to true. Attempting to start a storage engine that does not support
majority read concern with the --enableMajorityReadConcern option will fail and
return an error message.

In earlier versions of MongoDB, enableMajorityReadConcern was configurable.

WARNING

If you are using a three-member primary-secondary-arbiter (PSA) architecture,
consider the following:

* The write concern "majority" can cause performance issues if a secondary is
unavailable or lagging. For advice on how to mitigate these issues, see
Mitigate Performance Issues with PSA Replica Set.

* If you are using a global default "majority" and the write concern is less
than the size of the majority, your queries may return stale (not fully
replicated) data.

SHARDING OPTIONS

sharding: clusterRole: <string> archiveMovedChunks: <boolean>

sharding.clusterRole

Type: string

The role that the mongod instance has in the sharded cluster. Set this setting
to one of the following:

Value
Description
configsvr

Start this instance as a config server. The instance starts on port 27019 by
default.

When you configure a MongoDB instance as clusterRole configsvr you must also
specify a replSetName.

shardsvr

Start this instance as a shard. The instance starts on port 27018 by default.

When you configure a MongoDB instance as a a clusterRole shardsvr you must also
specify a replSetName.

NOTE

Setting sharding.clusterRole requires the mongod instance to be running with
replication. To deploy the instance as a replica set member, use the replSetName
setting and specify the name of the replica set.

The sharding.clusterRole setting is available only for mongod.

sharding.archiveMovedChunks

Type: boolean

Default: false.

During chunk migration, a shard does not save documents migrated from the shard.

AUDITLOG OPTIONS

NOTE

Available only in MongoDB Enterprise and MongoDB Atlas.

auditLog: destination: <string> format: <string> path: <string> filter: <string>

auditLog.auditEncryptionKeyIdentifier

Type: string

New in version 6.0.

Specifies the unique identifier of the Key Management Interoperability Protocol
(KMIP) key for audit log encryption.

You cannot use auditLog.auditEncryptionKeyIdentifier and
auditLog.localAuditKeyFile together.

NOTE

Available only in MongoDB Enterprise. MongoDB Enterprise and Atlas have
different configuration requirements.

auditLog.compressionMode

Type: string

New in version 5.3.

Specifies the compression mode for audit log encryption. You must also enable
audit log encryption using either auditLog.auditEncryptionKeyIdentifier or
auditLog.localAuditKeyFile.

auditLog.compressionMode can be set to one of these values:

Value
Description
zstd
Use the zstd algorithm to compress the audit log.
none (default)
Do not compress the audit log.

NOTE

Available only in MongoDB Enterprise. MongoDB Enterprise and Atlas have
different configuration requirements.

auditLog.destination

Type: string

When set, auditLog.destination enables auditing and specifies where mongos or
mongod sends all audit events.

auditLog.destination can have one of the following values:

Value
Description
syslog

Output the audit events to syslog in JSON format. Not available on Windows.
Audit messages have a syslog severity level of info and a facility level of
user.

The syslog message limit can result in the truncation of audit messages. The
auditing system will neither detect the truncation nor error upon its
occurrence.

console
Output the audit events to stdout in JSON format.
file
Output the audit events to the file specified in auditLog.path in the format
specified in auditLog.format.

NOTE

Available only in MongoDB Enterprise and MongoDB Atlas.

auditLog.filter

Type: string representation of a document

The filter to limit the types of operations the audit system records. The option
takes a string representation of a query document of the form:

{ <field1>: <expression1>, ... }

The <field> can be any field in the audit message, including fields returned in
the param document. The <expression> is a query condition expression.

To specify an audit filter, enclose the filter document in single quotes to pass
the document as a string.

To specify the audit filter in a configuration file, you must use the YAML
format of the configuration file.

NOTE

Available only in MongoDB Enterprise and MongoDB Atlas.

auditLog.format

Type: string

The format of the output file for auditing if destination is file. The
auditLog.format option can have one of the following values:

Value
Description
JSON
Output the audit events in JSON format to the file specified in auditLog.path.
BSON
Output the audit events in BSON binary format to the file specified in
auditLog.path.

Printing audit events to a file in JSON format degrades server performance more
than printing to a file in BSON format.

NOTE

Available only in MongoDB Enterprise and MongoDB Atlas.

auditLog.localAuditKeyFile

Type: string

New in version 5.3.

Specifies the path and file name for a local audit key file for audit log
encryption.

NOTE

Only use auditLog.localAuditKeyFile for testing because the key is not secured.
To secure the key, use auditLog.auditEncryptionKeyIdentifier and an external Key
Management Interoperability Protocol (KMIP) server.

You cannot use auditLog.localAuditKeyFile and
auditLog.auditEncryptionKeyIdentifier together.

NOTE

Available only in MongoDB Enterprise. MongoDB Enterprise and Atlas have
different configuration requirements.

auditLog.path

Type: string

The output file for auditing if destination has value of file. The auditLog.path
option can take either a full path name or a relative path name.

auditLog.runtimeConfiguration

Type: boolean

Specifies if a node allows runtime configuration of audit filters and the
auditAuthorizationSuccess variable. If true the node can take part in Online
Audit Filter Management.

MONGOS -ONLY OPTIONS

replication: localPingThresholdMs: <int>
sharding: configDB: <string>

replication.localPingThresholdMs

Type: integer

Default: 15

The ping time, in milliseconds, that mongos uses to determine which secondary
replica set members to pass read operations from clients. The default value of
15 corresponds to the default value in all of the client drivers.

When mongos receives a request that permits reads to secondary members, the
mongos will:

* Find the member of the set with the lowest ping time.

* Construct a list of replica set members that is within a ping time of 15
milliseconds of the nearest suitable member of the set.

If you specify a value for the replication.localPingThresholdMs option,
mongos will construct the list of replica members that are within the latency
allowed by this value.

* Select a member to read from at random from this list.

The ping time used for a member compared by the replication.localPingThresholdMs
setting is a moving average of recent ping times, calculated at most every 10
seconds. As a result, some queries may reach members above the threshold until
the mongos recalculates the average.

See the Read Preference for Replica Sets section of the read preference
documentation for more information.

sharding.configDB

Type: string

The configuration servers for the sharded cluster.

Config servers for sharded clusters are deployed as a replica set. The replica
set config servers must run the WiredTiger storage engine.

Specify the config server replica set name and the hostname and port of at least
one of the members of the config server replica set.

sharding: configDB: <configReplSetName>/cfg1.example.net:27019, cfg2.example.net:27019,...

The mongos instances for the sharded cluster must specify the same config server
replica set name but can specify hostname and port of different members of the
replica set.

WINDOWS SERVICE OPTIONS

processManagement: windowsService: serviceName: <string> displayName: <string> description: <string> serviceUser: <string> servicePassword: <string>

processManagement.windowsService.serviceName

Type: string

Default: MongoDB

The service name of mongos or mongod when running as a Windows Service. Use this
name with the net start <name> and net stop <name> operations.

You must use processManagement.windowsService.serviceName in conjunction with
either the --install or --remove option.

processManagement.windowsService.displayName

Type: string

Default: MongoDB

The name listed for MongoDB on the Services administrative application.

processManagement.windowsService.description

Type: string

Default: MongoDB Server

Run mongos or mongod service description.

You must use processManagement.windowsService.description in conjunction with
the --install option.

For descriptions that contain spaces, you must enclose the description in
quotes.

processManagement.windowsService.serviceUser

Type: string

The mongos or mongod service in the context of a certain user. This user must
have "Log on as a service" privileges.

You must use processManagement.windowsService.serviceUser in conjunction with
the --install option.

processManagement.windowsService.servicePassword

Type: string

The password for <user> for mongos or mongod when running with the
processManagement.windowsService.serviceUser option.

You must use processManagement.windowsService.servicePassword in conjunction
with the --install option.

REMOVED MMAPV1 OPTIONS

Starting in version 4.2, MongoDB removes the deprecated MMAPv1 storage engine
and the MMAPv1-specific configuration options:

Removed Configuration File Setting
Removed Command-line Option
storage.mmapv1.journal.commitIntervalMs

storage.mmapv1.journal.debugFlags
mongod --journalOptions
storage.mmapv1.nsSize
mongod --nssize
storage.mmapv1.preallocDataFiles
mongod --noprealloc
storage.mmapv1.quota.enforced
mongod --quota
storage.mmapv1.quota.maxFilesPerDB
mongod --quotaFiles
storage.mmapv1.smallFiles
mongod --smallfiles
storage.repairPath
mongod --repairpath
replication.secondaryIndexPrefetch
mongod --replIndexPrefetch

For earlier versions of MongoDB, refer to the corresponding version of the
manual. For example:

* https://www.mongodb.com/docs/v4.0

* https://www.mongodb.com/docs/v3.6

* https://www.mongodb.com/docs/v3.4

← Collation Locales and Default ParametersExternally Sourced Configuration File
Values →

On this page

About

* Careers
* Investor Relations
* Legal Notices
* Privacy Notices
* Security Information
* Trust Center

Support

* Contact Us
* Customer Portal
* Atlas Status
* Customer Support

Social

* GitHub
* Stack Overflow
* LinkedIn
* YouTube
* Twitter
* Twitch
* Facebook

By clicking "Accept All Cookies", you agree to the storing of cookies on your
device to enhance site navigation, analyze site usage, and assist in our
marketing efforts. You can enable and disable optional cookies as desired.Read
our Privacy Policy
Manage Cookies Accept All Cookies

PRIVACY PREFERENCE CENTER

"Cookies" are small files that enable us to store information while you visit
one of our websites. When you visit any website, it may store or retrieve
information on your browser, mostly in the form of cookies. This information
might be about you, your preferences or your device and is mostly used to make
the site work as you expect it to. The information does not usually directly
identify you, but it can give you a more personalized web experience. Because we
respect your right to privacy, you can choose not to allow some types of
cookies, but essential cookies are always enabled. Click on the different
category headings to find out more and change our default settings. However,
blocking some types of cookies may impact your experience of the site and the
services we are able to offer.
MongoDB Privacy Policy
Allow All

MANAGE CONSENT PREFERENCES

STRICTLY NECESSARY COOKIES

Always Active

These cookies are necessary for the website to function and cannot be switched
off in our systems. They are usually only set in response to actions made by you
which amount to a request for services, such as setting your privacy
preferences, logging in or filling in forms. You can set your browser to block
or alert you about these cookies, but some parts of the site will not then work.
These cookies do not store any personally identifiable information.

PERFORMANCE COOKIES

Performance Cookies

These cookies allow us to count visits and traffic sources so we can measure and
improve the performance of our site. They help us to know which pages are the
most and least popular and see how visitors move around the site. All
information these cookies collect is aggregated and therefore anonymous. If you
do not allow these cookies we will not know when you have visited our site, and
will not be able to monitor its performance.

FUNCTIONAL COOKIES

Functional Cookies

These cookies enable the website to provide enhanced functionality and
personalisation. They may be set by us or by third party providers whose
services we have added to our pages. If you do not allow these cookies then some
or all of these services may not function properly.

TARGETING COOKIES

Targeting Cookies

These cookies may be set through our site by our advertising partners. They may
be used by those companies to build a profile of your interests and show you
relevant adverts on other sites. They do not store directly personal
information, but are based on uniquely identifying your browser and internet
device. If you do not allow these cookies, you will experience less targeted
advertising.

SOCIAL MEDIA COOKIES

Social Media Cookies

These cookies are set by a range of social media services that we have added to
the site to enable you to share our content with your friends and networks. They
are capable of tracking your browser across other sites and building up a
profile of your interests. This may impact the content and messages you see on
other websites you visit. If you do not allow these cookies you may not be able
to use or see these sharing tools.

Back Button

COOKIE LIST

Search Icon
Filter Icon

Clear
checkbox label label
Apply Cancel
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label

Confirm My Choices

www.mongodb.com Open in urlscan Pro 2600:9000:2490:9e00:7:7859:3840:93a1 Public Scan

Form analysis 1 forms found in the DOM

GET https://mongodb.com/docs/search/

Text Content

www.mongodb.com Open in urlscan Pro
2600:9000:2490:9e00:7:7859:3840:93a1 Public Scan

Form analysis
1 forms found in the DOM