mongodb/mongo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

SERVER-116419: Update man pages for 8.3 (#51744)

Browse Source 
GitOrigin-RevId: 0bcfbeb9e4bc60dd97c44690951bd7be50edeafd
This commit is contained in:
Madison Hoover 2026-04-14 09:10:24 -04:00 committed by MongoDB Bot
parent ef93d289ce
commit 2dbbd641f6
5 changed files with 969 additions and 268 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

204
debian/mongod.1 vendored
View File

@ -1,5 +1,5 @@
.TH mongod 1 .TH mongod 1
.SH MONGOD .SH MONGOD INSTANCES
.SH SYNOPSIS .SH SYNOPSIS
\fBmongod\f1 is the primary daemon process for the MongoDB \fBmongod\f1 is the primary daemon process for the MongoDB
system. It handles data requests, manages data access, and performs system. It handles data requests, manages data access, and performs
@ -13,8 +13,8 @@ your database.
.PP .PP
\fBSelf\-Managed Configuration File Settings and Command\-Line Options Mapping\f1 \fBSelf\-Managed Configuration File Settings and Command\-Line Options Mapping\f1
.PP .PP
MongoDB disables support for TLS 1.0 MongoDB disables support for TLS 1.0 and TLS 1.1
encryption on systems where TLS 1.1+ is available. encryption on systems where TLS 1.2+ is available.
.SH COMPATIBILITY .SH COMPATIBILITY
.PP .PP
Deployments hosted in the following environments use \fBmongod\f1: Deployments hosted in the following environments use \fBmongod\f1:
@ -254,7 +254,7 @@ list, for example: \fBrest, exec\f1\&. If the configuration file contains
expansion directives not specified to \fB\-\-configExpand\f1\f1, the \fBmongod\f1 expansion directives not specified to \fB\-\-configExpand\f1\f1, the \fBmongod\f1
returns an error and terminates. returns an error and terminates.
.PP .PP
See \fBExternally Sourced Configuration File Values for Self\-Managed Deployments\f1 for configuration files See \fBExternal Configuration Values for Self\-Managed MongoDB\f1 for configuration files
for more information on expansion directives. for more information on expansion directives.
.RE .RE
.PP .PP
@ -501,8 +501,8 @@ always listens on the UNIX socket unless one of the following is true:
\fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address \fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address
.RE .RE
.PP .PP
\fBmongod\f1 installed from official \fBInstall MongoDB Community Edition on Debian\f1 \fBmongod\f1 installed from official \fBInstall MongoDB Community Edition\f1
and \fBInstall MongoDB Community Edition on Red Hat or CentOS\f1 packages and \fBInstall MongoDB Community Edition\f1 packages
have the \fBbind_ip\f1 configuration set to \fB127.0.0.1\f1 by have the \fBbind_ip\f1 configuration set to \fB127.0.0.1\f1 by
default. default.
.RE .RE
@ -512,7 +512,7 @@ default.
.PP .PP
Outputs the \fBmongod\f1 instance\(aqs configuration options, formatted Outputs the \fBmongod\f1 instance\(aqs configuration options, formatted
in YAML, to \fBstdout\f1 and exits the \fBmongod\f1 instance. For in YAML, to \fBstdout\f1 and exits the \fBmongod\f1 instance. For
configuration options that uses \fBExternally Sourced Configuration File Values for Self\-Managed Deployments\f1, configuration options that uses \fBExternal Configuration Values for Self\-Managed MongoDB\f1,
\fB\-\-outputConfig\f1\f1 returns the resolved value for those options. \fB\-\-outputConfig\f1\f1 returns the resolved value for those options.
.PP .PP
This may include any configured passwords or secrets previously This may include any configured passwords or secrets previously
@ -586,6 +586,8 @@ replication activity
connection accepted events connection accepted events
.IP \(bu 2 .IP \(bu 2
connection closed events connection closed events
.IP \(bu 2
client metadata
.RE .RE
.RE .RE
.PP .PP
@ -1241,9 +1243,12 @@ an empty mapping document causes mapping to fail.
.PP .PP
The following shows two transformation documents. The first The following shows two transformation documents. The first
document matches against any string ending in \fB@ENGINEERING\f1, placing document matches against any string ending in \fB@ENGINEERING\f1, placing
anything preceeding the suffix into a regex capture group. The anything preceding the suffix into a regex capture group. The
second document matches against any string ending in \fB@DBA\f1, placing second document matches against any string ending in \fB@DBA\f1, placing
anything preceeding the suffix into a regex capture group. anything preceding the suffix into a regex capture group.
.PP
IMPORTANT You must pass the array to
\fB\-\-ldapUserToDNMapping\f1\f1 as a string.
.PP .PP
.EX .EX
"[ "[
@ -1596,60 +1601,19 @@ WiredTiger cache memory.
Avoid increasing the WiredTiger internal cache size above its Avoid increasing the WiredTiger internal cache size above its
default value. If your use case requires to do so, you can use default value. If your use case requires to do so, you can use
\fB\-\-wiredTigerCacheSizePct\f1\f1 to specify a percentage of up to 80% of available \fB\-\-wiredTigerCacheSizePct\f1\f1 to specify a percentage of up to 80% of available
memory. Values can range from \fB0.25\f1 GB to \fB10000\f1 GB. memory. Values can range from 0.256GB to 10000GB.
.PP .PP
The default WiredTiger internal cache size is the larger of either: To learn more, see \fBMemory Use\f1\&.
.RS
.IP \(bu 2
50% of (RAM \- 1 GB), or
.IP \(bu 2
256 MB.
.RE
.PP .PP
For example, on a system with a total of 4GB of RAM the In some instances, such as when running in a container that is configured
WiredTiger cache uses 1.5GB of RAM (\fB0.5 * (4 GB \- 1 GB) = to use less RAM than the amount of memory provisioned for the host, you
1.5 GB\f1). Conversely, on a system with a total of 1.25 GB of must account for the limits. You may need to configure the WiredTiger cache
RAM WiredTiger allocates 256 MB to the WiredTiger cache to an appropriate value, as WiredTiger may not account for the memory
because that is more than half of the total RAM minus one limits of the specific container in certain cases.
gigabyte (\fB0.5 * (1.25 GB \- 1 GB) = 128 MB < 256 MB\f1).
.PP .PP
In some instances, such as when running in a container, the database To view the \fBmemory limit\f1\f1, the value
can have memory constraints that are lower than the total system that WiredTiger utilizes as the maximum amount of RAM available use the
memory. In such instances, this memory limit, rather than the total \fBhostInfo\f1\f1 command.
system memory, is used as the maximum RAM available.
.PP
To see the memory limit, see \fBhostInfo.system.memLimitMB\f1\f1\&.
.PP
With WiredTiger, MongoDB utilizes both the WiredTiger internal cache
and the filesystem cache.
.PP
With the filesystem cache, MongoDB automatically uses all free memory
that is not used by the WiredTiger cache or by other processes.
.PP
The \fB\-\-wiredTigerCacheSizeGB\f1\f1 limits the size of the WiredTiger internal
cache. The operating system uses the available free memory
for filesystem cache, which allows the compressed MongoDB data
files to stay in memory. In addition, the operating system
uses any free RAM to buffer file system blocks and file system
cache.
.PP
To accommodate the additional consumers of RAM, you may have to
decrease WiredTiger internal cache size.
.PP
The default WiredTiger internal cache size value assumes that there is a
single \fBmongod\f1\f1 instance per machine. If a single machine
contains multiple MongoDB instances, decrease the setting to accommodate
the other \fBmongod\f1\f1 instances.
.PP
If you run \fBmongod\f1\f1 in a container (for example, \fBlxc\f1,
\fBcgroups\f1, Docker, etc.) that does \fInot\f1 have access to all of the
RAM available in a system, you must set \fB\-\-wiredTigerCacheSizeGB\f1\f1 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
\fBmemLimitMB\f1\f1\&.
.PP
You can only provide one of either \fB\-\-wiredTigerCacheSizeGB\f1\f1 or
\fB\-\-wiredTigerCacheSizePct\f1\f1\&.
.RE .RE
.PP .PP
\fBmongod \-\-wiredTigerCacheSizePct\f1 \fBmongod \-\-wiredTigerCacheSizePct\f1
@ -1661,32 +1625,21 @@ percentage of physical RAM. The memory that an index build consumes (see
WiredTiger cache memory. WiredTiger cache memory.
.PP .PP
You can specify a percentage of up to 80% of available memory. You can specify a percentage of up to 80% of available memory.
Values range from \fB0.25\f1 GB to \fB10000\f1 GB. Calculated values range from 0.256GB to 10000GB. For example, on a
system with 2GB of RAM the \fB\-\-wiredTigerCacheSizePct\f1 cannot be set to 10
because 10% of 2GB is 0.2GB, which is less than 0.256GB.
.PP .PP
The default WiredTiger internal cache size is the larger of either: To learn more about memory limits, see \fBMemory Use\f1\&.
.RS
.IP \(bu 2
50% of (RAM \- 1 GB), or
.IP \(bu 2
256 MB.
.RE
.PP .PP
For example, on a system with a total of 4GB of RAM the In some instances, such as when running in a container that is configured
WiredTiger cache uses 1.5GB of RAM (\fB0.5 * (4 GB \- 1 GB) = to use less RAM than the amount of memory provisioned for the host, you
1.5 GB\f1). Conversely, on a system with a total of 1.25 GB of must account for the limits. You may need to configure the WiredTiger cache
RAM WiredTiger allocates 256 MB to the WiredTiger cache to an appropriate value, as WiredTiger may not account for the memory
because that is more than half of the total RAM minus one limits of the specific container in certain cases.
gigabyte (\fB0.5 * (1.25 GB \- 1 GB) = 128 MB < 256 MB\f1).
.PP .PP
In some instances, such as when running in a container, the database To view the \fBmemory limit\f1\f1, the value
can have memory constraints that are lower than the total system that WiredTiger utilizes as the maximum amount of RAM available use the
memory. In such instances, this memory limit, rather than the total \fBhostInfo\f1\f1 command.
system memory, is used as the maximum RAM available.
.PP
To see the memory limit, see \fBhostInfo.system.memLimitMB\f1\f1\&.
.PP
With WiredTiger, MongoDB utilizes both the WiredTiger internal cache
and the filesystem cache.
.PP .PP
With the filesystem cache, MongoDB automatically uses all free memory With the filesystem cache, MongoDB automatically uses all free memory
that is not used by the WiredTiger cache or by other processes. that is not used by the WiredTiger cache or by other processes.
@ -1708,8 +1661,8 @@ the other \fBmongod\f1\f1 instances.
.PP .PP
If you run \fBmongod\f1\f1 in a container (for example, \fBlxc\f1, If you run \fBmongod\f1\f1 in a container (for example, \fBlxc\f1,
\fBcgroups\f1, Docker, etc.) that does \fInot\f1 have access to all of the \fBcgroups\f1, Docker, etc.) that does \fInot\f1 have access to all of the
RAM available in a system, you must set \fB\-\-wiredTigerCacheSizePct\f1\f1 to a value RAM available in a system, you must set \fB\-\-wiredTigerCacheSizePct\f1\f1 or \fB\-\-wiredTigerCacheSizeGB\f1\f1
less than the amount of RAM available in the container. The exact 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 amount depends on the other processes running in the container. See
\fBmemLimitMB\f1\f1\&. \fBmemLimitMB\f1\f1\&.
.PP .PP
@ -1876,7 +1829,7 @@ the oplog returns to its maximum size \fIor\f1 is configured for a
smaller maximum size. See \fBReducing Oplog Size Does Not Immediately Return Disk Space\f1\&. smaller maximum size. See \fBReducing Oplog Size Does Not Immediately Return Disk Space\f1\&.
.IP \(bu 2 .IP \(bu 2
The \fBmongod\f1 compares the system wall clock to an The \fBmongod\f1 compares the system wall clock to an
oplog entries creation wall clock time when enforcing oplog entry oplog entry creation \fBwall clock time\f1 when enforcing oplog entry
retention. Clock drift between cluster components may result in retention. Clock drift between cluster components may result in
unexpected oplog retention behavior. See unexpected oplog retention behavior. See
\fBClock Synchronization\f1 for more information on \fBClock Synchronization\f1 for more information on
@ -1978,9 +1931,18 @@ Once maintenance has completed, remove the
\fBskipShardingConfigurationChecks\f1\f1 parameter and restart \fBskipShardingConfigurationChecks\f1\f1 parameter and restart
with \fB\-\-shardsvr\f1\f1\&. with \fB\-\-shardsvr\f1\f1\&.
.RE .RE
.PP
\fBmongod \-\-replicaSetConfigShardMaintenanceMode\f1
.RS
.PP
Configures the \fBmongod\f1 instance to start in maintenance
mode. The option disables some startup checks, which allows
you to convert a replica set into a sharded cluster with an
embedded config shard.
.RE
.SS TLS OPTIONS .SS TLS OPTIONS
.PP .PP
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 for full
documentation of MongoDB\(aqs support. documentation of MongoDB\(aqs support.
.PP .PP
\fBmongod \-\-tlsMode\f1 \fBmongod \-\-tlsMode\f1
@ -2037,7 +1999,7 @@ If using X.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1
must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2070,7 +2032,7 @@ use \fB\-\-tlsCertificateSelector\f1\f1\&.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2102,7 +2064,7 @@ PEM file. Use \fB\-\-tlsCertificateSelector\f1\f1 instead.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2167,7 +2129,7 @@ If using X.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1
must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2199,7 +2161,7 @@ connection if the presented X.509 certificate expires within \fB30\f1
days of the \fBmongod/mongos\f1 host system time. days of the \fBmongod/mongos\f1 host system time.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.PP .PP
For Windows \fBonly\f1, MongoDB does not support For Windows \fBonly\f1, MongoDB does not support
@ -2385,7 +2347,7 @@ PEM file. Use \fB\-\-tlsClusterCertificateSelector\f1\f1 instead.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2418,7 +2380,7 @@ secure certificate store.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2455,7 +2417,7 @@ secure certificate store.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2482,7 +2444,7 @@ certificate store.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2504,7 +2466,7 @@ the \fB\-\-tlsAllowInvalidCertificates\f1\f1 setting, MongoDB
logs a warning regarding the use of the invalid certificate. logs a warning regarding the use of the invalid certificate.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2518,7 +2480,7 @@ to other members if the hostnames in their certificates do not match
their configured hostname. their configured hostname.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2545,7 +2507,7 @@ a mixed deployment that includes clients that do not or cannot present
certificates to the \fBmongod\f1\&. certificates to the \fBmongod\f1\&.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -2591,8 +2553,20 @@ Directs the \fBmongod\f1 to use the FIPS mode of the TLS
library. Your system must have a FIPS library. Your system must have a FIPS
compliant library to use the \fB\-\-tlsFIPSMode\f1\f1 option. compliant library to use the \fB\-\-tlsFIPSMode\f1\f1 option.
.PP .PP
Starting in MongoDB 8.3, you cannot specify \fBSCRAM\-SHA\-1\f1 for
\fBauthenticationMechanisms\f1\f1 while also specifying
\fBmongod \-\-tlsFIPSMode\f1\f1 or \fBmongos \-\-tlsFIPSMode\f1\f1\&.
.PP
If you try to specify \fBSCRAM\-SHA\-1\f1 for \fBauthenticationMechanisms\f1 while
also specifying \fB\-\-tlsFIPSMode\f1, the server throws an error and
logs a message similar to the following:
.PP
.EX
SCRAM\-SHA\-1 is not allowed in FIPS mode.
.EE
.PP
FIPS\-compatible TLS/SSL is FIPS\-compatible TLS/SSL is
available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)\&. See
\fBConfigure MongoDB for FIPS\f1 for more information. \fBConfigure MongoDB for FIPS\f1 for more information.
.RE .RE
.SS PROFILER OPTIONS .SS PROFILER OPTIONS
@ -2633,6 +2607,9 @@ The profiler only captures operations that match the
.RS .RS
.PP .PP
The profiler collects data for all operations. The profiler collects data for all operations.
.PP
When set to level \fB2\f1, the profiler ignores user
provided values for \fBslowms\f1 and \fBfilter\f1\&.
.RE .RE
.PP .PP
Profiling can degrade performance and expose unencrypted query data in the Profiling can degrade performance and expose unencrypted query data in the
@ -2673,6 +2650,17 @@ and, if enabled, the profiler.
\fBDatabase Profiler\f1 \fBDatabase Profiler\f1
.RE .RE
.PP .PP
\fBmongod \-\-defaultSlowInProgMS\f1
.RS
.PP
\fIDefault\f1: 5000
.PP
The slow operation time threshold for an in\-progress query, in milliseconds.
MongoDB logs operations that run for longer than this threshold as slow
in\-progess queries. MongoDB logs a query as a slow in\-progress query as soon as
the query operation crosses the time threshold.
.RE
.PP
\fBmongod \-\-slowOpSampleRate\f1 \fBmongod \-\-slowOpSampleRate\f1
.RS .RS
.PP .PP
@ -2723,7 +2711,7 @@ Do not compress the audit log.
.RE .RE
.RE .RE
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)\&.
MongoDB Enterprise and Atlas have different configuration MongoDB Enterprise and Atlas have different configuration
requirements. requirements.
.RE .RE
@ -2774,7 +2762,7 @@ Output the audit events to the file specified in
.RE .RE
.RE .RE
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
.RE .RE
.PP .PP
@ -2787,7 +2775,7 @@ Interoperability Protocol (KMIP) key for \fBaudit log encryption\f1\&.
You cannot use \fB\-\-auditEncryptionKeyUID\f1\f1 and You cannot use \fB\-\-auditEncryptionKeyUID\f1\f1 and
\fB\-\-auditLocalKeyFile\f1\f1 together. \fB\-\-auditLocalKeyFile\f1\f1 together.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)\&.
MongoDB Enterprise and Atlas have different configuration MongoDB Enterprise and Atlas have different configuration
requirements. requirements.
.RE .RE
@ -2826,7 +2814,7 @@ specified in \fB\-\-auditPath\f1\f1\&.
Printing audit events to a file in JSON format degrades server Printing audit events to a file in JSON format degrades server
performance more than printing to a file in BSON format. performance more than printing to a file in BSON format.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
.RE .RE
.PP .PP
@ -2844,7 +2832,7 @@ Management Interoperability Protocol (KMIP) server.
You cannot use \fB\-\-auditLocalKeyFile\f1\f1 and You cannot use \fB\-\-auditLocalKeyFile\f1\f1 and
\fB\-\-auditEncryptionKeyUID\f1\f1 together. \fB\-\-auditEncryptionKeyUID\f1\f1 together.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)\&.
MongoDB Enterprise and Atlas have different configuration MongoDB Enterprise and Atlas have different configuration
requirements. requirements.
.RE .RE
@ -2857,7 +2845,7 @@ Specifies the output file for auditing if
\fB\-\-auditPath\f1\f1 option can take either a full path name or a \fB\-\-auditPath\f1\f1 option can take either a full path name or a
relative path name. relative path name.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
.RE .RE
.PP .PP
@ -2882,7 +2870,7 @@ To specify the audit filter in a
\fBconfiguration file\f1, you must use the YAML format \fBconfiguration file\f1, you must use the YAML format
of the configuration file. of the configuration file.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
.RE .RE
.PP .PP
@ -3182,7 +3170,7 @@ To enable encryption at rest with KMIP on Windows, you must:
.IP \(bu 2 .IP \(bu 2
Import the client certificate into the Windows Certificate Store. Import the client certificate into the Windows Certificate Store.
.IP \(bu 2 .IP \(bu 2
Use the \fB\-\-kmipClientCertificateSelector\f1\f1 option. Use the \fB\-\-kmipClientCertificateSelector\f1\f1 configuration option.
.RE .RE
.PP .PP
On macOS or Windows, you can use a certificate On macOS or Windows, you can use a certificate

957
debian/mongodb-parameters.5 vendored
View File

File diff suppressed because it is too large Load Diff

2
debian/mongokerberos.1 vendored
View File

@ -102,7 +102,7 @@ To install \fBmongokerberos\f1\f1 as a standalone installation:
.RS .RS
.IP \(bu 2 .IP \(bu 2
Follow the download link for MongoDB Enterprise Edition: Follow the download link for MongoDB Enterprise Edition:
MongoDB Enterprise Download Center (https://www.mongodb.com/try/download/enterprise?tck=docs_server) MongoDB Enterprise Download Center (https://www.mongodb.com/try/download/enterprise)
.IP \(bu 2 .IP \(bu 2
Select your Platform (operating system) from the dropdown Select your Platform (operating system) from the dropdown
menu, then select the appropriate Package for your menu, then select the appropriate Package for your

2
debian/mongoldap.1 vendored
View File

@ -73,7 +73,7 @@ To install \fBmongoldap\f1\f1 as a standalone installation:
.RS .RS
.IP \(bu 2 .IP \(bu 2
Follow the download link for MongoDB Enterprise Edition: Follow the download link for MongoDB Enterprise Edition:
MongoDB Enterprise Download Center (https://www.mongodb.com/try/download/enterprise?tck=docs_server) MongoDB Enterprise Download Center (https://www.mongodb.com/try/download/enterprise)
.IP \(bu 2 .IP \(bu 2
Select your Platform (operating system) from the dropdown Select your Platform (operating system) from the dropdown
menu, then select the appropriate Package for your menu, then select the appropriate Package for your

72
debian/mongos.1 vendored
View File

@ -12,16 +12,16 @@ any other MongoDB instance.
.IP \(bu 2 .IP \(bu 2
Never change the name of the \fBmongos\f1 binary. Never change the name of the \fBmongos\f1 binary.
.IP \(bu 2 .IP \(bu 2
MongoDB disables support for TLS 1.0 MongoDB disables support for TLS 1.0 and TLS 1.1
encryption on systems where TLS 1.1+ is available. encryption on systems where TLS 1.2+ is available.
.IP \(bu 2 .IP \(bu 2
The \fBmongos\f1\f1 binary cannot connect to \fBmongod\f1\f1 The \fBmongos\f1\f1 binary cannot connect to \fBmongod\f1\f1
instances whose \fBfeature compatibility version (FCV)\f1 is greater instances whose \fBfeature compatibility version (FCV)\f1 is greater
than that of the \fBmongos\f1\f1\&. For example, you cannot connect than that of the \fBmongos\f1\f1\&. For example, you cannot connect
a MongoDB 5.0 version \fBmongos\f1\f1 to a 8.0 a MongoDB 6.0 version \fBmongos\f1\f1 to a 8.0
sharded cluster with \fBFCV\f1 set to 8.0\&. You sharded cluster with \fBFCV\f1 set to 8.0\&. You
can, however, connect a MongoDB 5.0 version can, however, connect a MongoDB 6.0 version
\fBmongos\f1\f1 to a 8.0 sharded cluster with \fBFCV\f1 set to 5.0\&. \fBmongos\f1\f1 to a 8.0 sharded cluster with \fBFCV\f1 set to 6.0\&.
.IP \(bu 2 .IP \(bu 2
\fBmongod\f1\f1 includes a \fBFull Time Diagnostic Data Capture\f1 mechanism to assist MongoDB engineers with troubleshooting \fBmongod\f1\f1 includes a \fBFull Time Diagnostic Data Capture\f1 mechanism to assist MongoDB engineers with troubleshooting
deployments. If this thread fails, it terminates the originating process. deployments. If this thread fails, it terminates the originating process.
@ -124,7 +124,7 @@ list, for example: \fBrest, exec\f1\&. If the configuration file contains
expansion directives not specified to \fB\-\-configExpand\f1\f1, the \fBmongos\f1 expansion directives not specified to \fB\-\-configExpand\f1\f1, the \fBmongos\f1
returns an error and terminates. returns an error and terminates.
.PP .PP
See \fBExternally Sourced Configuration File Values for Self\-Managed Deployments\f1 for configuration files See \fBExternal Configuration Values for Self\-Managed MongoDB\f1 for configuration files
for more information on expansion directives. for more information on expansion directives.
.RE .RE
.PP .PP
@ -536,8 +536,8 @@ always listens on the UNIX socket unless one of the following is true:
\fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address \fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address
.RE .RE
.PP .PP
\fBmongos\f1 installed from official \fBInstall MongoDB Community Edition on Debian\f1 \fBmongos\f1 installed from official \fBInstall MongoDB Community Edition\f1
and \fBInstall MongoDB Community Edition on Red Hat or CentOS\f1 packages and \fBInstall MongoDB Community Edition\f1 packages
have the \fBbind_ip\f1 configuration set to \fB127.0.0.1\f1 by have the \fBbind_ip\f1 configuration set to \fB127.0.0.1\f1 by
default. default.
.RE .RE
@ -708,7 +708,7 @@ and use the \fBtimeZoneInfo\f1\f1 parameter.
.PP .PP
Outputs the \fBmongos\f1 instance\(aqs configuration options, formatted Outputs the \fBmongos\f1 instance\(aqs configuration options, formatted
in YAML, to \fBstdout\f1 and exits the \fBmongos\f1 instance. For in YAML, to \fBstdout\f1 and exits the \fBmongos\f1 instance. For
configuration options that uses \fBExternally Sourced Configuration File Values for Self\-Managed Deployments\f1, configuration options that uses \fBExternal Configuration Values for Self\-Managed MongoDB\f1,
\fB\-\-outputConfig\f1\f1 returns the resolved value for those options. \fB\-\-outputConfig\f1\f1 returns the resolved value for those options.
.PP .PP
This may include any configured passwords or secrets previously This may include any configured passwords or secrets previously
@ -784,7 +784,7 @@ documentation for more information.
.RE .RE
.SS TLS OPTIONS .SS TLS OPTIONS
.PP .PP
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full documentation of MongoDB\(aqs \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 for full documentation of MongoDB\(aqs
support. support.
.PP .PP
\fBmongos \-\-tlsMode\f1 \fBmongos \-\-tlsMode\f1
@ -841,7 +841,7 @@ If using X.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1
must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -863,7 +863,7 @@ On Windows or macOS, you must specify either \fB\-\-tlsCertificateKeyFile\f1\f1
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -888,7 +888,7 @@ unencrypted PEM file.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -953,7 +953,7 @@ If using X.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1
must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -982,7 +982,7 @@ connection if the presented X.509 certificate expires within \fB30\f1
days of the \fBmongod/mongos\f1 host system time. days of the \fBmongod/mongos\f1 host system time.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -1007,7 +1007,7 @@ use an unencrypted PEM file.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -1024,7 +1024,7 @@ the operating system\(aqs secure store instead of a PEM key file. See
do not need to, but can, also specify the \fB\-\-tlsCAFile\f1\f1\&. do not need to, but can, also specify the \fB\-\-tlsCAFile\f1\f1\&.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -1051,7 +1051,7 @@ do not need to, but can, also specify the \fB\-\-tlsClusterCAFile\f1\f1\&.
Requires that \fB\-\-tlsCAFile\f1\f1 is set. Requires that \fB\-\-tlsCAFile\f1\f1 is set.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -1190,7 +1190,7 @@ certificate store.
.RE .RE
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -1217,7 +1217,7 @@ a mixed deployment that includes clients that do not or cannot present
certificates to the \fBmongos\f1\&. certificates to the \fBmongos\f1\&.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -1239,7 +1239,7 @@ the \fB\-\-tlsAllowInvalidCertificates\f1\f1 setting, MongoDB
logs a warning regarding the use of the invalid certificate. logs a warning regarding the use of the invalid certificate.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -1253,7 +1253,7 @@ to other members if the hostnames in their certificates do not match
their configured hostname. their configured hostname.
.PP .PP
For more information about TLS and MongoDB, see For more information about TLS and MongoDB, see
\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and \fBConfigure MongoDB Instances for TLS/SSL on Self\-Managed Deployments\f1 and
\fBTLS/SSL Configuration for Clients\f1 . \fBTLS/SSL Configuration for Clients\f1 .
.RE .RE
.PP .PP
@ -1299,8 +1299,20 @@ Directs the \fBmongos\f1 to use the FIPS mode of the TLS
library. Your system must have a FIPS library. Your system must have a FIPS
compliant library to use the \fB\-\-tlsFIPSMode\f1\f1 option. compliant library to use the \fB\-\-tlsFIPSMode\f1\f1 option.
.PP .PP
Starting in MongoDB 8.3, you cannot specify \fBSCRAM\-SHA\-1\f1 for
\fBauthenticationMechanisms\f1\f1 while also specifying
\fBmongod \-\-tlsFIPSMode\f1\f1 or \fBmongos \-\-tlsFIPSMode\f1\f1\&.
.PP
If you try to specify \fBSCRAM\-SHA\-1\f1 for \fBauthenticationMechanisms\f1 while
also specifying \fB\-\-tlsFIPSMode\f1, the server throws an error and
logs a message similar to the following:
.PP
.EX
SCRAM\-SHA\-1 is not allowed in FIPS mode.
.EE
.PP
FIPS\-compatible TLS/SSL is FIPS\-compatible TLS/SSL is
available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)\&. See
\fBConfigure MongoDB for FIPS\f1 for more information. \fBConfigure MongoDB for FIPS\f1 for more information.
.RE .RE
.SS AUDIT OPTIONS .SS AUDIT OPTIONS
@ -1337,7 +1349,7 @@ Do not compress the audit log.
.RE .RE
.RE .RE
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)\&.
MongoDB Enterprise and Atlas have different configuration MongoDB Enterprise and Atlas have different configuration
requirements. requirements.
.RE .RE
@ -1388,7 +1400,7 @@ Output the audit events to the file specified in
.RE .RE
.RE .RE
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
.RE .RE
.PP .PP
@ -1401,7 +1413,7 @@ Interoperability Protocol (KMIP) key for \fBaudit log encryption\f1\&.
You cannot use \fB\-\-auditEncryptionKeyUID\f1\f1 and You cannot use \fB\-\-auditEncryptionKeyUID\f1\f1 and
\fB\-\-auditLocalKeyFile\f1\f1 together. \fB\-\-auditLocalKeyFile\f1\f1 together.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)\&.
MongoDB Enterprise and Atlas have different configuration MongoDB Enterprise and Atlas have different configuration
requirements. requirements.
.RE .RE
@ -1440,7 +1452,7 @@ specified in \fB\-\-auditPath\f1\f1\&.
Printing audit events to a file in JSON format degrades server Printing audit events to a file in JSON format degrades server
performance more than printing to a file in BSON format. performance more than printing to a file in BSON format.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
.RE .RE
.PP .PP
@ -1458,7 +1470,7 @@ Management Interoperability Protocol (KMIP) server.
You cannot use \fB\-\-auditLocalKeyFile\f1\f1 and You cannot use \fB\-\-auditLocalKeyFile\f1\f1 and
\fB\-\-auditEncryptionKeyUID\f1\f1 together. \fB\-\-auditEncryptionKeyUID\f1\f1 together.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)\&.
MongoDB Enterprise and Atlas have different configuration MongoDB Enterprise and Atlas have different configuration
requirements. requirements.
.RE .RE
@ -1471,7 +1483,7 @@ Specifies the output file for auditing if
\fB\-\-auditPath\f1\f1 option can take either a full path name or a \fB\-\-auditPath\f1\f1 option can take either a full path name or a
relative path name. relative path name.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
.RE .RE
.PP .PP
@ -1496,7 +1508,7 @@ To specify the audit filter in a
\fBconfiguration file\f1, you must use the YAML format \fBconfiguration file\f1, you must use the YAML format
of the configuration file. of the configuration file.
.PP .PP
Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server) Available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced)
and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&. and MongoDB Atlas (https://cloud.mongodb.com/user#/atlas/login)\&.
.RE .RE
.PP .PP