- Reference >
- Configuration File Options
Configuration File Options¶
The following page describes the configuration options available in MongoDB 3.6. For configuration file options for other versions of MongoDB, see the appropriate version of the MongoDB Manual.
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.
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.
- On Linux, a default
/etc/mongod.conf
configuration file is included when using a package manager to install MongoDB. - On macOS, a default
/usr/local/etc/mongod.conf
configuration file is included when installing from MongoDB’s official Homebrew tap.
File Format¶
Changed in version 2.6: MongoDB 2.6 introduced a YAML-based configuration file format. The 2.4 configuration file format remains for backward compatibility.
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.
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. |
Use the Configuration File¶
To start mongod
or mongos
using a config file,
specify the config file with the --config
option or the
-f
option, as in the following examples:
The following examples use mongod --config
and
mongos --config
to specify the configuration file:
You can also use the -f
alias to specify the configuration
file, as in the following:
If you installed from a package and have started MongoDB using your system’s init script, you are already using a configuration file.
Core Options¶
systemLog
Options¶
-
systemLog.
verbosity
¶ Type: integer
Default: 0
Changed in version 3.0.
The default log message verbosity level for components. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs.
The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
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 forACCESS
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.
-
systemLog.
quiet
¶ Type: boolean
Default: false
Run
mongos
ormongod
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
tosyslog
.
-
systemLog.
path
¶ Type: string
The path of the log file to which
mongod
ormongos
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 changesystemLog.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
ormongod
appends new entries to the end of the existing log file when themongos
ormongod
instance restarts. Without this option,mongod
will back up the existing log and create a new file.
-
systemLog.
logRotate
¶ Type: string
Default: rename
New in version 3.0.0.
The behavior for the
logRotate
command. Specify eitherrename
orreopen
:rename
renames the log file.reopen
closes and reopens the log file following the typical Linux/Unix log rotate behavior. Usereopen
when using the Linux/Unix logrotate utility to avoid log loss.If you specify
reopen
, you must also setsystemLog.logAppend
totrue
.
If auditing is enabled, the
logRotate
command also rotates the audit log according to the above parameters. For example, ifsystemLog.logRotate
is set torename
, the audit log will also be renamed.
-
systemLog.
destination
¶ Type: string
The destination to which MongoDB sends all log output. Specify either
file
orsyslog
. If you specifyfile
, you must also specifysystemLog.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 thefile
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 ctime
Displays timestamps as Wed Dec 31 18:17:54.811
.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-0500
systemLog.component
Options¶
-
systemLog.component.accessControl.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to access control. See
ACCESS
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.command.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to commands. See
COMMAND
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.control.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to control operations. See
CONTROL
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.ftdc.
verbosity
¶ Type: integer
Default: 0
New in version 3.2.
The log message verbosity level for components related to diagnostic data collection operations. See
FTDC
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.geo.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to geospatial parsing operations. See
GEO
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.index.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to indexing operations. See
INDEX
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.network.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to networking operations. See
NETWORK
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.query.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to query operations. See
QUERY
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.replication.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to replication. See
REPL
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.replication.heartbeats.
verbosity
¶ Type: integer
Default: 0
New in version 3.6.
The log message verbosity level for components related to heartbeats. See
REPL_HB
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.replication.rollback.
verbosity
¶ Type: integer
Default: 0
New in version 3.6.
The log message verbosity level for components related to rollback. See
ROLLBACK
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.sharding.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to sharding. See
SHARDING
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.storage.
verbosity
¶ Type: integer
Default: 0
New in version 3.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
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.storage.journal.
verbosity
¶ Type: integer
Default: 0
New in version 3.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 thesystemLog.component.storage.verbosity
level if set or the default verbosity level.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
-
systemLog.component.write.
verbosity
¶ Type: integer
Default: 0
New in version 3.0.
The log message verbosity level for components related to write operations. See
WRITE
components.The verbosity level can range from
0
to5
:0
is the MongoDB’s default log verbosity level, to include Informational messages.1
to5
increases the verbosity level to include Debug messages.
processManagement
Options¶
-
processManagement.
fork
¶ Type: boolean
Default: false
Enable a daemon mode that runs the
mongos
ormongod
process in the background. By defaultmongos
ormongod
does not run as a daemon: typically you will runmongos
ormongod
as a daemon, either by usingprocessManagement.fork
or by using a controlling process that handles the daemonization process (e.g. as withupstart
andsystemd
).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 changeprocessManagement.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
ormongod
process. The user running themongod
ormongos
process must be able to write to this path. If theprocessManagement.pidFilePath
option is not specified, the process does not create a PID file. This option is generally only useful in combination with theprocessManagement.fork
setting.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 withsystemctl
. Only use theprocessManagement.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.macOS
On macOS, PID file management is generally handled by
brew
. Only use theprocessManagement.pidFilePath
option if you are not usingbrew
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 release cycle of the time zone database differs from the release cycle of MongoDB. A copy of the most recent release of the time zone database can be downloaded from https://downloads.mongodb.org/olson_tz_db/timezonedb-latest.zip.
net
Options¶
-
net.
port
¶ Type: integer
Default:
- 27017 for
mongod
(if not a shard member or a config server member) ormongos
instance - 27018 if
mongod
is ashard member
- 27019 if
mongod
is aconfig server member
The TCP port on which the MongoDB instance listens for client connections.
- 27017 for
-
net.
bindIp
¶ Type: string
Default: localhost
Note
Starting in MongoDB 3.6,
mongos
ormongod
bind to localhost (127.0.0.1
) by default. See Default Bind to Localhost.The IP addresses and/or full Unix domain socket paths on which
mongos
ormongod
should listen for client connections. You may attachmongos
ormongod
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 startmongos
ormongod
withnet.ipv6 : true
to enable IPv6 support. Specifying an IPv6 address tonet.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
Tip
To avoid downtime, give each config server a logical DNS name (unrelated to the server’s physical or virtual hostname). Without logical DNS names, moving or renaming a config server requires shutting down every
mongod
andmongos
instance in the sharded cluster.Warning
Before binding to a non-localhost (e.g. publicly accessible) IP address, ensure you have secured your cluster from unauthorized access. For a complete list of security recommendations, see Security Checklist. At minimum, consider enabling authentication and hardening network infrastructure.
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 alternatively, use thenet.bindIpAll
setting.Note
net.bindIp
andnet.bindIpAll
are mutually exclusive. That is, you can specify one or the other, but not both.
-
net.
bindIpAll
¶ Type: boolean
Default: false
New in version 3.6.
If true, the
mongos
ormongod
instance binds to all IPv4 addresses (i.e.0.0.0.0
). Ifmongos
ormongod
starts withnet.ipv6 : true
,net.bindIpAll
also binds to all IPv6 addresses (i.e.::
).mongos
ormongod
only supports IPv6 if started withnet.ipv6 : true
. Specifyingnet.bindIpAll
alone does not enable IPv6 support.Warning
Before binding to a non-localhost (e.g. publicly accessible) IP address, ensure you have secured your cluster from unauthorized access. For a complete list of security recommendations, see Security Checklist. At minimum, consider enabling authentication and hardening network infrastructure.
Alternatively, set
net.bindIp
to::,0.0.0.0
to bind to all IP addresses.Note
net.bindIp
andnet.bindIpAll
are mutually exclusive. Specifying both options causesmongos
ormongod
to throw an error and terminate.
-
net.
maxIncomingConnections
¶ Type: integer
Default: 65536
The maximum number of simultaneous connections that
mongos
ormongod
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
, themongod
ormongos
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
totrue
to enable IPv6 support.mongos
/mongod
disables IPv6 support by default.Setting
net.ipv6
does not direct themongos
/mongod
to listen on any local IPv6 addresses or interfaces. To configure themongos
/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
totrue
.
- Configure
net.unixDomainSocket
Options¶
-
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
istrue
,mongos
ormongod
listens on the UNIX socket.The
mongos
ormongod
process always listens on the UNIX socket unless one of the following is true:net.unixDomainSocket.enabled
isfalse
--nounixsocket
is set. The command line option takes precedence over the configuration file setting.net.bindIp
is not setnet.bindIp
does not specify127.0.0.1
-
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
ormongod
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
isfalse
--nounixsocket
is setnet.bindIp
is not setnet.bindIp
does not specify127.0.0.1
-
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.ssl
Options¶
-
net.ssl.
sslOnNormalPorts
¶ Type: boolean
Deprecated since version 2.6: Use
net.ssl.mode: requireSSL
instead.Enable or disable TLS/SSL for
mongos
ormongod
.With
net.ssl.sslOnNormalPorts
, amongos
ormongod
requires TLS/SSL encryption for all connections on the default MongoDB port, or the port specified bynet.port
. By default,net.ssl.sslOnNormalPorts
is disabled.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
mode
¶ Type: string
New in version 2.6.
Enable or disable TLS/SSL or mixed TLS/SSL used for all network connections. The argument to the
net.ssl.mode
setting can be one of the following:Value Description disabled
The server does not use TLS/SSL. allowSSL
Connections between servers do not use TLS/SSL. For incoming connections, the server accepts both TLS/SSL and non-TLS/non-SSL. preferSSL
Connections between servers use TLS/SSL. For incoming connections, the server accepts both TLS/SSL and non-TLS/non-SSL. requireSSL
The server uses and accepts only TLS/SSL encrypted connections. Starting in version 3.4, if
--sslCAFile
orssl.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/SSL-enabled server.If using x.509 authentication,
--sslCAFile
orssl.CAFile
must be specified.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
PEMKeyFile
¶ Type: string
The
.pem
file that contains both the TLS/SSL certificate and key. Specify the file name of the.pem
file using relative or absolute paths.You must specify
net.ssl.PEMKeyFile
when TLS/SSL is enabled.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
PEMKeyPassword
¶ Type: string
The password to de-crypt the certificate-key file (i.e.
PEMKeyFile
). Use thenet.ssl.PEMKeyPassword
option only if the certificate-key file is encrypted. In all cases, themongos
ormongod
will redact the password from all logging and reporting output.Changed in version 2.6: If the private key in the PEM file is encrypted and you do not specify the
net.ssl.PEMKeyPassword
option, themongos
ormongod
will prompt for a passphrase. See TLS/SSL Certificate Passphrase.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
clusterFile
¶ Type: string
New in version 2.6.
The
.pem
file that contains the x.509 certificate-key file for membership authentication for the cluster or replica set.If
net.ssl.clusterFile
does not specify the.pem
file for internal cluster authentication, the cluster uses the.pem
file specified in thePEMKeyFile
setting.If using x.509 authentication,
--sslCAFile
orssl.CAFile
must be specified.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
clusterPassword
¶ Type: string
New in version 2.6.
The password to de-crypt the x.509 certificate-key file specified with
--sslClusterFile
. Use thenet.ssl.clusterPassword
option only if the certificate-key file is encrypted. In all cases, themongos
ormongod
will redact the password from all logging and reporting output.If the x.509 key file is encrypted and you do not specify the
net.ssl.clusterPassword
option, themongos
ormongod
will prompt for a passphrase. See TLS/SSL Certificate Passphrase.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
CAFile
¶ Type: string
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.Starting in version 3.4, if
--sslCAFile
orssl.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/SSL-enabled server.If using x.509 authentication,
--sslCAFile
orssl.CAFile
must be specified.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
clusterCAFile
¶ Type: string
New in version 3.6.9.
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.If
net.ssl.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 thenet.ssl.CAFile
option.net.ssl.clusterCAFile
lets you use separate Certificate Authorities to verify the client to server and server to client portions of the TLS handshake.Requires that
net.ssl.CAFile
is set.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
CRLFile
¶ Type: string
The
.pem
file that contains the Certificate Revocation List. Specify the file name of the.pem
file using relative or absolute paths.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
allowConnectionsWithoutCertificates
¶ Type: boolean
For clients that do not present certificates,
mongos
ormongod
bypasses TLS/SSL certificate validation when establishing the connection.For clients that present a certificate, however,
mongos
ormongod
performs certificate validation using the root certificate chain specified byCAFile
and reject clients with invalid certificates.Use the
net.ssl.allowConnectionsWithoutCertificates
option if you have a mixed deployment that includes clients that do not or cannot present certificates to themongos
ormongod
.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
allowInvalidCertificates
¶ Type: boolean
Enable or disable the validation checks for TLS/SSL certificates on other servers in the cluster and allows the use of invalid certificates to connect.
Note
Starting in MongoDB 3.6.6, if you specify
--sslAllowInvalidCertificates
orssl.allowInvalidCertificates: true
when using x.509 authentication, an invalid certificate is only sufficient to establish a TLS/SSL connection but is insufficient for authentication.When using the
net.ssl.allowInvalidCertificates
setting, MongoDB logs a warning regarding the use of the invalid certificate.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
allowInvalidHostnames
¶ Type: boolean
Default: false
New in version 3.0.
When
net.ssl.allowInvalidHostnames
istrue
, MongoDB disables the validation of the hostnames in TLS/SSL certificates, allowingmongod
to connect to MongoDB instances if the hostname their certificates do not match the specified hostname.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
net.ssl.
disabledProtocols
¶ Type: string
New in version 3.0.7.
Prevents a MongoDB server running with TLS/SSL from accepting incoming connections that use a specific protocol or protocols.
net.ssl.disabledProtocols
recognizes the following protocols:TLS1_0
,TLS1_1
,TLS1_2
, and starting in version 3.6.9,TLS1_3
.Specifying an unrecognized protocol will prevent the server from starting.
To specify multiple protocols, use a comma separated list of protocols.
Members of replica sets and sharded clusters must speak at least one protocol in common.
See also
-
net.ssl.
FIPSMode
¶ Type: boolean
Enable or disable the use of the FIPS mode of the installed OpenSSL library for the
mongos
ormongod
. Your system must have a FIPS compliant OpenSSL library to use thenet.ssl.FIPSMode
option.Note
FIPS-compatible TLS/SSL is available only in MongoDB Enterprise. See Configure MongoDB for FIPS for more information.
net.compression
Option¶
-
net.compression.
compressors
¶ Default: snappy
New in version 3.4.
Specifies the default compressor(s) to use for communication between this
mongod
ormongos
instance and:- other members of the deployment if the instance is part of a replica set or a sharded cluster
- a
mongo
shell - drivers that support the
OP_COMPRESSED
message format.
MongoDB supports the following compressors:
Starting in versions 3.6,
mongod
andmongos
enable network compression by default withsnappy
as the compressor.To disable network compression, set the value to
disabled
.Important
Messages are compressed when both parties enable network compression. Otherwise, messages between the parties are uncompressed.
If you specify multiple compressors, then the order in which you list the compressors matter as well as the communication initiator. For example, if a
mongo
shell specifies the following network compressorszlib,snappy
and themongod
specifiessnappy,zlib
, messages betweenmongo
shell andmongod
useszlib
.If the parties do not share at least one common compressor, messages between the parties are uncompressed. For example, if a
mongo
shell specifies the network compressorzlib
andmongod
specifiessnappy
, messages betweenmongo
shell andmongod
are not compressed.
-
net.
transportLayer
¶ Type: string
Default: asio
New in version 3.6.
The networking implementation the
mongos
ormongod
uses. To revert to the pre-version 3.6 implementation, change this option tolegacy
.Warning
Do not change this setting unless the MongoDB support team asks you to change it.
-
net.
serviceExecutor
¶ Type: string
Default: synchronous
New in version 3.6.
Determines the threading and execution model
mongos
ormongod
uses to execute client requests. The--serviceExecutor
option accepts one of the following values:Value Description synchronous
The mongos
ormongod
uses synchronous networking and manages its networking thread pool on a per connection basis. Previous versions of MongoDB managed threads in this way.adaptive
The
mongos
ormongod
uses the new experimental asynchronous networking mode with an adaptive thread pool which manages threads on a per request basis. This mode should have more consistent performance and use less resources when there are more inactive connections than database requests.Important
Using
adaptive
requiresnet.transportLayer
set toasio
.
security
Options¶
-
security.
keyFile
¶ Type: string
The path to a key file that stores the shared secret that MongoDB instances use to authenticate to each other in a sharded cluster or replica set.
keyFile
impliessecurity.authorization
. See Internal Authentication for more information.
-
security.
clusterAuthMode
¶ Type: string
Default: keyFile
New in version 2.6.
The authentication mode used for cluster authentication. If you use internal x.509 authentication, specify so here. This option can have one of the following values:
Value Description keyFile
Use a keyfile for authentication. Accept only keyfiles. sendKeyFile
For rolling upgrade purposes. Send a keyfile for authentication but can accept both keyfiles and x.509 certificates. sendX509
For rolling upgrade purposes. Send the x.509 certificate for authentication but can accept both keyfiles and x.509 certificates. x509
Recommended. Send the x.509 certificate for authentication and accept only x.509 certificates. Starting in version 3.4, if
--sslCAFile
orssl.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/SSL-enabled server.If using x.509 authentication,
--sslCAFile
orssl.CAFile
must be specified.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
Type: string
Default: disabled
Enable or disable Role-Based Access Control (RBAC) to govern each user’s access to database resources and operations.
Set this option to one of the following:
Value Description enabled
A user can access only the database resources and actions for which they have been granted privileges. disabled
A user can access any database and perform any action. See Role-Based Access Control for more information.
The
security.authorization
setting is available only formongod
.
-
security.
transitionToAuth
¶ Type: boolean
Default: false
New in version 3.4: Allows the
mongod
ormongos
to accept and create authenticated and non-authenticated connections to and from othermongod
andmongos
instances in the deployment. Used for performing rolling transition of replica sets or sharded clusters from a no-auth configuration to internal authentication. Requires specifying a internal authentication mechanism such assecurity.keyFile
.For example, if using keyfiles for internal authentication, the
mongod
ormongos
creates an authenticated connection with anymongod
ormongos
in the deployment using a matching keyfile. If the security mechanisms do not match, themongod
ormongos
utilizes a non-authenticated connection instead.A
mongod
ormongos
running withsecurity.transitionToAuth
does not enforce user access controls. Users may connect to your deployment without any access control checks and perform read, write, and administrative operations.Note
A
mongod
ormongos
running with internal authentication and withoutsecurity.transitionToAuth
requires clients to connect using user access controls. Update clients to connect to themongod
ormongos
using the appropriate user prior to restartingmongod
ormongos
withoutsecurity.transitionToAuth
.
-
security.
javascriptEnabled
¶ Type: boolean
Default: true
Enables or disables the server-side JavaScript execution. When disabled, you cannot use operations that perform server-side execution of JavaScript code, such as the
$where
query operator,mapReduce
command and thedb.collection.mapReduce()
method,group
command and thedb.collection.group()
method.
-
security.
redactClientLogData
¶ Type: boolean
New in version 3.4: Available in MongoDB Enterprise only.
A
mongod
ormongos
running withsecurity.redactClientLogData
redacts any message accompanying a given log event before logging. This prevents themongod
ormongos
from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.Use
security.redactClientLogData
in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.For example, a MongoDB deployment might store Personally Identifiable Information (PII) in one or more collections. The
mongod
ormongos
logs events such as those related to CRUD operations, sharding metadata, etc. It is possible that themongod
ormongos
may expose PII as a part of these logging operations. Amongod
ormongos
running withsecurity.redactClientLogData
removes any message accompanying these events before being output to the log, effectively removing the PII.Diagnostics on a
mongod
ormongos
running withsecurity.redactClientLogData
may be more difficult due to the lack of data related to a log event. See the process logging manual page for an example of the effect ofsecurity.redactClientLogData
on log output.On a running
mongod
ormongos
, usesetParameter
with theredactClientLogData
parameter to configure this setting.
-
security.
clusterIpSourceWhitelist
¶ Type: list
New in version 3.6.
A list of IP addresses/CIDR (Classless Inter-Domain Routing) ranges against which the
mongod
validates authentication requests from other members of the replica set and, if part of a sharded cluster, themongos
instances. Themongod
verifies that the originating IP is either explicitly in the list or belongs to a CIDR range in the list. If the IP address is not present, the server does not authenticate themongod
ormongos
.security.clusterIpSourceWhitelist
has no effect on amongod
started without authentication.security.clusterIpSourceWhitelist
requires specifying each IPv4/6 address or Classless Inter-Domain Routing (CIDR) range as a YAML list:Important
Ensure
security.clusterIpSourceWhitelist
includes the IP address or CIDR ranges that include the IP address of each replica set member ormongos
in the deployment to ensure healthy communication between cluster components.
Key Management Configuration Options¶
-
security.
enableEncryption
¶ Type: boolean
Default: false
New in version 3.2: Enables encryption for the WiredTiger storage engine. You must set to
true
to pass in encryption keys and configurations.Enterprise Feature
Available in MongoDB Enterprise only.
-
security.
encryptionCipherMode
¶ Type: string
Default:
AES256-CBC
New in version 3.2.
The cipher mode to use for encryption at rest:
Mode Description AES256-CBC
256-bit Advanced Encryption Standard in Cipher Block Chaining Mode AES256-GCM
256-bit Advanced Encryption Standard in Galois/Counter Mode Enterprise Feature
Available in MongoDB Enterprise only.
-
security.
encryptionKeyFile
¶ Type: string
New in version 3.2.
The path to the local keyfile when managing keys via process other than KMIP. Only set when managing keys via process other than KMIP. If data is already encrypted using KMIP, MongoDB will throw an error.
Requires
security.enableEncryption
to betrue
.Enterprise Feature
Available in MongoDB Enterprise only.
-
security.kmip.
keyIdentifier
¶ Type: string
New in version 3.2.
Unique KMIP identifier for an existing key within the KMIP server. Include to use the key associated with the identifier as the system key. You can only use the setting the first time you enable encryption for the
mongod
instance. Requiressecurity.enableEncryption
to be true.If unspecified, MongoDB will request that the KMIP server create a new key to utilize as the system key.
If the KMIP server cannot locate a key with the specified identifier or the data is already encrypted with a key, MongoDB will throw an error.
Enterprise Feature
Available in MongoDB Enterprise only.
-
security.kmip.
rotateMasterKey
¶ Type: boolean
Default: false
New in version 3.2.
If true, rotate the master key and re-encrypt the internal keystore.
Enterprise Feature
Available in MongoDB Enterprise only.
See also
-
security.kmip.
serverName
¶ Type: string
New in version 3.2.
Hostname or IP address of key management solution running a KMIP server. Requires
security.enableEncryption
to be true.Enterprise Feature
Available in MongoDB Enterprise only.
-
security.kmip.
port
¶ Type: string
Default: 5696
New in version 3.2.
Port number the KMIP server is listening on. Requires that a
security.kmip.serverName
be provided. Requiressecurity.enableEncryption
to be true.Enterprise Feature
Available in MongoDB Enterprise only.
-
security.kmip.
clientCertificateFile
¶ Type: string
New in version 3.2.
String containing the path to the client certificate used for authenticating MongoDB to the KMIP server. Requires that a
security.kmip.serverName
be provided.Enterprise Feature
Available in MongoDB Enterprise only.
-
security.kmip.
clientCertificatePassword
¶ Type: string
New in version 3.2.
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.Enterprise Feature
Available in MongoDB Enterprise only.
-
security.kmip.
serverCAFile
¶ Type: string
New in version 3.2.
Path to CA File. Used for validating secure client connection to KMIP server.
Enterprise Feature
Available in MongoDB Enterprise only.
security.sasl
Options¶
-
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.
For
mongo
shell and other MongoDB tools to connect to the newhostName
, see thegssapiHostName
option in themongo
shell and other tools.
-
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
mongo
shell and other MongoDB tools to connect to the newserviceName
, see thegssapiServiceName
option.
-
security.sasl.
saslauthdSocketPath
¶ Type: string
The path to the UNIX domain socket file for
saslauthd
.
security.ldap
Options¶
-
security.ldap.
servers
¶ Type: string
New in version 3.4: Available in MongoDB Enterprise only.
The LDAP server against which the
mongod
ormongos
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 usesecurity.ldap.servers
for listing every LDAP server in your infrastructure.This setting can be configured on a running
mongod
ormongos
usingsetParameter
.If unset,
mongod
ormongos
cannot use LDAP authentication or authorization.
-
security.ldap.bind.
queryUser
¶ Type: string
New in version 3.4: Available in MongoDB Enterprise only.
The identity with which
mongod
ormongos
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
withqueryPassword
.If unset,
mongod
ormongos
will not attempt to bind to the LDAP server.This setting can be configured on a running
mongod
ormongos
usingsetParameter
.Note
Windows MongoDB deployments can use
bindWithOSDefaults
instead ofqueryUser
andqueryPassword
. You cannot specify bothqueryUser
andbindWithOSDefaults
at the same time.
-
security.ldap.bind.
queryPassword
¶ Type: string
New in version 3.4: Available in MongoDB Enterprise only.
The password used to bind to an LDAP server when using
queryUser
. You must usequeryPassword
withqueryUser
.If unset,
mongod
ormongos
will not attempt to bind to the LDAP server.This setting can be configured on a running
mongod
ormongos
usingsetParameter
.Note
Windows MongoDB deployments can use
bindWithOSDefaults
instead ofqueryPassword
andqueryPassword
. You cannot specify bothqueryPassword
andbindWithOSDefaults
at the same time.
-
security.ldap.bind.
useOSDefaults
¶ Type: boolean
Default: false
New in version 3.4: Available in MongoDB Enterprise for the Windows platform only.
Allows
mongod
ormongos
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 replacequeryUser
andqueryPassword
.
-
security.ldap.bind.
method
¶ Type: string
Default: simple
New in version 3.4: Available in MongoDB Enterprise only.
The method
mongod
ormongos
uses to authenticate to an LDAP server. Use withqueryUser
andqueryPassword
to connect to the LDAP server.method
supports the following values:simple
-mongod
ormongos
uses simple authentication.sasl
-mongod
ormongos
uses SASL protocol for authentication
If you specify
sasl
, you can configure the available SASL mechanisms usingsecurity.ldap.bind.saslMechanisms
.mongod
ormongos
defaults to usingDIGEST-MD5
mechanism.
-
security.ldap.bind.
saslMechanisms
¶ Type: string
Default: DIGEST-MD5
New in version 3.4: Available in MongoDB Enterprise only.
A comma-separated list of SASL mechanisms
mongod
ormongos
can use when authenticating to the LDAP server. Themongod
ormongos
and the LDAP server must agree on at least one mechanism. Themongod
ormongos
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
ormongos
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 themongod
ormongos
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
ormongos
to use when connecting to the LDAP server and execute LDAP queries.
- The
Windows
- If 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
totrue
to allowmongod
ormongos
to use the generated credentials when connecting to the Active Directory server and execute queries.
Set
method
tosasl
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
New in version 3.4: Available in MongoDB Enterprise only.
By default,
mongod
ormongos
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 thelibldap
dependency. See the documentation forTLS 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
tonone
to disable TLS/SSL betweenmongod
ormongos
and the LDAP server.Warning
Setting
transportSecurity
tonone
transmits plaintext information and possibly credentials betweenmongod
ormongos
and the LDAP server.
-
security.ldap.
timeoutMS
¶ Type: int
Default: 10000
New in version 3.4: Available in MongoDB Enterprise only.
The amount of time in milliseconds
mongod
ormongos
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 oftimeoutMS
reduces the time MongoDB waits for a response from the LDAP server.This setting can be configured on a running
mongod
ormongos
usingsetParameter
.
-
security.ldap.
userToDNMapping
¶ Type: string
New in version 3.4: Available in MongoDB Enterprise only.
Maps the username provided to
mongod
ormongos
for authentication to a LDAP Distinguished Name (DN). You may need to useuserToDNMapping
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 expressionmatch
and either asubstitution
orldapQuery
template used for transforming the incoming username.Each document in the array has the following form:
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
orldapQuery
."(.+)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 thematch
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 thematch
expression.mongod
ormongos
executes the query against the LDAP server to retrieve the LDAP DN for the authenticated user.mongod
ormongos
requires exactly one returned result for the transformation to be successful, ormongod
ormongos
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
orldapQuery
. You cannot specify both in the same document.When performing authentication or authorization,
mongod
ormongos
steps through each document in the array in the given order, checking the authentication username against thematch
filter. If a match is found,mongod
ormongos
applies the transformation and uses the output for authenticating the user.mongod
ormongos
does not check the remaining documents in the array.If the given document does not match the provided authentication name, or the transformation described by the document fails,
mongod
ormongos
continues through the list of documents to find additional matches. If no matches are found in any document,mongod
ormongos
returns an error.Example
The following shows two transformation documents. The first document matches against any string ending in
@ENGINEERING
, placing anything preceeding the suffix into a regex capture group. The second document matches against any string ending in@DBA
, placing anything preceeding the suffix into a regex capture group.Important
You must pass the array to
userToDNMapping
as a string.A user with username
alice@ENGINEERING.EXAMPLE.COM
matches the first document. The regex capture group{0}
corresponds to the stringalice
. 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 stringbob
. The resulting output is the LDAP query"ou=dba,dc=example,dc=com??one?(user=bob)"
.mongod
ormongos
executes this query against the LDAP server, returning the result"cn=bob,ou=dba,dc=example,dc=com"
.If
userToDNMapping
is unset,mongod
ormongos
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
ormongos
using thesetParameter
database command.
-
security.ldap.authz.
queryTemplate
¶ Type: string
New in version 3.4: 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 insecurity.ldap.servers
.Use the
{USER}
placeholder in the URL to substitute the authenticated username, or the transformed username if auserToDNMapping
is specified.When constructing the query URL, ensure that the order of LDAP parameters respects RFC4516:
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 theadmin
database. If a role on the on theadmin
database exactly matches the DN,mongod
grants the user the roles and privileges assigned to that role. See thedb.createRole()
method for more information on creating roles.Example
This LDAP query returns any groups listed in the LDAP user object’s
memberOf
attribute.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 thesetParameter
database command.
-
security.ldap.
validateLDAPServerConfig
¶ Type: boolean
Default: true
Available in MongoDB Enterprise
A flag that determines if the
mongod
ormongos
instance checks the availability of theLDAP server(s)
as part of its startup:- If
true
, themongod
ormongos
instance performs the availability check and only continues to start up if the LDAP server is available. - If
false
, themongod
ormongos
instance skips the availability check; i.e. the instance starts up even if the LDAP server is unavailable.
New in version 3.6.3.
- If
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:
For example, to specify the
enableLocalhostAuthBypass
in the configuration file:
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. Aftermongod
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 timemongod
and the LDAP server can be out of sync while increasing the load on the LDAP server.
storage
Options¶
-
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 formongod
.Configuration Files
The default
mongod.conf
configuration file included with package manager installations uses the following platform-specific default values forstorage.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 changestorage.dbPath
, you will have to use your own init scripts and disable the built-in scripts.
-
storage.
indexBuildRetry
¶ Type: boolean
Default: true
Specifies whether
mongod
rebuilds incomplete indexes on the next start up. This applies in cases wheremongod
restarts after it has shut down or stopped in the middle of an index build. In such cases,mongod
always removes any incomplete indexes, and then, by default, attempts to rebuild them. To stopmongod
from rebuilding indexes, set this option tofalse
.The
storage.indexBuildRetry
setting is available only formongod
.Not available for
mongod
instances that use the in-memory storage engine.
-
storage.
repairPath
¶ Type: string
Default: A
_tmp_repairDatabase_<num>
directory under thedbPath
.The working directory that MongoDB will use during the
--repair
operation. When--repair
completes, thestorage.repairPath
directory is empty, anddbPath
contains the repaired files.The
storage.repairPath
setting is available only formongod
.Only available for
mongod
instance using the MMAPv1 storage engine.
-
storage.journal.
enabled
¶ Type: boolean
Default:
true
on 64-bit systems,false
on 32-bit systemsEnable or disable the durability journal to ensure data files remain valid and recoverable. This option applies only when you specify the
storage.dbPath
setting.mongod
enables journaling by default.The
storage.journal.enabled
setting is available only formongod
.Not available for
mongod
instances that use the in-memory storage engine.If any voting member of a replica set runs without journaling (i.e. either runs an in-memory storage engine or runs with journaling disabled), you must set
writeConcernMajorityJournalDefault
tofalse
.
-
storage.journal.
commitIntervalMs
¶ Type: number
Default: 100 or 30
New in version 3.2.
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. The default journal commit interval is 100 milliseconds.On MMAPv1, if the journal is on a different block device (e.g. physical volume, RAID device, or LVM volume) than the data files, the default journal commit interval is 30 milliseconds. Additionally, on MMAPv1, when a write operation with
j:true
is pending,mongod
will reducecommitIntervalMs
to a third of the set value.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 for WiredTiger, see Journaling Process.The
storage.journal.commitIntervalMs
setting is available only formongod
.Not available for
mongod
instances that use the in-memory storage engine.
-
storage.
directoryPerDB
¶ Type: boolean
Default: false
When
true
, MongoDB uses a separate directory to store data for each database. The directories are under thestorage.dbPath
directory, and each subdirectory name corresponds to the database name.Changed in version 3.0: To change the
storage.directoryPerDB
option for existing deployments, you must restart themongod
instances with the newstorage.directoryPerDB
value and a new data directory (storage.dbPath
value), and then repopulate the data.- For standalone instances, you can use
mongodump
on the existing instance, stop the instance, restart with the newstorage.directoryPerDB
value and a new data directory, and usemongorestore
to populate the new data directory. - For replica sets, you can update in a rolling manner by stopping
a secondary member, restart with the new
storage.directoryPerDB
value and a new data directory, and use initial sync to populate the new data directory. To update all members, start with the secondary members first. Then step down the primary, and update the stepped-down member.
The
storage.directoryPerDB
setting is available only formongod
.Not available for
mongod
instances that use the in-memory storage engine.- For standalone instances, you can use
-
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
to0
, 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 thejournal
files or journaling, but ifstorage.syncPeriodSecs
is set to0
the journal will eventually consume all available disk space. If you setstorage.syncPeriodSecs
to0
for testing purposes, you should also set--nojournal
totrue
.The
serverStatus
command reports the background flush thread’s status via thebackgroundFlushing
field.The
storage.syncPeriodSecs
setting is available only formongod
.Not available for
mongod
instances that use the in-memory storage engine.
-
storage.
engine
¶ Default:
wiredTiger
New in version 3.0.
Changed in version 3.2: Starting in MongoDB 3.2,
wiredTiger
is the default.The storage engine for the
mongod
database. Available values include:Value Description mmapv1
To specify the MMAPv1 Storage Engine. wiredTiger
To specify the WiredTiger Storage Engine. inMemory
To specify the In-Memory Storage Engine.
New in version 3.2: Available in MongoDB Enterprise only.
If you attempt to start a
mongod
with astorage.dbPath
that contains data files produced by a storage engine other than the one specified bystorage.engine
,mongod
will refuse to start.
storage.mmapv1
Options¶
-
storage.mmapv1.
preallocDataFiles
¶ Type: boolean
Default: true
Only available for the MMAPv1 storage engine.
Enables or disables the preallocation of data files. By default, MongoDB does not preallocate data files.
The
storage.mmapv1.preallocDataFiles
setting is available only formongod
.
-
storage.mmapv1.
nsSize
¶ Type: integer
Default: 16
Only available for the MMAPv1 storage engine.
The default size for namespace files, which are files that end in
.ns
. Each collection and index counts as a namespace.Use this setting to control size for newly created namespace files. This option has no impact on existing files. The maximum size for a namespace file is 2047 megabytes. The default value of 16 megabytes provides for approximately 24,000 namespaces.
The
storage.mmapv1.nsSize
setting is available only formongod
.
-
storage.mmapv1.quota.
enforced
¶ Type: Boolean
Default: false
Only available for the MMAPv1 storage engine.
Enable or disable the enforcement of a maximum limit for the number data files each database can have. When running with the
storage.mmapv1.quota.enforced
option, MongoDB has a maximum of 8 data files per database. Adjust the quota withstorage.quota.maxFilesPerDB
.The
storage.mmapv1.quota.enforced
setting is available only formongod
.
-
storage.mmapv1.quota.
maxFilesPerDB
¶ Type: integer
Default: 8
Only available for the MMAPv1 storage engine.
The limit on the number of data files per database.
storage.mmapv1.quota.maxFilesPerDB
option requires that you setstorage.quota.enforced
.The
storage.mmapv1.quota.maxFilesPerDB
setting is available only formongod
.
-
storage.mmapv1.
smallFiles
¶ Type: boolean
Default: false
Only available for the MMAPv1 storage engine.
When
true
, MongoDB uses a smaller default file size. Thestorage.mmapv1.smallFiles
option reduces the initial size for data files and limits the maximum size to 512 megabytes.storage.mmapv1.smallFiles
also reduces the size of each journal file from 1 gigabyte to 128 megabytes. Usestorage.mmapv1.smallFiles
if you have a large number of databases that each holds a small quantity of data.The
storage.mmapv1.smallFiles
option can lead themongod
instance to create a large number of files, which can affect performance for larger databases.The
storage.mmapv1.smallFiles
setting is available only formongod
.
-
storage.mmapv1.journal.
debugFlags
¶ Type: integer
Only available for the MMAPv1 storage engine.
Provides functionality for testing. Not for general use, and will affect data file integrity in the case of abnormal system shutdown.
The
storage.mmapv1.journal.debugFlags
option is available only formongod
.
-
storage.mmapv1.journal.
commitIntervalMs
¶ Type: number
Deprecated since version 3.2: MongoDB 3.2 deprecates the
storage.mmapv1.journal.commitIntervalMs
setting. Usestorage.journal.commitIntervalMs
instead.The deprecated setting acts as an alias to the new
storage.journal.commitIntervalMS
setting and applies to either the MMAPv1 or the WiredTiger storage engine.
storage.wiredTiger
Options¶
-
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. Starting in MongoDB 3.4, the values can range from 0.25 GB to 10000 GB and can be a float.Starting in MongoDB 3.4, the default WiredTiger internal cache size is the larger of either:
- 50% of (RAM - 1 GB), or
- 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 othermongod
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 setstorage.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. SeememLimitMB
.
-
storage.wiredTiger.engineConfig.
journalCompressor
¶ Default: snappy
New in version 3.0.0.
The type of compression to use to compress WiredTiger journal data.
Available compressors are:
For details on changing the journal compressor, see Change WT Journal Compressor.
-
storage.wiredTiger.engineConfig.
directoryForIndexes
¶ Type: boolean
Default: false
New in version 3.0.0.
When
storage.wiredTiger.engineConfig.directoryForIndexes
istrue
,mongod
stores indexes and collections in separate subdirectories under the data (i.e.storage.dbPath
) directory. Specifically,mongod
stores the indexes in a subdirectory namedindex
and the collection data in a subdirectory namedcollection
.By using a symbolic link, you can specify a different location for the indexes. Specifically, when
mongod
instance is not running, move theindex
subdirectory to the destination and create a symbolic link namedindex
under the data directory to the new destination.
-
storage.wiredTiger.engineConfig.
maxCacheOverflowFileSizeGB
¶ Type: float
Specifies the maximum size (in GB) for the “lookaside (or cache overflow) table” file
WiredTigerLAS.wt
.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 theWiredTigerLAS.wt
file and restartmongod
.To change the maximum size during runtime, use the
wiredTigerMaxCacheOverflowSizeGB
parameter.Available in 3.6-series starting in 3.6.15
-
storage.wiredTiger.collectionConfig.
blockCompressor
¶ Default: snappy
New in version 3.0.0.
The default type of compression to use to compress collection data. You can override this on a per-collection basis when creating collections.
Available compressors are:
storage.wiredTiger.collectionConfig.blockCompressor
affects all collections created. If you change the value ofstorage.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
New in version 3.0.0.
Enables or disables prefix compression for index data.
Specify
true
forstorage.wiredTiger.indexConfig.prefixCompression
to enable prefix compression for index data, orfalse
to disable prefix compression for index data.The
storage.wiredTiger.indexConfig.prefixCompression
setting affects all indexes created. If you change the value ofstorage.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
¶ Type: float
Default: 50% of physical RAM less 1 GB
Changed in version 3.4: 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.
Enterprise Feature
Available in MongoDB Enterprise only.
operationProfiling
Options¶
-
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. Important
Profiling can impact performance and shares settings with 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 to0
, MongoDB records slow operations to the diagnostic log at a rate determined byslowOpSampleRate
. For MongoDB 3.6 deployments, starting in version 3.6.11, the secondaries of replica sets log all oplog entry messages that take longer than the slow operation threshold to apply regardless of the sample rate.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 thelogLevel
does not log all oplog entries.See also
The
operationProfiling.slowOpThresholdMs
setting is available only formongod
.
-
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.operationProfiling.slowOpSampleRate
does not affect the slow oplog entry logging by the secondary members of a replica set. Secondary members log all oplog entries that take longer than the slow operation threshold regardless of theoperationProfiling.slowOpSampleRate
.For
mongod
instances,operationProfiling.slowOpSampleRate
affects the diagnostic log and, if enabled, the profiler.
replication
Options¶
-
replication.
oplogSizeMB
¶ Type: integer
The maximum size in megabytes for the replication operation log (i.e., the oplog). 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 thereplication.oplogSizeMB
option will not affect the size of the oplog. Use thereplSetResizeOplog
administrative command to change the oplog size of a runningmongod
replica set member.replSetResizeOplog
enables you to resize the oplog dynamically without restarting themongod
process.See Oplog Size for more information.
The
replication.oplogSizeMB
setting is available only formongod
.
-
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 should have a distinct name. Some drivers group replica set connections by replica set name.
The
replication.replSetName
setting is available only formongod
.
-
replication.
secondaryIndexPrefetch
¶ Type: string
Default: all
Storage Engine Specific Feature
replication.secondaryIndexPrefetch
is only available with themmapv1
storage engine.The indexes that secondary members of a replica set load into memory before applying operations from the oplog. By default secondaries load all indexes related to an operation into memory before applying operations from the oplog.
Set this setting to one of the following:
Value Description none
Secondaries do not load indexes into memory. all
Secondaries load all indexes related to an operation. _id_only
Secondaries load no additional indexes into memory beyond the already existing _id
index.The
replication.secondaryIndexPrefetch
setting is available only formongod
.
-
replication.
enableMajorityReadConcern
¶ Default: true
Available for MongoDB 3.6.1 - 3.6.x
Starting in MongoDB 3.6, MongoDB enables support for
"majority"
read concern by default.For MongoDB 3.6.1 - 3.6.x, you can disable read concern
"majority"
to prevent the storage cache pressure from immobilizing a deployment with a three-member primary-secondary-arbiter (PSA) architecture. For more information about disabling read concern"majority"
, see Disable Read Concern Majority.To disable, set
replication.enableMajorityReadConcern
to false.Important
In general, avoid disabling
"majority"
read concern unless necessary. However, if you have a three-member replica set with a primary-secondary-arbiter (PSA) architecture or a sharded cluster with three-member PSA shards, disable to prevent the storage cache pressure from immobilizing the deployment.Disabling
"majority"
read concern disables support for Change Streams.replication.enableMajorityReadConcern
has no effect for MongoDB 3.6.0.
sharding
Options¶
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.shardsvr
Start this instance as a shard. The instance starts on port 27018
by default.Note
Setting
sharding.clusterRole
requires themongod
instance to be running with replication. To deploy the instance as a replica set member, use thereplSetName
setting and specify the name of the replica set.The
sharding.clusterRole
setting is available only formongod
.
Type: boolean
Changed in version 3.2: Starting in 3.2, MongoDB uses
false
as the default.During chunk migration, a shard does not save documents migrated from the shard.
auditLog
Options¶
Note
Available only in MongoDB Enterprise.
-
auditLog.
destination
¶ Type: string
New in version 2.6.
When set,
auditLog.destination
enables auditing and specifies wheremongos
ormongod
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 ofuser
.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 inauditLog.format
.Note
Available only in MongoDB Enterprise.
-
auditLog.
format
¶ Type: string
New in version 2.6.
The format of the output file for auditing if
destination
isfile
. TheauditLog.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.
-
auditLog.
path
¶ Type: string
New in version 2.6.
The output file for auditing if
destination
has value offile
. TheauditLog.path
option can take either a full path name or a relative path name.Note
Available only in MongoDB Enterprise.
-
auditLog.
filter
¶ Type: string representation of a document
New in version 2.6.
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:
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.
snmp
Options¶
Note
MongoDB Enterprise on macOS does not include support for SNMP due to SERVER-29352.
-
snmp.
subagent
¶ Type: boolean
When
snmp.subagent
istrue
, SNMP runs as a subagent. For more information, see Monitor MongoDB With SNMP on Linux.The
snmp.subagent
setting is available only formongod
.
-
snmp.
master
¶ Type: boolean
When
snmp.master
istrue
, SNMP runs as a master. For more information, see Monitor MongoDB With SNMP on Linux.The
snmp.master
setting is available only formongod
.
mongos
-only Options¶
Changed in version 3.4: MongoDB 3.4 removes sharding.chunkSize
and
sharding.autoSplit
settings.
-
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 of15
corresponds to the default value in all of the client drivers.When
mongos
receives a request that permits reads to secondary members, themongos
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 themongos
recalculates the average.See the Read Preference for Replica Sets section of the read preference documentation for more information.
Type: string
Changed in version 3.2.
The configuration servers for the sharded cluster.
Starting in MongoDB 3.2, config servers for sharded clusters can be deployed as a replica set. The replica set config servers must run the WiredTiger storage engine. MongoDB 3.2 deprecates the use of three mirrored
mongod
instances for config servers.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.
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
¶ Type: string
Default: MongoDB
The service name of
mongos
ormongod
when running as a Windows Service. Use this name with thenet start <name>
andnet 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
ormongod
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
ormongod
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>
formongos
ormongod
when running with theprocessManagement.windowsService.serviceUser
option.You must use
processManagement.windowsService.servicePassword
in conjunction with the--install
option.