From 74396d963cedfdd9e29719622ec3ff888ea89b0b Mon Sep 17 00:00:00 2001 From: Jon Streets Date: Mon, 18 Oct 2021 21:32:29 +0000 Subject: [PATCH] SERVER-51253 implement mongodb-parameters man 5 page --- debian/mongo.1 | 3149 ++++---- debian/mongod.1 | 6283 +++++++--------- debian/mongodb-parameters.5 | 8239 +++++++++++---------- debian/mongokerberos.1 | 690 +- debian/mongoldap.1 | 1215 ++- debian/mongos.1 | 3884 +++++----- rpm/mongodb-enterprise-init.spec | 3 + rpm/mongodb-enterprise-unstable-init.spec | 3 + rpm/mongodb-enterprise-unstable.spec | 3 + rpm/mongodb-enterprise.spec | 3 + rpm/mongodb-org-init.spec | 3 + rpm/mongodb-org-unstable-init.spec | 3 + rpm/mongodb-org-unstable.spec | 3 + rpm/mongodb-org.spec | 3 + 14 files changed, 11192 insertions(+), 12292 deletions(-) diff --git a/debian/mongo.1 b/debian/mongo.1 index 07fe0da64bd..0f831bbf1a1 100644 --- a/debian/mongo.1 +++ b/debian/mongo.1 @@ -1,2074 +1,1861 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONGO" "1" "Jun 23, 2020" "4.4" "mongodb-manual" -.SH NAME -mongo \- MongoDB Shell -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SS On this page -.INDENT 0.0 +.TH mongo 1 +.SH LEGACY MONGO SHELL +The \fBmongo\f1 shell has been deprecated in MongoDB v5.0. The +replacement is \fBmongosh\f1\f1\&. +.PP +Older \fBmongo\f1 shell documentation is included with the +corresponding documentation for that \fBMongoDB\f1 release. +.PP +\fIQuick Links to prior versions\f1 +.RS .IP \(bu 2 -\fI\%Description\fP +mongo shell v4.4 (https://docs.mongodb.com/v4.4/mongo/) .IP \(bu 2 -\fI\%Syntax\fP +mongo shell v4.2 (https://docs.mongodb.com/v4.2/mongo/) .IP \(bu 2 -\fI\%Options\fP -.IP \(bu 2 -\fI\%Files\fP -.IP \(bu 2 -\fI\%Environment\fP -.IP \(bu 2 -\fI\%Keyboard Shortcuts\fP -.IP \(bu 2 -\fI\%Use\fP -.UNINDENT +mongo shell v4.0 (https://docs.mongodb.com/v4.0/mongo/) +.RE +.PP +See \fBComparison of the mongo\f1 Shell and mongosh\f1\f1 for more information. .SH DESCRIPTION -.sp -\fI\%mongo\fP is an interactive JavaScript shell interface to +.PP +\fBmongo\f1\f1 is an interactive JavaScript shell interface to MongoDB, which provides a powerful interface for system administrators as well as a way for developers to test queries and -operations directly with the database. \fI\%mongo\fP also provides +operations directly with the database. \fBmongo\f1\f1 also provides a fully functional JavaScript environment for use with a MongoDB. -.sp -The \fI\%mongo\fP shell is included as part of the MongoDB Server installation. MongoDB also provides the \fI\%mongo\fP -shell as a standalone package. To download the standalone \fI\%mongo\fP -shell package: -.INDENT 0.0 -.IP 1. 3 +.PP +The \fBmongo\f1\f1 shell is included as part of the \fBMongoDB +server installation\f1\&. If you have already installed the +server, the \fBmongo\f1\f1 shell is installed to the same location +as the server binary. +.PP +Alternatively, if you would like to download the \fBmongo\f1\f1 +shell separately from the MongoDB Server, you can install the shell as +a standalone package by following these steps: +.RS +.IP \(bu 2 Access the Download Center for your Edition of MongoDB: -.INDENT 3.0 +.RS +.IP \(bu 4 +MongoDB Community Download Center (https://www.mongodb.com/try/download/community?tck=docs_server) +.IP \(bu 4 +MongoDB Enterprise Download Center (https://www.mongodb.com/try/download/enterprise?tck=docs_server) +.RE .IP \(bu 2 -\fI\%MongoDB Community Download Center\fP -.IP \(bu 2 -\fI\%MongoDB Enterprise Download Center\fP -.UNINDENT -.IP 2. 3 Select your preferred Version and Platform from the dropdowns. -.IP 3. 3 +.IP \(bu 2 Select the Package to download according to your platform: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 4 +.RS +.IP \(bu 6 Platform -T} T{ +.IP \(bu 6 Download Package -T} -_ -T{ -\fIWindows\fP -T} T{ -Select the \fBzip\fP package to download an archive which -includes the \fI\%mongo\fP shell. -T} -_ -T{ -\fImacOS\fP -T} T{ -Select the \fBtgz\fP package to download an archive which -includes the \fI\%mongo\fP shell. -T} -_ -T{ -\fILinux\fP -T} T{ -Select the \fBshell\fP package to download the -\fI\%mongo\fP shell. -T} -_ -.TE -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +Windows +.IP \(bu 6 +Select the \fBzip\f1 package to download an archive which +includes the \fBmongo\f1\f1 shell. +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +macOS +.IP \(bu 6 +Select the \fBtgz\f1 package to download an archive which +includes the \fBmongo\f1\f1 shell. +.RE +.IP \(bu 4 +.RS +.IP \(bu 6 +Linux +.IP \(bu 6 +Select the \fBtgz\f1 package to download the +\fBmongo\f1\f1 shell. +.RE +.RE .IP \(bu 2 -Starting in MongoDB 4.2 (and 4.0.13), the \fI\%mongo\fP shell displays a +Copy the \fBmongo\f1\f1 shell from the archive to a location on +your filesystem. +.RE +.PP +For additional installation guidance specific to your platform, or to +install the \fBmongo\f1\f1 shell as part of a MongoDB Server +installation, see the \fBinstallation guide for your platform\f1\&. +.RS +.IP \(bu 2 +Starting in MongoDB 4.2 (and 4.0.13), the \fBmongo\f1\f1 shell displays a warning message when connected to non\-genuine MongoDB instances as these instances may behave differently from the official MongoDB instances; e.g. missing or incomplete features, different feature behaviors, etc. .IP \(bu 2 -Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0 +Starting in version 4.0, \fBmongo\f1\f1 disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.UNINDENT -.UNINDENT -.UNINDENT +more details, see \fBDisable TLS 1.0\f1\&. +.RE .SH SYNTAX -.INDENT 0.0 +.RS .IP \(bu 2 -You can run \fI\%mongo\fP shell without any command\-line +You can run \fBmongo\f1\f1 shell without any command\-line options use the default settings: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo -.ft P -.fi -.UNINDENT -.UNINDENT +.IP +.EX + mongo +.EE .IP \(bu 2 -You can run \fI\%mongo\fP shell with a connection string that specifies the host and port and +You can run \fBmongo\f1\f1 shell with a \fBconnection string\f1 that specifies the host and port and other connection options. For example, the following includes the -\fBtls\fP: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo "mongodb://mongodb0.example.com:27017/testdb?tls=true" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fBtls\fP option is available starting in MongoDB 4.2. In -earlier version, use the \fBssl\fP option. -.sp -To connect \fI\%mongo\fP shell to a replica set, you can -specify in the connection string the replica set members and name: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo "mongodb://mongodb0.example.com.local:27017,mongodb1.example.com.local:27017,mongodb2.example.com.local:27017/?replicaSet=replA" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBtls\f1\f1: +.IP +.EX + mongo "mongodb://mongodb0.example.com:27017/testdb?tls=true" +.EE +.IP +The \fBtls\f1\f1 option is available starting in MongoDB 4.2. In +earlier version, use the \fBssl\f1\f1 option. +.IP +To connect \fBmongo\f1\f1 shell to a replica set, you can +specify in the \fBconnection string\f1 the replica set members and name: +.IP +.EX + mongo "mongodb://mongodb0.example.com.local:27017,mongodb1.example.com.local:27017,mongodb2.example.com.local:27017/?replicaSet=replA" +.EE +.IP For more information on the connection string options, see -/reference/connection\-string\&. +\fBConnection String URI Format\f1\&. .IP \(bu 2 -You can run \fI\%mongo\fP shell with various command\-line +You can run \fBmongo\f1\f1 shell with various command\-line options. For example: -.INDENT 2.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-host mongodb0.example.com:27017 [additional options] - -mongo \-\-host mongodb0.example.com \-\-port 27017 [additional options] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -For more information on the options available, see \fI\%Options\fP\&. -.UNINDENT +.IP +.EX + mongo \-\-host mongodb0.example.com:27017 [additional options] + + mongo \-\-host mongodb0.example.com \-\-port 27017 [additional options] +.EE +.IP +For more information on the options available, see \fBOptions\f1\&. +.RE .SH OPTIONS -.INDENT 0.0 -.INDENT 3.5 -.IP "Starting in version 4.2" -.INDENT 0.0 +.RS .IP \(bu 2 -MongoDB deprecates the SSL options and insteads adds new +MongoDB deprecates the SSL options and instead adds new corresponding TLS options. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Core Options -.INDENT 0.0 -.TP -.B \-\-shell -Enables the shell interface. If you invoke the \fBmongo\fP command -and specify a JavaScript file as an argument, or use \fI\%\-\-eval\fP to -specify JavaScript on the command line, the \fI\%\-\-shell\fP option +.RE +.SS CORE OPTIONS +.PP +\fBmongo \-\-shell\f1 +.RS +.PP +Enables the shell interface. If you invoke the \fBmongo\f1\f1 command +and specify a JavaScript file as an argument, or use \fB\-\-eval\f1\f1 to +specify JavaScript on the command line, the \fB\-\-shell\f1\f1 option provides the user with a shell prompt after the file finishes executing. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-nodb +.RE +.PP +\fBmongo \-\-nodb\f1 +.RS +.PP Prevents the shell from connecting to any database instances. Later, to connect to a database within the shell, see -mongo\-shell\-new\-connections\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-norc -Prevents the shell from sourcing and evaluating \fB~/.mongorc.js\fP on +\fBOpening New Connections\f1\&. +.RE +.PP +\fBmongo \-\-norc\f1 +.RS +.PP +Prevents the shell from sourcing and evaluating ~/.mongorc.js on start up. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-quiet +.RE +.PP +\fBmongo \-\-quiet\f1 +.RS +.PP Silences output from the shell during the connection process. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-port -Specifies the port where the \fBmongod\fP or \fBmongos\fP -instance is listening. If \fI\%\-\-port\fP is not specified, -\fBmongo\fP attempts to connect to port \fB27017\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-host +.RE +.PP +\fBmongo \-\-port\f1 +.RS +.PP +Specifies the port where the \fBmongod\f1\f1 or \fBmongos\f1\f1 +instance is listening. If \fB\-\-port\f1\f1 is not specified, +\fBmongo\f1\f1 attempts to connect to port \fB27017\f1\&. +.RE +.PP +\fBmongo \-\-host\f1 +.RS +.PP Specifies the name of the host machine where the -\fBmongod\fP or \fBmongos\fP is running. If this is not specified, -\fBmongo\fP attempts to connect to a MongoDB process running on +\fBmongod\f1\f1 or \fBmongos\f1\f1 is running. If this is not specified, +\fBmongo\f1\f1 attempts to connect to a MongoDB process running on the localhost. -.INDENT 7.0 -.TP -.B To connect to a replica set, -Specify the \fBreplica set name\fP +.PP +\fBTo connect to a replica set,\f1 +.RS +.PP +Specify the \fBreplica set name\f1\f1 and a seed list of set members. Use the following form: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -/<:port>,<:port>,<...> -.ft P -.fi -.UNINDENT -.UNINDENT -.TP -.B For TLS/SSL connections (\fB\-\-ssl\fP), -The \fI\%mongo\fP shell verifies that the hostname (specified -in \fI\%\-\-host\fP option or the connection string) -matches the \fBSAN\fP (or, if \fBSAN\fP is not present, the \fBCN\fP) in -the certificate presented by the \fBmongod\fP or -\fBmongos\fP\&. If \fBSAN\fP is present, \fI\%mongo\fP -does not match against the \fBCN\fP\&. If the hostname does not match -the \fBSAN\fP (or \fBCN\fP), the \fI\%mongo\fP shell will fail to +.PP +.EX + /<:port>,<:port>,<...> +.EE +.RE +.PP +\fBFor TLS/SSL connections (\-\-ssl\f1),\f1 +.RS +.PP +\fBmongosh\f1\f1 verifies that the hostname (specified +in \fB\-\-host\f1\f1 option or the connection string) +matches the \fBSAN\f1 (or, if \fBSAN\f1 is not present, the \fBCN\f1) in +the certificate presented by the \fBmongod\f1\f1 or +\fBmongos\f1\f1\&. If \fBSAN\f1 is present, \fBmongosh\f1\f1 +does not match against the \fBCN\f1\&. If the hostname does not match +the \fBSAN\f1 (or \fBCN\f1), \fBmongosh\f1\f1 will fail to connect. -.sp +.PP Starting in MongoDB 4.2, when performing comparison of SAN, MongoDB supports comparison of DNS names or IP addresses. In previous versions, MongoDB only supports comparisons of DNS names. -.TP -.B For \fI\%DNS seedlist connections\fP, -Specify the connection protocol as \fBmongodb+srv\fP, followed by -the DNS SRV hostname record and any options. The \fBauthSource\fP -and \fBreplicaSet\fP options, if included in the connection string, +.RE +.PP +\fBFor DNS seedlist connections (https://docs.mongodb.com/manual/reference/connection\-string/#dns\-seedlist\-connection\-format/),\f1 +.RS +.PP +Specify the connection protocol as \fBmongodb+srv\f1, followed by +the DNS SRV hostname record and any options. The \fBauthSource\f1 +and \fBreplicaSet\f1 options, if included in the connection string, will override any corresponding DNS\-configured options set in the -TXT record. Use of the \fBmongodb+srv:\fP connection string -implicitly enables TLS/SSL (normally set with \fBssl=true\fP) for +TXT record. Use of the \fBmongodb+srv:\f1 connection string +implicitly enables TLS/SSL (normally set with \fBssl=true\f1) for the client connection. The TLS/SSL option can be turned off by -setting \fBssl=false\fP in the query string. -.sp +setting \fBssl=false\f1 in the query string. +.PP Example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongodb+srv://server.example.com/?connectionTimeout=3000ms -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -New in version 3.6. - -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-eval +.PP +.EX + mongodb+srv://server.example.com/?connectionTimeout=3000ms +.EE +.RE +.RE +.PP +\fBmongo \-\-eval\f1 +.RS +.PP Evaluates a JavaScript expression that is specified as an argument. -\fBmongo\fP does not load its own environment when evaluating code. +\fBmongo\f1\f1 does not load its own environment when evaluating code. As a result many options of the shell environment are not available. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-username , \-u +.RE +.PP +\fBmongo \-\-username\f1, \fBmongo \-u\f1 +.RS +.PP Specifies a username with which to authenticate to a MongoDB database -that uses authentication. Use in conjunction with the \fI\%\-\-password\fP and -\fI\%\-\-authenticationDatabase\fP options. -.sp -If connecting to a \fI\%MongoDB Atlas\fP cluster -using the \fBMONGODB\-AWS\fP \fI\%authentication mechanism\fP, specify your AWS access key ID in this -field, or in the connection string\&. Alternatively, this value may -also be supplied as the environment variable \fBAWS_ACCESS_KEY_ID\fP\&. -See \fI\%Connect to a MongoDB Atlas Cluster using AWS IAM Credentials\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-password , \-p +that uses authentication. Use in conjunction with the \fB\-\-password\f1\f1 and +\fB\-\-authenticationDatabase\f1\f1 options. +.PP +If connecting to a MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster +using the \fBMONGODB\-AWS\f1 \fBauthentication mechanism\f1\f1, specify your AWS access key ID in this +field, or in the \fBconnection string\f1\&. Alternatively, this value may +also be supplied as the environment variable \fBAWS_ACCESS_KEY_ID\f1\&. +See \fBConnect to a MongoDB Atlas Cluster using AWS IAM Credentials\f1\&. +.RE +.PP +\fBmongo \-\-password\f1, \fBmongo \-p\f1 +.RS +.PP Specifies a password with which to authenticate to a MongoDB database -that uses authentication. Use in conjunction with the \fI\%\-\-username\fP -and \fI\%\-\-authenticationDatabase\fP options. To force \fBmongo\fP to -prompt for a password, enter the \fI\%\-\-password\fP option as the +that uses authentication. Use in conjunction with the \fB\-\-username\f1\f1 +and \fB\-\-authenticationDatabase\f1\f1 options. To force \fBmongo\f1\f1 to +prompt for a password, enter the \fB\-\-password\f1\f1 option as the last option and leave out the argument. -.sp -If connecting to a \fI\%MongoDB Atlas\fP cluster -using the \fBMONGODB\-AWS\fP \fI\%authentication mechanism\fP, specify your AWS secret access key in -this field, or in the connection string\&. Alternatively, this value may +.PP +If connecting to a MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster +using the \fBMONGODB\-AWS\f1 \fBauthentication mechanism\f1\f1, specify your AWS secret access key in +this field, or in the \fBconnection string\f1\&. Alternatively, this value may also be supplied as the environment variable -\fBAWS_SECRET_ACCESS_KEY\fP\&. See -\fI\%Connect to a MongoDB Atlas Cluster using AWS IAM Credentials\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-awsIamSessionToken -If connecting to a \fI\%MongoDB Atlas\fP cluster -using the \fBMONGODB\-AWS\fP \fI\%authentication mechanism\fP and using session tokens in addition to +\fBAWS_SECRET_ACCESS_KEY\f1\&. See +\fBConnect to a MongoDB Atlas Cluster using AWS IAM Credentials\f1\&. +.RE +.PP +\fBmongo \-\-apiVersion\f1 +.RS +.PP +Specifies the \fBapiVersion\f1\&. \fB"1"\f1 is +currently the only supported value. +.RE +.PP +\fBmongo \-\-apiStrict\f1 +.RS +.PP +Specifies that the server will respond with \fBAPIStrictError\f1 if your application uses a command or behavior +outside of the \fBVersioned API\f1\&. +.PP +If you specify \fB\-\-apiStrict\f1\f1, you must also specify +\fB\-\-apiVersion\f1\f1\&. +.RE +.PP +\fBmongo \-\-apiDeprecationErrors\f1 +.RS +.PP +Specifies that the server will respond with +\fBAPIDeprecationError\f1 if your application +uses a command or behavior that is deprecated in the specified +\fBapiVersion\f1\&. +.PP +If you specify \fB\-\-apiDeprecationErrors\f1\f1, you must also +specify \fB\-\-apiVersion\f1\f1\&. +.RE +.PP +\fBmongo \-\-awsIamSessionToken\f1 +.RS +.PP +If connecting to a MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster +using the \fBMONGODB\-AWS\f1 \fBauthentication mechanism\f1\f1 and using session tokens in addition to your AWS access key ID and secret access key, specify your AWS -session token in this field, or in the connection string\&. Alternatively, this value may +session token in this field, or in the \fBconnection string\f1\&. Alternatively, this value may also be supplied as the environment variable -\fBAWS_SESSION_TOKEN\fP\&. See -\fI\%Connect to a MongoDB Atlas Cluster using AWS IAM Credentials\fP\&. -.sp -Only valid when using the \fBMONGODB\-AWS\fP -\fI\%authentication mechanism\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-help, \-h -Returns information on the options and use of \fBmongo\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-version -Returns the \fBmongo\fP release number. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-verbose +\fBAWS_SESSION_TOKEN\f1\&. See +\fBConnect to a MongoDB Atlas Cluster using AWS IAM Credentials\f1\&. +.PP +Only valid when using the \fBMONGODB\-AWS\f1 +\fBauthentication mechanism\f1\f1\&. +.RE +.PP +\fBmongo \-\-help\f1, \fBmongo \-h\f1 +.RS +.PP +Returns information on the options and use of \fBmongo\f1\f1\&. +.RE +.PP +\fBmongo \-\-version\f1 +.RS +.PP +Returns the \fBmongo\f1\f1 release number. +.RE +.PP +\fBmongo \-\-verbose\f1 +.RS +.PP Increases the verbosity of the output of the shell during the connection process. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-networkMessageCompressors -New in version 3.4. - -.sp +.RE +.PP +\fBmongo \-\-networkMessageCompressors\f1 +.RS +.PP Enables network compression for communication between this -\fBmongo\fP shell and: -.INDENT 7.0 +\fBmongo\f1\f1 shell and: +.RS .IP \(bu 2 -a \fBmongod\fP instance +a \fBmongod\f1\f1 instance .IP \(bu 2 -a \fBmongos\fP instance. -.UNINDENT -.sp +a \fBmongos\f1\f1 instance. +.RE +.PP You can specify the following compressors: -.INDENT 7.0 +.RS .IP \(bu 2 -snappy +\fBsnappy\f1 .IP \(bu 2 -zlib (Available starting in MongoDB 3.6) +\fBzlib\f1 (Available starting in MongoDB 3.6) .IP \(bu 2 -zstd (Available starting in MongoDB 4.2) -.UNINDENT -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBzstd\f1 (Available starting in MongoDB 4.2) +.RE +.PP Messages are compressed when both parties enable network compression. Otherwise, messages between the parties are uncompressed. -.UNINDENT -.UNINDENT -.sp +.PP 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 \fI\%mongo\fP shell specifies the following network -compressors \fBzlib,snappy\fP and the \fBmongod\fP specifies -\fBsnappy,zlib\fP, messages between \fI\%mongo\fP shell and -\fBmongod\fP uses \fBzlib\fP\&. -.sp +example, if \fBmongosh\f1\f1 specifies the following network +compressors \fBzlib,snappy\f1 and the \fBmongod\f1\f1 specifies +\fBsnappy,zlib\f1, messages between \fBmongosh\f1\f1 and +\fBmongod\f1\f1 uses \fBzlib\f1\&. +.PP If the parties do not share at least one common compressor, messages -between the parties are uncompressed. For example, if a -\fI\%mongo\fP shell specifies the network compressor -\fBzlib\fP and \fBmongod\fP specifies \fBsnappy\fP, messages -between \fI\%mongo\fP shell and \fBmongod\fP are not compressed. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ipv6 -Enables IPv6 support. \fBmongo\fP disables IPv6 by default. -.sp +between the parties are uncompressed. For example, if +\fBmongosh\f1\f1 specifies the network compressor +\fBzlib\f1 and \fBmongod\f1\f1 specifies \fBsnappy\f1, messages +between \fBmongosh\f1\f1 and \fBmongod\f1\f1 are not +compressed. +.RE +.PP +\fBmongo \-\-ipv6\f1 +.RS +.PP +Enables IPv6 support. \fBmongo\f1\f1 disables IPv6 by default. +.PP To connect to a MongoDB cluster via IPv6, you must specify -both \fI\%\-\-ipv6\fP \fIand\fP -\fI\%\-\-host \fP -when starting the \fBmongo\fP shell. -.sp -\fBmongod\fP and \fBmongos\fP disable IPv6 support -by default. Specifying \fI\%\-\-ipv6\fP when connecting to a -\fBmongod/mongos\fP does not enable IPv6 support on the -\fBmongod/mongos\fP\&. For documentation on enabling IPv6 support -on the \fBmongod/mongos\fP, see \fBnet.ipv6\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B +both \fB\-\-ipv6\f1\f1 \fIand\f1 +\fB\-\-host \f1\f1 +when starting the \fBmongo\f1\f1 shell. +.PP +\fBmongod\f1\f1 and \fBmongos\f1\f1 disable IPv6 support +by default. Specifying \fB\-\-ipv6\f1\f1 when connecting to a +\fBmongod/mongos\f1 does not enable IPv6 support on the +\fBmongod/mongos\f1\&. For documentation on enabling IPv6 support +on the \fBmongod/mongos\f1, see \fBnet.ipv6\f1\f1\&. +.RE +.PP +\fBmongo db.test.insert({ _id: 1, jsFunc: function(){ print("hello") } } ) -WriteResult({ "nInserted" : 1 }) -> var doc = db.test.findOne({ _id: 1 }) -> doc -{ "_id" : 1, "jsFunc" : function (){ print ("hello") } } -> typeof doc.jsFunc -function -> doc.jsFunc() -hello -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The default behavior (when \fI\%mongo\fP starts \fIwithout\fP the -\fB\-\-disableJavaScriptProtection\fP flag) is to convert embedded +.PP +.EX + > db.test.insert({ _id: 1, jsFunc: function(){ print("hello") } } ) + WriteResult({ "nInserted" : 1 }) + > var doc = db.test.findOne({ _id: 1 }) + > doc + { "_id" : 1, "jsFunc" : function (){ print ("hello") } } + > typeof doc.jsFunc + function + > doc.jsFunc() + hello +.EE +.PP +The default behavior (when \fBmongo\f1\f1 starts \fIwithout\f1 the +\fB\-\-disableJavaScriptProtection\f1 flag) is to convert embedded JavaScript functions to the non\-executable MongoDB shell type -\fBCode\fP\&. The following example demonstrates the default behavior +\fBCode\f1\&. The following example demonstrates the default behavior within the shell: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -> db.test.insert({ _id: 1, jsFunc: function(){ print("hello") } } ) -WriteResult({ "nInserted" : 1 }) -> var doc = db.test.findOne({ _id: 1 }) -> doc -{ "_id" : 1, "jsFunc" : { "code" : "function (){print(\e"hello\e")}" } } -> typeof doc.func -object -> doc.func instanceof Code -true -> doc.jsFunc() -2016\-11\-09T12:30:36.808\-08:00 E QUERY [thread1] TypeError: doc.jsFunc is -not a function : -@(shell):1:1 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B +.PP +.EX + > db.test.insert({ _id: 1, jsFunc: function(){ print("hello") } } ) + WriteResult({ "nInserted" : 1 }) + > var doc = db.test.findOne({ _id: 1 }) + > doc + { "_id" : 1, "jsFunc" : { "code" : "function (){print(\"hello\")}" } } + > typeof doc.func + object + > doc.func instanceof Code + true + > doc.jsFunc() + 2016\-11\-09T12:30:36.808\-08:00 E QUERY [thread1] TypeError: doc.jsFunc is + not a function : + @(shell):1:1 +.EE +.RE +.PP +\fBmongo \f1 +.RS +.PP Specifies a JavaScript file to run and then exit. Generally this should be the last option specified. -.INDENT 7.0 -.INDENT 3.5 -.SS Optional -.sp -To specify a JavaScript file to execute \fIand\fP allow -\fBmongo\fP to prompt you for a password using -\fI\%\-\-password\fP, pass the filename as the first parameter with -\fI\%\-\-username\fP and \fI\%\-\-password\fP as the last options, as +.PP +To specify a JavaScript file to execute \fIand\f1 allow +\fBmongo\f1\f1 to prompt you for a password using +\fB\-\-password\f1\f1, pass the filename as the first parameter with +\fB\-\-username\f1\f1 and \fB\-\-password\f1\f1 as the last options, as in the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo file.js \-\-username username \-\-password -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.sp -Use the \fI\%\-\-shell\fP option to return to a shell after the file +.PP +.EX + mongo file.js \-\-username username \-\-password +.EE +.PP +Use the \fB\-\-shell\f1\f1 option to return to a shell after the file finishes running. -.UNINDENT -.SS Authentication Options -.INDENT 0.0 -.TP -.B \-\-authenticationDatabase -Specifies the authentication database where the specified \fI\%\-\-username\fP has been created. -See user\-authentication\-database\&. -.sp -If you do not specify a value for \fI\%\-\-authenticationDatabase\fP, \fBmongo\fP uses the database +.RE +.SS AUTHENTICATION OPTIONS +.PP +\fBmongo \-\-authenticationDatabase\f1 +.RS +.PP +Specifies the authentication database where the specified \fB\-\-username\f1\f1 has been created. +See \fBAuthentication Database\f1\&. +.PP +If you do not specify a value for \fB\-\-authenticationDatabase\f1\f1, \fBmongo\f1\f1 uses the database specified in the connection string. -.sp -If using the GSSAPI (Kerberos), -PLAIN (LDAP SASL), or \fBMONGODB\-AWS\fP -\fI\%authentication mechanisms\fP, you -must set \fI\%\-\-authenticationDatabase\fP to \fB$external\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-authenticationMechanism -\fIDefault\fP: SCRAM\-SHA\-1 -.sp -Specifies the authentication mechanism the \fBmongo\fP instance uses to -authenticate to the \fBmongod\fP or \fBmongos\fP\&. -.sp -Changed in version 4.4: With MongoDB 4.4, the \fBmongo\fP shell adds support for the -new \fBMONGODB\-AWS\fP authentication mechanism when connecting to a -\fI\%MongoDB Atlas\fP cluster. - -.TS -center; -|l|l|. -_ -T{ +.PP +If using the \fBGSSAPI\f1 (Kerberos), +\fBPLAIN\f1 (LDAP SASL), or \fBMONGODB\-AWS\f1 +\fBauthentication mechanisms\f1\f1, you +must set \fB\-\-authenticationDatabase\f1\f1 to \fB$external\f1\&. +.RE +.PP +\fBmongo \-\-authenticationMechanism\f1 +.RS +.PP +\fIDefault\f1: SCRAM\-SHA\-1 +.PP +Specifies the authentication mechanism the \fBmongo\f1\f1 instance uses to +authenticate to the \fBmongod\f1\f1 or \fBmongos\f1\f1\&. +.PP +With MongoDB 4.4, the \fBmongo\f1\f1 shell adds support for the +new \fBMONGODB\-AWS\f1 authentication mechanism when connecting to a +MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster. +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -SCRAM\-SHA\-1 -T} T{ -\fI\%RFC 5802\fP standard +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBSCRAM\-SHA\-1\f1 +.IP \(bu 4 +RFC 5802 (https://tools.ietf.org/html/rfc5802) standard Salted Challenge Response Authentication Mechanism using the SHA\-1 hash function. -T} -_ -T{ -SCRAM\-SHA\-256 -T} T{ -\fI\%RFC 7677\fP standard +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBSCRAM\-SHA\-256\f1 +.IP \(bu 4 +RFC 7677 (https://tools.ietf.org/html/rfc7677) standard Salted Challenge Response Authentication Mechanism using the SHA\-256 hash function. -.sp -Requires featureCompatibilityVersion set to \fB4.0\fP\&. -.sp -New in version 4.0. -T} -_ -T{ -MONGODB\-X509 -T} T{ +.IP +Requires featureCompatibilityVersion set to \fB4.0\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBMONGODB\-X509\f1 +.IP \(bu 4 MongoDB TLS/SSL certificate authentication. -T} -_ -T{ -\fBMONGODB\-AWS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBMONGODB\-AWS\f1 +.IP \(bu 4 External authentication using AWS IAM credentials for use in connecting to a -\fI\%MongoDB Atlas\fP -cluster. See \fI\%Connect to a MongoDB Atlas Cluster using AWS IAM Credentials\fP\&. -.sp -New in version 4.4. -T} -_ -T{ -GSSAPI (Kerberos) -T} T{ +MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) +cluster. See \fBConnect to a MongoDB Atlas Cluster using AWS IAM Credentials\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBGSSAPI\f1 (Kerberos) +.IP \(bu 4 External authentication using Kerberos. This mechanism is -available only in \fI\%MongoDB Enterprise\fP\&. -T} -_ -T{ -PLAIN (LDAP SASL) -T} T{ -External authentication using LDAP. You can also use \fBPLAIN\fP -for authenticating in\-database users. \fBPLAIN\fP transmits +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBPLAIN\f1 (LDAP SASL) +.IP \(bu 4 +External authentication using LDAP. You can also use \fBPLAIN\f1 +for authenticating in\-database users. \fBPLAIN\f1 transmits passwords in plain text. This mechanism is available only in -\fI\%MongoDB Enterprise\fP\&. -T} -_ -.TE -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gssapiHostName -Specify the hostname of a service using GSSAPI/Kerberos\&. \fIOnly\fP required if the hostname of a machine does +MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. +.RE +.RE +.RE +.PP +\fBmongo \-\-gssapiHostName\f1 +.RS +.PP +Specify the hostname of a service using \fBGSSAPI/Kerberos\f1\&. \fIOnly\f1 required if the hostname of a machine does not match the hostname resolved by DNS. -.sp +.PP This option is available only in MongoDB Enterprise. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-gssapiServiceName -Specify the name of the service using GSSAPI/Kerberos\&. Only required if the service does not use the -default name of \fBmongodb\fP\&. -.sp +.RE +.PP +\fBmongo \-\-gssapiServiceName\f1 +.RS +.PP +Specify the name of the service using \fBGSSAPI/Kerberos\f1\&. Only required if the service does not use the +default name of \fBmongodb\f1\&. +.PP This option is available only in MongoDB Enterprise. -.UNINDENT -.SS TLS Options -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0 +.RE +.SS TLS OPTIONS +.PP +Starting in version 4.0, \fBmongo\f1\f1 disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.SS See -.sp -/tutorial/configure\-ssl for full +more details, see \fBDisable TLS 1.0\f1\&. +.PP +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full documentation of MongoDB\(aqs support. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tls -New in version 4.2. - -.sp -Enables connection to a \fBmongod\fP or \fBmongos\fP that has +.PP +\fBmongo \-\-tls\f1 +.RS +.PP +Enables connection to a \fBmongod\f1\f1 or \fBmongos\f1\f1 that has TLS/SSL support enabled. -.sp -Starting in version 3.2.6, if \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -(or their aliases \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP) is not +.PP +Starting in version 3.2.6, if \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +(or their aliases \fB\-\-sslCAFile\f1 or \fBssl.CAFile\f1) is not specified, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. In previous versions of -MongoDB, the \fI\%mongo\fP shell exited with an error that it +MongoDB, \fBmongosh\f1\f1 exited with an error that it could not validate the certificate. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFile -New in version 4.2. - -.sp -Specifies the \fB\&.pem\fP file that contains both the TLS/SSL -certificate and key for the \fI\%mongo\fP shell. Specify the -file name of the \fB\&.pem\fP file using relative or absolute paths. -.sp -This option is required when using the \fI\%\-\-tls\fP -option to connect to a \fBmongod\fP or \fBmongos\fP -instance that requires client certificates\&. That is, the -\fI\%mongo\fP shell present this certificate to the server. -.sp -Changed in version 4.4: \fBmongod\fP / \fBmongos\fP logs a warning on -connection if the presented x.509 certificate expires within \fB30\fP -days of the \fBmongod/mongos\fP host system time. See -4.4\-rel\-notes\-certificate\-expiration\-warning for more +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsCertificateKeyFile\f1 +.RS +.PP +Specifies the \&.pem file that contains both the TLS/SSL +certificate and key for the \fBmongo\f1\f1 shell. Specify the +file name of the \&.pem file using relative or absolute paths. +.PP +This option is required when using the \fB\-\-tls\f1\f1 +option to connect to a \fBmongod\f1\f1 or \fBmongos\f1\f1 +instance that requires \fBclient certificates\f1\&. That is, the +\fBmongo\f1\f1 shell present this certificate to the server. +.PP +\fBmongod\f1\f1 / \fBmongos\f1\f1 logs a warning on +connection if the presented x.509 certificate expires within \fB30\f1 +days of the \fBmongod/mongos\f1 host system time. See +\fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information. - -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFilePassword -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsCertificateKeyFilePassword\f1 +.RS +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\%\-\-tlsCertificateKeyFile\fP). -.sp -Use the \fI\%\-\-tlsCertificateKeyFilePassword\fP option only if the -certificate\-key file is encrypted. In all cases, the \fBmongo\fP will +\fB\-\-tlsCertificateKeyFile\f1\f1). +.PP +Use the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option only if the +certificate\-key file is encrypted. In all cases, the \fBmongo\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP If the private key in the PEM file is encrypted and you do not -specify the \fI\%\-\-tlsCertificateKeyFilePassword\fP option, the \fBmongo\fP will prompt for a -passphrase. See ssl\-certificate\-password\&. -.sp +specify the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option, the \fBmongo\f1\f1 will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCAFile -New in version 4.2. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsCAFile\f1 +.RS +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority. This file is used to validate the certificate presented by the -\fBmongod\fP/\fBmongos\fP instance. -.sp -Specify the file name of the \fB\&.pem\fP file using relative or +\fBmongod\f1\f1/\fBmongos\f1\f1 instance. +.PP +Specify the file name of the \&.pem file using relative or absolute paths. -.sp -Starting in version 3.2.6, if \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -(or their aliases \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP) is not +.PP +Starting in version 3.2.6, if \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +(or their aliases \fB\-\-sslCAFile\f1 or \fBssl.CAFile\f1) is not specified, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. In previous versions of -MongoDB, the \fI\%mongo\fP shell exited with an error that it +MongoDB, \fBmongosh\f1\f1 exited with an error that it could not validate the certificate. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCRLFile -New in version 4.2: In MongoDB 4.0 and earlier, see \fI\%\-\-sslCRLFile\fP\&. - -.sp -Specifies the \fB\&.pem\fP file that contains the Certificate Revocation -List. Specify the file name of the \fB\&.pem\fP file using relative or +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsCRLFile\f1 +.RS +.PP +In MongoDB 4.0 and earlier, see \fB\-\-sslCRLFile\f1\f1\&. +.PP +Specifies the \&.pem file that contains the Certificate Revocation +List. Specify the file name of the \&.pem file using relative or absolute paths. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.PP Starting in version 4.4, to check for certificate revocation, -MongoDB \fBenables\fP the use of OCSP +MongoDB \fBenables\f1\f1 the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowInvalidHostnames -New in version 4.2. - -.sp +.RE +.PP +\fBmongo \-\-tlsAllowInvalidHostnames\f1 +.RS +.PP Disables the validation of the hostnames in the certificate presented -by the \fBmongod\fP/\fBmongos\fP instance. Allows -\fBmongo\fP to connect to MongoDB instances even if the hostname in +by the \fBmongod\f1\f1/\fBmongos\f1\f1 instance. Allows +\fBmongo\f1\f1 to connect to MongoDB instances even if the hostname in the server certificates do not match the server\(aqs host. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsAllowInvalidCertificates -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsAllowInvalidCertificates\f1 +.RS +.PP Bypasses the validation checks for the certificates presented by the -\fBmongod\fP/\fBmongos\fP instance and allows +\fBmongod\f1\f1/\fBmongos\f1\f1 instance and allows connections to servers that present invalid certificates. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.0, if you specify -\fB\-\-sslAllowInvalidCertificates\fP or -\fBnet.ssl.allowInvalidCertificates: true\fP (or in MongoDB 4.2, the -alias \fB\-\-tlsAllowInvalidateCertificates\fP or -\fBnet.tls.allowInvalidCertificates: true\fP) when using x.509 +.PP +Starting in MongoDB 4.2, if you specify +\fB\-\-tlsAllowInvalidateCertificates\f1 or +\fBnet.tls.allowInvalidCertificates: true\f1 when using x.509 authentication, an invalid certificate is only sufficient to -establish a TLS/SSL connection but is \fIinsufficient\fP for +establish a TLS connection but it is \fIinsufficient\f1 for authentication. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Although available, avoid using the -\fB\-\-sslAllowInvalidCertificates\fP option if possible. If the use of -\fB\-\-sslAllowInvalidCertificates\fP is necessary, only use the option +\fB\-\-sslAllowInvalidCertificates\f1 option if possible. If the use of +\fB\-\-sslAllowInvalidCertificates\f1 is necessary, only use the option on systems where intrusion is not possible. -.sp -If the \fI\%mongo\fP shell (and other -mongodb\-tools\-support\-ssl) runs with the -\fB\-\-sslAllowInvalidCertificates\fP option, the -\fI\%mongo\fP shell (and other -mongodb\-tools\-support\-ssl) will not attempt to validate +.PP +If \fBmongosh\f1\f1 (and other +\fBMongoDB Tools\f1) runs with the +\fB\-\-sslAllowInvalidCertificates\f1 option, +\fBmongosh\f1\f1 (and other +\fBMongoDB Tools\f1) will not attempt to validate the server certificates. This creates a vulnerability to expired -\fBmongod\fP and \fBmongos\fP certificates as +\fBmongod\f1\f1 and \fBmongos\f1\f1 certificates as well as to foreign processes posing as valid -\fBmongod\fP or \fBmongos\fP instances. If you +\fBmongod\f1\f1 or \fBmongos\f1\f1 instances. If you only need to disable the validation of the hostname in the -TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\fP\&. -.UNINDENT -.UNINDENT -.sp -When using the \fBallowInvalidCertificates\fP setting, +TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\f1\&. +.PP +When using the \fBallowInvalidCertificates\f1\f1 setting, MongoDB logs as a warning the use of the invalid certificate. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsFIPSMode -New in version 4.2. - -.sp -Directs the \fBmongo\fP to use the FIPS mode of the TLS/SSL +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-tlsFIPSMode\f1 +.RS +.PP +Directs the \fBmongo\f1\f1 to use the FIPS mode of the TLS/SSL library. Your system must have a FIPS compliant library to use -the \fI\%\-\-tlsFIPSMode\fP option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +the \fB\-\-tlsFIPSMode\f1\f1 option. +.PP FIPS\-compatible TLS/SSL is -available only in \fI\%MongoDB Enterprise\fP\&. See -/tutorial/configure\-fips for more information. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateSelector = -New in version 4.2: Available on Windows and macOS as an alternative to \fI\%\-\-tlsCertificateKeyFile\fP\&. -.sp -The \fI\%\-\-tlsCertificateKeyFile\fP and \fI\%\-\-tlsCertificateSelector\fP options are mutually exclusive. You can only +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See +\fBConfigure MongoDB for FIPS\f1 for more information. +.RE +.PP +\fBmongo \-\-tlsCertificateSelector\f1 +.RS +.PP +Available on Windows and macOS as an alternative to \fB\-\-tlsCertificateKeyFile\f1\f1\&. +.PP +The \fB\-\-tlsCertificateKeyFile\f1\f1 and \fB\-\-tlsCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store. -.sp -\fI\%\-\-tlsCertificateSelector\fP accepts an argument of the format \fB=\fP +.PP +\fB\-\-tlsCertificateSelector\f1\f1 accepts an argument of the format \fB=\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates. -.sp -Changed in version 4.4: \fBmongod\fP / \fBmongos\fP logs a warning on -connection if the presented x.509 certificate expires within \fB30\fP -days of the \fBmongod/mongos\fP host system time. See -4.4\-rel\-notes\-certificate\-expiration\-warning for more +.PP +\fBmongod\f1\f1 / \fBmongos\f1\f1 logs a warning on +connection if the presented x.509 certificate expires within \fB30\f1 +days of the \fBmongod/mongos\f1 host system time. See +\fBx.509 Certificates Nearing Expiry Trigger Warnings\f1 for more information. - -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsDisabledProtocols -New in version 4.2. - -.sp +.RE +.PP +\fBmongo \-\-tlsDisabledProtocols\f1 +.RS +.PP Disables the specified TLS protocols. The option recognizes the -following protocols: \fBTLS1_0\fP, \fBTLS1_1\fP, \fBTLS1_2\fP, and -starting in version 4.0.4 (and 3.6.9 and 3.4.24), \fBTLS1_3\fP\&. -.INDENT 7.0 +following protocols: \fBTLS1_0\f1, \fBTLS1_1\f1, \fBTLS1_2\f1, and +starting in version 4.0.4 (and 3.6.9 and 3.4.24), \fBTLS1_3\f1\&. +.RS .IP \(bu 2 -On macOS, you cannot disable \fBTLS1_1\fP and leave both \fBTLS1_0\fP and -\fBTLS1_2\fP enabled. You must also disable at least one of the other -two; for example, \fBTLS1_0,TLS1_1\fP\&. +On macOS, you cannot disable \fBTLS1_1\f1 and leave both \fBTLS1_0\f1 and +\fBTLS1_2\f1 enabled. You must also disable at least one of the other +two; for example, \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 To list multiple protocols, specify as a comma separated list of -protocols. For example \fBTLS1_0,TLS1_1\fP\&. +protocols. For example \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 The specified disabled protocols overrides any default disabled protocols. -.UNINDENT -.sp +.RE +.PP Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the -disabled TLS 1.0, specify \fBnone\fP to \fI\%\-\-tlsDisabledProtocols\fP\&. See 4.0\-disable\-tls\&. -.UNINDENT -.SS SSL Options (Deprecated) -.sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 +disabled TLS 1.0, specify \fBnone\f1 to \fB\-\-tlsDisabledProtocols\f1\f1\&. See \fBDisable TLS 1.0\f1\&. +.RE +.SS SSL OPTIONS (DEPRECATED) +.PP Starting in version 4.2, the SSL options are deprecated. Use the TLS counterparts instead. The SSL protocol is deprecated and MongoDB supports TLS 1.0 and later. -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Starting in version 4.0, \fI\%mongo\fP disables support for TLS 1.0 +.PP +Starting in version 4.0, \fBmongo\f1\f1 disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ssl -Deprecated since version 4.2: Use \fI\%\-\-tls\fP instead. - -.sp -Enables connection to a \fBmongod\fP or \fBmongos\fP that has +more details, see \fBDisable TLS 1.0\f1\&. +.PP +\fBmongo \-\-ssl\f1 +.RS +.PP +Use \fB\-\-tls\f1\f1 instead. +.PP +Enables connection to a \fBmongod\f1\f1 or \fBmongos\f1\f1 that has TLS/SSL support enabled. -.sp -Starting in version 3.2.6, if \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -(or their aliases \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP) is not +.PP +Starting in version 3.2.6, if \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +(or their aliases \fB\-\-sslCAFile\f1 or \fBssl.CAFile\f1) is not specified, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. In previous versions of -MongoDB, the \fI\%mongo\fP shell exited with an error that it +MongoDB, \fBmongosh\f1\f1 exited with an error that it could not validate the certificate. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyFile -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateKeyFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains both the TLS/SSL certificate -and key. Specify the file name of the \fB\&.pem\fP file using relative +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslPEMKeyFile\f1 +.RS +.PP +Use \fB\-\-tlsCertificateKeyFile\f1\f1 instead. +.PP +Specifies 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. -.sp -This option is required when using the \fB\-\-ssl\fP option to connect -to a \fBmongod\fP or \fBmongos\fP that has -\fBCAFile\fP enabled \fIwithout\fP -\fBallowConnectionsWithoutCertificates\fP\&. -.sp +.PP +This option is required when using the \fB\-\-ssl\f1 option to connect +to a \fBmongod\f1\f1 or \fBmongos\f1\f1 that has +\fBCAFile\f1\f1 enabled \fIwithout\f1 +\fBallowConnectionsWithoutCertificates\f1\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyPassword -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateKeyFilePassword\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslPEMKeyPassword\f1 +.RS +.PP +Use \fB\-\-tlsCertificateKeyFilePassword\f1\f1 instead. +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fB\-\-sslPEMKeyFile\fP). Use the \fI\%\-\-sslPEMKeyPassword\fP option only if the -certificate\-key file is encrypted. In all cases, the \fBmongo\fP will +\fB\-\-sslPEMKeyFile\f1). Use the \fB\-\-sslPEMKeyPassword\f1\f1 option only if the +certificate\-key file is encrypted. In all cases, the \fBmongo\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP If the private key in the PEM file is encrypted and you do not -specify the \fI\%\-\-sslPEMKeyPassword\fP option, the \fBmongo\fP will prompt for a -passphrase. See ssl\-certificate\-password\&. -.sp +specify the \fB\-\-sslPEMKeyPassword\f1\f1 option, the \fBmongo\f1\f1 will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCAFile -Deprecated since version 4.2: Use \fI\%\-\-tlsCAFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the root certificate chain +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslCAFile\f1 +.RS +.PP +Use \fB\-\-tlsCAFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the -\fB\&.pem\fP file using relative or absolute paths. -.sp -Starting in version 3.2.6, if \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -(or their aliases \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP) is not +\&.pem file using relative or absolute paths. +.PP +Starting in version 3.2.6, if \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +(or their aliases \fB\-\-sslCAFile\f1 or \fBssl.CAFile\f1) is not specified, the system\-wide CA certificate store will be used when connecting to an TLS/SSL\-enabled server. In previous versions of -MongoDB, the \fI\%mongo\fP shell exited with an error that it +MongoDB, \fBmongosh\f1\f1 exited with an error that it could not validate the certificate. -.sp -To use x.509 authentication, \fB\-\-tlsCAFile\fP or \fBnet.tls.CAFile\fP -must be specified unless using \fB\-\-tlsCertificateSelector\fP or -\fB\-\-net.tls.certificateSelector\fP\&. Or if using the \fBssl\fP aliases, -\fB\-\-sslCAFile\fP or \fBnet.ssl.CAFile\fP must be specified unless using -\fB\-\-sslCertificateSelector\fP or \fBnet.ssl.certificateSelector\fP\&. -.sp +.PP +To use x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBnet.tls.CAFile\f1 +must be specified unless you are using \fB\-\-tlsCertificateSelector\f1 +or \fB\-\-net.tls.certificateSelector\f1\&. +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCertificateSelector = -Deprecated since version 4.2: Use \fI\%\-\-tlsCertificateSelector\fP instead. - -.sp -New in version 4.0: Available on Windows and macOS as an alternative to \fI\%\-\-tlsCertificateKeyFile\fP\&. -.sp -\fI\%\-\-tlsCertificateKeyFile\fP and \fI\%\-\-sslCertificateSelector\fP options are mutually exclusive. You can only +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslCertificateSelector\f1 +.RS +.PP +Use \fB\-\-tlsCertificateSelector\f1\f1 instead. +.PP +Available on Windows and macOS as an alternative to \fB\-\-tlsCertificateKeyFile\f1\f1\&. +.PP +\fB\-\-tlsCertificateKeyFile\f1\f1 and \fB\-\-sslCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. - -.sp +.PP Specifies a certificate property in order to select a matching certificate from the operating system\(aqs certificate store. -.sp -\fI\%\-\-sslCertificateSelector\fP accepts an argument of the format \fB=\fP +.PP +\fB\-\-sslCertificateSelector\f1\f1 accepts an argument of the format \fB=\f1 where the property can be one of the following: -.TS -center; -|l|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Property -T} T{ +.IP \(bu 4 Value type -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBsubject\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubject\f1 +.IP \(bu 4 ASCII string -T} T{ +.IP \(bu 4 Subject name or common name on certificate -T} -_ -T{ -\fBthumbprint\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBthumbprint\f1 +.IP \(bu 4 hex string -T} T{ +.IP \(bu 4 A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA\-1 digest. -.sp -The \fBthumbprint\fP is sometimes referred to as a -\fBfingerprint\fP\&. -T} -_ -.TE -.sp +.IP +The \fBthumbprint\f1 is sometimes referred to as a +\fBfingerprint\f1\&. +.RE +.RE +.PP When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCRLFile -Deprecated since version 4.2: Use \fI\%\-\-tlsCRLFile\fP instead. - -.sp -Specifies the \fB\&.pem\fP file that contains the Certificate Revocation -List. Specify the file name of the \fB\&.pem\fP file using relative or +.RE +.PP +\fBmongo \-\-sslCRLFile\f1 +.RS +.PP +Use \fB\-\-tlsCRLFile\f1\f1 instead. +.PP +Specifies the \&.pem file that contains the Certificate Revocation +List. Specify the file name of the \&.pem file using relative or absolute paths. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Starting in version 4.4, to check for certificate revocation, -MongoDB \fBenables\fP the use of OCSP +MongoDB \fBenables\f1\f1 the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store. -.UNINDENT -.UNINDENT -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslFIPSMode -Deprecated since version 4.2: Use \fI\%\-\-tlsFIPSMode\fP instead. - -.sp -Directs the \fBmongo\fP to use the FIPS mode of the TLS/SSL +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslFIPSMode\f1 +.RS +.PP +Use \fB\-\-tlsFIPSMode\f1\f1 instead. +.PP +Directs the \fBmongo\f1\f1 to use the FIPS mode of the TLS/SSL library. Your system must have a FIPS compliant library to use -the \fI\%\-\-sslFIPSMode\fP option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +the \fB\-\-sslFIPSMode\f1\f1 option. +.PP FIPS\-compatible TLS/SSL is -available only in \fI\%MongoDB Enterprise\fP\&. See -/tutorial/configure\-fips for more information. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowInvalidCertificates -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowInvalidCertificates\fP instead. - -.sp +available only in MongoDB Enterprise (http://www.mongodb.com/products/mongodb\-enterprise\-advanced?tck=docs_server)\&. See +\fBConfigure MongoDB for FIPS\f1 for more information. +.RE +.PP +\fBmongo \-\-sslAllowInvalidCertificates\f1 +.RS +.PP +Use \fB\-\-tlsAllowInvalidCertificates\f1\f1 instead. +.PP Bypasses the validation checks for server certificates and allows the use of invalid certificates to connect. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.0, if you specify -\fB\-\-sslAllowInvalidCertificates\fP or -\fBnet.ssl.allowInvalidCertificates: true\fP (or in MongoDB 4.2, the -alias \fB\-\-tlsAllowInvalidateCertificates\fP or -\fBnet.tls.allowInvalidCertificates: true\fP) when using x.509 +.PP +Starting in MongoDB 4.2, if you specify +\fB\-\-tlsAllowInvalidateCertificates\f1 or +\fBnet.tls.allowInvalidCertificates: true\f1 when using x.509 authentication, an invalid certificate is only sufficient to -establish a TLS/SSL connection but is \fIinsufficient\fP for +establish a TLS connection but it is \fIinsufficient\f1 for authentication. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Although available, avoid using the -\fB\-\-sslAllowInvalidCertificates\fP option if possible. If the use of -\fB\-\-sslAllowInvalidCertificates\fP is necessary, only use the option +\fB\-\-sslAllowInvalidCertificates\f1 option if possible. If the use of +\fB\-\-sslAllowInvalidCertificates\f1 is necessary, only use the option on systems where intrusion is not possible. -.sp -If the \fI\%mongo\fP shell (and other -mongodb\-tools\-support\-ssl) runs with the -\fB\-\-sslAllowInvalidCertificates\fP option, the -\fI\%mongo\fP shell (and other -mongodb\-tools\-support\-ssl) will not attempt to validate +.PP +If \fBmongosh\f1\f1 (and other +\fBMongoDB Tools\f1) runs with the +\fB\-\-sslAllowInvalidCertificates\f1 option, +\fBmongosh\f1\f1 (and other +\fBMongoDB Tools\f1) will not attempt to validate the server certificates. This creates a vulnerability to expired -\fBmongod\fP and \fBmongos\fP certificates as +\fBmongod\f1\f1 and \fBmongos\f1\f1 certificates as well as to foreign processes posing as valid -\fBmongod\fP or \fBmongos\fP instances. If you +\fBmongod\f1\f1 or \fBmongos\f1\f1 instances. If you only need to disable the validation of the hostname in the -TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\fP\&. -.UNINDENT -.UNINDENT -.sp -When using the \fBallowInvalidCertificates\fP setting, +TLS/SSL certificates, see \fB\-\-sslAllowInvalidHostnames\f1\&. +.PP +When using the \fBallowInvalidCertificates\f1\f1 setting, MongoDB logs as a warning the use of the invalid certificate. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslAllowInvalidHostnames -Deprecated since version 4.2: Use \fI\%\-\-tlsAllowInvalidHostnames\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslAllowInvalidHostnames\f1 +.RS +.PP +Use \fB\-\-tlsAllowInvalidHostnames\f1\f1 instead. +.PP Disables the validation of the hostnames in TLS/SSL certificates. Allows -\fBmongo\fP to connect to MongoDB instances even if the hostname in their +\fBmongo\f1\f1 to connect to MongoDB instances even if the hostname in their certificates do not match the specified hostname. -.sp +.PP For more information about TLS/SSL and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslDisabledProtocols -Deprecated since version 4.2: Use \fI\%\-\-tlsDisabledProtocols\fP instead. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongo \-\-sslDisabledProtocols\f1 +.RS +.PP +Use \fB\-\-tlsDisabledProtocols\f1\f1 instead. +.PP Disables the specified TLS protocols. The option recognizes the -following protocols: \fBTLS1_0\fP, \fBTLS1_1\fP, \fBTLS1_2\fP, and -starting in version 4.0.4 (and 3.6.9), \fBTLS1_3\fP\&. -.INDENT 7.0 +following protocols: \fBTLS1_0\f1, \fBTLS1_1\f1, \fBTLS1_2\f1, and +starting in version 4.0.4 (and 3.6.9), \fBTLS1_3\f1\&. +.RS .IP \(bu 2 -On macOS, you cannot disable \fBTLS1_1\fP and leave both \fBTLS1_0\fP and -\fBTLS1_2\fP enabled. You must also disable at least one of the other -two; for example, \fBTLS1_0,TLS1_1\fP\&. +On macOS, you cannot disable \fBTLS1_1\f1 and leave both \fBTLS1_0\f1 and +\fBTLS1_2\f1 enabled. You must also disable at least one of the other +two; for example, \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 To list multiple protocols, specify as a comma separated list of -protocols. For example \fBTLS1_0,TLS1_1\fP\&. +protocols. For example \fBTLS1_0,TLS1_1\f1\&. .IP \(bu 2 The specified disabled protocols overrides any default disabled protocols. -.UNINDENT -.sp +.RE +.PP Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the -disabled TLS 1.0, specify \fBnone\fP to \fI\%\-\-sslDisabledProtocols\fP\&. See 4.0\-disable\-tls\&. -.sp -New in version 3.6.5. - -.UNINDENT -.SS Sessions -.INDENT 0.0 -.TP -.B \-\-retryWrites -New in version 3.6. - -.sp +disabled TLS 1.0, specify \fBnone\f1 to \fB\-\-sslDisabledProtocols\f1\f1\&. See \fBDisable TLS 1.0\f1\&. +.RE +.SS SESSIONS +.PP +\fBmongo \-\-retryWrites\f1 +.RS +.PP Enables retryable writes as the default for sessions in the -\fI\%mongo\fP shell. -.sp -For more information on sessions, see sessions\&. -.UNINDENT -.SS Client\-Side Field Level Encryption Options -.INDENT 0.0 -.TP -.B \-\-awsAccessKeyId -An AWS \fI\%Access Key\fP -associated to an IAM user with \fBList\fP and \fBRead\fP permissions for the -AWS Key Management Service (KMS). The \fBmongo\fP shell uses the specified -\fI\%\-\-awsAccessKeyId\fP to access the KMS. -.sp -\fI\%\-\-awsAccessKeyId\fP is required for enabling /core/security\-client\-side\-encryption -for the \fBmongo\fP shell session. \fI\%\-\-awsAccessKeyId\fP requires \fIall\fP of the following +\fBmongo\f1\f1 shell. +.PP +For more information on sessions, see \fBClient Sessions and Causal Consistency Guarantees\f1\&. +.RE +.SS CLIENT-SIDE FIELD LEVEL ENCRYPTION OPTIONS +.PP +\fBmongo \-\-awsAccessKeyId\f1 +.RS +.PP +An AWS Access Key (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access\-keys.html) +associated to an IAM user with \fBList\f1 and \fBRead\f1 permissions for the +AWS Key Management Service (KMS). The \fBmongo\f1\f1 shell uses the specified +\fB\-\-awsAccessKeyId\f1\f1 to access the KMS. +.PP +\fB\-\-awsAccessKeyId\f1\f1 is required for enabling \fBClient\-Side Field Level Encryption\f1 +for the \fBmongo\f1\f1 shell session. \fB\-\-awsAccessKeyId\f1\f1 requires \fIall\f1 of the following command line options: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-awsSecretAccessKey\fP +\fB\-\-awsSecretAccessKey\f1\f1 .IP \(bu 2 -\fI\%\-\-keyVaultNamespace\fP -.UNINDENT -.sp -If \fI\%\-\-awsAccessKeyId\fP is omitted, use the \fBMongo()\fP constructor within the shell +\fB\-\-keyVaultNamespace\f1\f1 +.RE +.PP +If \fB\-\-awsAccessKeyId\f1\f1 is omitted, use the \fBMongo()\f1\f1 constructor within the shell session to enable client\-side field level encryption. -.sp +.PP To mitigate the risk of leaking access keys into logs, consider specifying -an environmental variable to \fI\%\-\-awsAccessKeyId\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-awsSecretAccessKey -An AWS \fI\%Secret Key\fP -associated to the specified \fI\%\-\-awsAccessKeyId\fP\&. -.sp -\fI\%\-\-awsSecretAccessKey\fP is required for enabling /core/security\-client\-side\-encryption -for the \fBmongo\fP shell session. \fI\%\-\-awsSecretAccessKey\fP requires \fIall\fP of the following +an environmental variable to \fB\-\-awsAccessKeyId\f1\f1\&. +.RE +.PP +\fBmongo \-\-awsSecretAccessKey\f1 +.RS +.PP +An AWS Secret Key (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access\-keys.html) +associated to the specified \fB\-\-awsAccessKeyId\f1\f1\&. +.PP +\fB\-\-awsSecretAccessKey\f1\f1 is required for enabling \fBClient\-Side Field Level Encryption\f1 +for the \fBmongo\f1\f1 shell session. \fB\-\-awsSecretAccessKey\f1\f1 requires \fIall\f1 of the following command line options: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-awsAccessKeyId\fP +\fB\-\-awsAccessKeyId\f1\f1 .IP \(bu 2 -\fI\%\-\-keyVaultNamespace\fP -.UNINDENT -.sp -If \fI\%\-\-awsSecretAccessKey\fP and its supporting options are omitted, use \fBMongo()\fP +\fB\-\-keyVaultNamespace\f1\f1 +.RE +.PP +If \fB\-\-awsSecretAccessKey\f1\f1 and its supporting options are omitted, use \fBMongo()\f1\f1 within the shell session to enable client\-side field level encryption. -.sp +.PP To mitigate the risk of leaking access keys into logs, consider specifying -an environmental variable to \fI\%\-\-awsSecretAccessKey\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-awsSessionToken -An AWS \fI\%Session Token\fP -associated to the specified \fI\%\-\-awsAccessKeyId\fP\&. -.sp -\fI\%\-\-awsSessionToken\fP is required for enabling /core/security\-client\-side\-encryption -for the \fBmongo\fP shell session. \fI\%\-\-awsSessionToken\fP requires \fIall\fP of the following +an environmental variable to \fB\-\-awsSecretAccessKey\f1\f1\&. +.RE +.PP +\fBmongo \-\-awsSessionToken\f1 +.RS +.PP +An AWS Session Token (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access\-keys.html) +associated to the specified \fB\-\-awsAccessKeyId\f1\f1\&. +.PP +\fB\-\-awsSessionToken\f1\f1 is required for enabling \fBClient\-Side Field Level Encryption\f1 +for the \fBmongo\f1\f1 shell session. \fB\-\-awsSessionToken\f1\f1 requires \fIall\f1 of the following command line options: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-awsAccessKeyId\fP +\fB\-\-awsAccessKeyId\f1\f1 .IP \(bu 2 -\fI\%\-\-awsSecretAccessKey\fP +\fB\-\-awsSecretAccessKey\f1\f1 .IP \(bu 2 -\fI\%\-\-keyVaultNamespace\fP -.UNINDENT -.sp -If \fI\%\-\-awsSessionToken\fP and its supporting options are omitted, use \fBMongo()\fP +\fB\-\-keyVaultNamespace\f1\f1 +.RE +.PP +If \fB\-\-awsSessionToken\f1\f1 and its supporting options are omitted, use \fBMongo()\f1\f1 within the shell session to enable client\-side field level encryption. -.sp +.PP To mitigate the risk of leaking access keys into logs, consider specifying -an environmental variable to \fI\%\-\-awsSessionToken\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyVaultNamespace -The full namespace (\fB.\fP) of the collection used as a -key vault for /core/security\-client\-side\-encryption\&. \fI\%\-\-keyVaultNamespace\fP is -required for enabling client\-side field level encryption. for the \fBmongo\fP -shell session. \fBmongo\fP creates the specified namespace if it does not +an environmental variable to \fB\-\-awsSessionToken\f1\f1\&. +.RE +.PP +\fBmongo \-\-keyVaultNamespace\f1 +.RS +.PP +The full namespace (\fB.\f1) of the collection used as a +key vault for \fBClient\-Side Field Level Encryption\f1\&. \fB\-\-keyVaultNamespace\f1\f1 is +required for enabling client\-side field level encryption. for the \fBmongo\f1\f1 +shell session. \fBmongo\f1\f1 creates the specified namespace if it does not exist. -.sp -\fI\%\-\-keyVaultNamespace\fP requires \fIall\fP of the following command line options: -.INDENT 7.0 +.PP +\fB\-\-keyVaultNamespace\f1\f1 requires \fIall\f1 of the following command line options: +.RS .IP \(bu 2 -\fI\%\-\-awsAccessKeyId\fP +\fB\-\-awsAccessKeyId\f1\f1 .IP \(bu 2 -\fI\%\-\-awsSecretAccessKey\fP -.UNINDENT -.sp -If \fI\%\-\-keyVaultNamespace\fP and its supporting options are omitted, use the \fBMongo()\fP +\fB\-\-awsSecretAccessKey\f1\f1 +.RE +.PP +If \fB\-\-keyVaultNamespace\f1\f1 and its supporting options are omitted, use the \fBMongo()\f1\f1 constructor within the shell session to enable client\-side field level encryption. -.UNINDENT +.RE .SH FILES -.INDENT 0.0 -.TP -.B \fB~/.dbshell\fP -\fI\%mongo\fP maintains a history of commands in the \fB\&.dbshell\fP +.PP +\fB~/.dbshell\f1 +.RS +.PP +\fBmongo\f1\f1 maintains a history of commands in the \&.dbshell file. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%mongo\fP does not record interaction related to +.PP +\fBmongo\f1\f1 does not record interaction related to authentication in the history file, including -\fBauthenticate\fP and \fBdb.createUser()\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \fB~/.mongorc.js\fP -\fI\%mongo\fP will read the \fB\&.mongorc.js\fP file from the home -directory of the user invoking \fI\%mongo\fP\&. In the file, users -can define variables, customize the \fI\%mongo\fP shell prompt, +\fBauthenticate\f1\f1 and \fBdb.createUser()\f1\f1\&. +.RE +.PP +\fB~/.mongorc.js\f1 +.RS +.PP +\fBmongo\f1\f1 will read the \fB\&.mongorc.js\f1 file from the home +directory of the user invoking \fBmongo\f1\f1\&. In the file, users +can define variables, customize the \fBmongo\f1\f1 shell prompt, or update information that they would like updated every time they launch a shell. If you use the shell to evaluate a JavaScript file -or expression either on the command line with \fI\%mongo \-\-eval\fP or -by specifying \fI\%a .js file to mongo\fP, -\fI\%mongo\fP will read the \fB\&.mongorc.js\fP file \fIafter\fP the +or expression either on the command line with \fBmongo \-\-eval\f1\f1 or +by specifying \fBa .js file to mongo\f1, +\fBmongo\f1\f1 will read the \fB\&.mongorc.js\f1 file \fIafter\f1 the JavaScript has finished processing. -.sp -Specify the \fI\%\-\-norc\fP option to disable -reading \fB\&.mongorc.js\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \fB/etc/mongorc.js\fP -Global \fBmongorc.js\fP file which the \fI\%mongo\fP shell -evaluates upon start\-up. If a user also has a \fB\&.mongorc.js\fP -file located in the \fI\%HOME\fP directory, the \fI\%mongo\fP -shell evaluates the global \fB/etc/mongorc.js\fP file \fIbefore\fP -evaluating the user\(aqs \fB\&.mongorc.js\fP file. -.sp -\fB/etc/mongorc.js\fP must have read permission for the user -running the shell. The \fI\%\-\-norc\fP option for \fI\%mongo\fP -suppresses only the user\(aqs \fB\&.mongorc.js\fP file. -.sp -On Windows, the global \fBmongorc.js \fP exists -in the \fB%ProgramData%\eMongoDB\fP directory. -.TP -.B \fB/tmp/mongo_edit\fP\fI\fP\fB\&.js\fP -Created by \fI\%mongo\fP when editing a file. If the file exists, -\fI\%mongo\fP will append an integer from \fB1\fP to \fB10\fP to the +.PP +Specify the \fB\-\-norc\f1\f1 option to disable +reading \fB\&.mongorc.js\f1\&. +.RE +.PP +\fB/etc/mongorc.js\f1 +.RS +.PP +Global \fBmongorc.js\f1 file which the \fBmongo\f1\f1 shell +evaluates upon start\-up. If a user also has a \&.mongorc.js +file located in the \fBHOME\f1\f1 directory, the \fBmongo\f1\f1 +shell evaluates the global /etc/mongorc.js file \fIbefore\f1 +evaluating the user\(aqs \&.mongorc.js file. +.PP +/etc/mongorc.js must have read permission for the user +running the shell. The \fB\-\-norc\f1\f1 option for \fBmongo\f1\f1 +suppresses only the user\(aqs \&.mongorc.js file. +.PP +On Windows, the global mongorc.js exists +in the %ProgramData%\MongoDB directory. +.RE +.PP +\fB/tmp/mongo_edit{}.js\f1 +.RS +.PP +Created by \fBmongo\f1\f1 when editing a file. If the file exists, +\fBmongo\f1\f1 will append an integer from \fB1\f1 to \fB10\f1 to the time value to attempt to create a unique file. -.TP -.B \fB%TEMP%mongo_edit\fP\fI\fP\fB\&.js\fP -Created by \fBmongo.exe\fP on Windows when editing a file. If -the file exists, \fI\%mongo\fP will append an integer from \fB1\fP -to \fB10\fP to the time value to attempt to create a unique file. -.UNINDENT +.RE +.PP +\fB%TEMP%mongo_edit{}.js\f1 +.RS +.PP +Created by \fBmongo.exe\f1\f1 on Windows when editing a file. If +the file exists, \fBmongo\f1\f1 will append an integer from \fB1\f1 +to \fB10\f1 to the time value to attempt to create a unique file. +.RE .SH ENVIRONMENT -.INDENT 0.0 -.TP -.B EDITOR -Specifies the path to an editor to use with the \fBedit\fP shell -command. A JavaScript variable \fBEDITOR\fP will override the value of -\fI\%EDITOR\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B HOME -Specifies the path to the home directory where \fI\%mongo\fP will -read the \fB\&.mongorc.js\fP file and write the \fB\&.dbshell\fP +.PP +\fBEDITOR\f1 +.RS +.PP +Specifies the path to an editor to use with the \fBedit\f1 shell +command. A JavaScript variable \fBEDITOR\f1 will override the value of +\fBEDITOR\f1\f1\&. +.RE +.PP +\fBHOME\f1 +.RS +.PP +Specifies the path to the home directory where \fBmongo\f1\f1 will +read the \&.mongorc.js file and write the \&.dbshell file. -.UNINDENT -.INDENT 0.0 -.TP -.B HOMEDRIVE -On Windows systems, \fI\%HOMEDRIVE\fP specifies the path the -directory where \fI\%mongo\fP will read the \fB\&.mongorc.js\fP -file and write the \fB\&.dbshell\fP file. -.UNINDENT -.INDENT 0.0 -.TP -.B HOMEPATH +.RE +.PP +\fBHOMEDRIVE\f1 +.RS +.PP +On Windows systems, \fBHOMEDRIVE\f1\f1 specifies the path the +directory where \fBmongo\f1\f1 will read the \&.mongorc.js +file and write the \&.dbshell file. +.RE +.PP +\fBHOMEPATH\f1 +.RS +.PP Specifies the Windows path to the home directory where -\fI\%mongo\fP will read the \fB\&.mongorc.js\fP file and write -the \fB\&.dbshell\fP file. -.UNINDENT +\fBmongo\f1\f1 will read the \&.mongorc.js file and write +the \&.dbshell file. +.RE .SH KEYBOARD SHORTCUTS -.sp -The \fI\%mongo\fP shell supports the following keyboard shortcuts: -[1] -.TS -center; -|l|l|. -_ -T{ -\fBKeybinding\fP -T} T{ -\fBFunction\fP -T} -_ -T{ +.PP +The \fBmongo\f1\f1 shell supports the following keyboard shortcuts: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 +Keybinding +.IP \(bu 4 +Function +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Up arrow -T} T{ +.IP \(bu 4 Retrieve previous command from history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Down\-arrow -T} T{ +.IP \(bu 4 Retrieve next command from history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Home -T} T{ +.IP \(bu 4 Go to beginning of the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 End -T} T{ +.IP \(bu 4 Go to end of the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Tab -T} T{ +.IP \(bu 4 Autocomplete method/command -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Left\-arrow -T} T{ +.IP \(bu 4 Go backward one character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Right\-arrow -T} T{ +.IP \(bu 4 Go forward one character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-left\-arrow -T} T{ +.IP \(bu 4 Go backward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-right\-arrow -T} T{ +.IP \(bu 4 Go forward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-left\-arrow -T} T{ +.IP \(bu 4 Go backward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-right\-arrow -T} T{ +.IP \(bu 4 Go forward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-A -T} T{ +.IP \(bu 4 Go to the beginning of the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-B -T} T{ +.IP \(bu 4 Go backward one character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-C -T} T{ -Exit the \fI\%mongo\fP shell -T} -_ -T{ +.IP \(bu 4 +Exit the \fBmongo\f1\f1 shell +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-D -T} T{ -Delete a char (or exit the \fI\%mongo\fP shell) -T} -_ -T{ +.IP \(bu 4 +Delete a char (or exit the \fBmongo\f1\f1 shell) +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-E -T} T{ +.IP \(bu 4 Go to the end of the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-F -T} T{ +.IP \(bu 4 Go forward one character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-G -T} T{ +.IP \(bu 4 Abort -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-J -T} T{ +.IP \(bu 4 Accept/evaluate the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-K -T} T{ +.IP \(bu 4 Kill/erase the line -T} -_ -T{ -Ctrl\-L or type \fBcls\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +Ctrl\-L or type \fBcls\f1 +.IP \(bu 4 Clear the screen -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-M -T} T{ +.IP \(bu 4 Accept/evaluate the line -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-N -T} T{ +.IP \(bu 4 Retrieve next command from history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-P -T} T{ +.IP \(bu 4 Retrieve previous command from history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-R -T} T{ +.IP \(bu 4 Reverse\-search command history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-S -T} T{ +.IP \(bu 4 Forward\-search command history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-T -T} T{ +.IP \(bu 4 Transpose characters -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-U -T} T{ +.IP \(bu 4 Perform Unix line\-discard -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-W -T} T{ +.IP \(bu 4 Perform Unix word\-rubout -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-Y -T} T{ +.IP \(bu 4 Yank -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-Z -T} T{ +.IP \(bu 4 Suspend (job control works in linux) -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-H -T} T{ +.IP \(bu 4 Backward\-delete a character -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Ctrl\-I -T} T{ +.IP \(bu 4 Complete, same as Tab -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-B -T} T{ +.IP \(bu 4 Go backward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-C -T} T{ +.IP \(bu 4 Capitalize word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-D -T} T{ +.IP \(bu 4 Kill word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-F -T} T{ +.IP \(bu 4 Go forward one word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-L -T} T{ +.IP \(bu 4 Change word to lowercase -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-U -T} T{ +.IP \(bu 4 Change word to uppercase -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-Y -T} T{ +.IP \(bu 4 Yank\-pop -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-Backspace -T} T{ +.IP \(bu 4 Backward\-kill word -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-< -T} T{ +.IP \(bu 4 Retrieve the first command in command history -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 Meta\-> -T} T{ +.IP \(bu 4 Retrieve the last command in command history -T} -_ -.TE -.IP [1] 5 -MongoDB accommodates multiple keybinding. -Since 2.0, \fI\%mongo\fP includes support for basic emacs -keybindings. +.RE +.RE .SH USE -.sp -Typically users invoke the shell with the \fI\%mongo\fP command at +.PP +Typically users invoke the shell with the \fBmongo\f1\f1 command at the system prompt. Consider the following examples for other scenarios. -.SS Connect to a \fBmongod\fP Instance with Access Control -.sp +.SS CONNECT TO A MONGOD INSTANCE WITH ACCESS CONTROL +.PP To connect to a database on a remote host using authentication and a non\-standard port, use the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-username \-\-password \-\-host \-\-port 28015 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongo \-\-username \-\-password \-\-host \-\-port 28015 +.EE +.PP Alternatively, consider the following short form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-u \-p \-\-host \-\-port 28015 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Replace \fB\fP and \fB\fP with the appropriate values for your -situation and substitute or omit the \fI\%\-\-port\fP as +.PP +.EX + mongo \-u \-p \-\-host \-\-port 28015 +.EE +.PP +Replace \fB\f1 and \fB\f1 with the appropriate values for your +situation and substitute or omit the \fB\-\-port\f1\f1 as needed. -.sp -If you do not specify the password to the \fI\%\-\-password\fP or \fI\%\-p\fP command\-line option, the -\fI\%mongo\fP shell prompts for the password. -.SS Connect to a Replica Set Using the DNS Seedlist Connection Format -.sp -New in version 3.6. - -.sp +.PP +If you do not specify the password to the \fB\-\-password\f1\f1 or \fB\-p\f1\f1 command\-line option, the +\fBmongo\f1\f1 shell prompts for the password. +.SS CONNECT TO A REPLICA SET USING THE DNS SEEDLIST CONNECTION FORMAT +.PP To connect to a replica set described using the -connections\-dns\-seedlist, use the \fI\%\-\-host\fP option -to specify the connection string to the \fI\%mongo\fP shell. In +\fBDNS Seed List Connection Format\f1, use the \fB\-\-host\f1\f1 option +to specify the connection string to the \fBmongo\f1\f1 shell. In the following example, the DNS configuration resembles: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Record TTL Class Priority Weight Port Target -_mongodb._tcp.server.example.com. 86400 IN SRV 0 5 27317 mongodb1.example.com. -_mongodb._tcp.server.example.com. 86400 IN SRV 0 5 27017 mongodb2.example.com. -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The TXT record for the DNS entry includes the \fBreplicaSet\fP and \fBauthSource\fP options: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -Record TTL Class Text -server.example.com. 86400 IN TXT "replicaSet=rs0&authSource=admin" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The following command then connects the \fI\%mongo\fP shell to +.PP +.EX + Record TTL Class Priority Weight Port Target + _mongodb._tcp.server.example.com. 86400 IN SRV 0 5 27317 mongodb1.example.com. + _mongodb._tcp.server.example.com. 86400 IN SRV 0 5 27017 mongodb2.example.com. +.EE +.PP +The TXT record for the DNS entry includes the \fBreplicaSet\f1 and \fBauthSource\f1 options: +.PP +.EX + Record TTL Class Text + server.example.com. 86400 IN TXT "replicaSet=rs0&authSource=admin" +.EE +.PP +The following command then connects the \fBmongo\f1\f1 shell to the replica set: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-host "mongodb+srv://server.example.com/?username=allison" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The \fI\%mongo\fP shell will automatically prompt you to provide -the password for the user specified in the \fBusername\fP option. -.SS Connect to a MongoDB Atlas Cluster using AWS IAM Credentials -.sp -New in version 4.4. - -.sp -To connect to a \fI\%MongoDB Atlas\fP cluster which -has been configured to support authentication via \fI\%AWS IAM credentials\fP, -provide a connection string to -the \fI\%mongo\fP shell similar to the following: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \(aqmongodb+srv://:@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongo \-\-host "mongodb+srv://server.example.com/?username=allison" +.EE +.PP +The \fBmongo\f1\f1 shell will automatically prompt you to provide +the password for the user specified in the \fBusername\f1 option. +.SS CONNECT TO A MONGODB ATLAS CLUSTER USING AWS IAM CREDENTIALS +.PP +To connect to a MongoDB Atlas (https://www.mongodb.com/cloud/atlas?tck=docs_server) cluster which +has been configured to support authentication via AWS IAM credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access\-keys.html), +provide a \fBconnection string\f1 to +the \fBmongo\f1\f1 shell similar to the following: +.PP +.EX + mongo \(aqmongodb+srv://:@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq +.EE +.PP Connecting to Atlas using AWS IAM credentials in this manner uses the -\fBMONGODB\-AWS\fP \fBauthentication mechanism\fP -and the \fB$external\fP \fBauthSource\fP, as shown in this example. -.sp -If using an \fI\%AWS session token\fP -as well, provide it with the \fBAWS_SESSION_TOKEN\fP -\fBauthMechanismProperties\fP value in your -connection string, as follows: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \(aqmongodb+srv://:@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS&authMechanismProperties=AWS_SESSION_TOKEN:\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +\fBMONGODB\-AWS\f1 \fBauthentication mechanism\f1\f1 +and the \fB$external\f1 \fBauthSource\f1\f1, as shown in this example. +.PP +If using an AWS session token (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use\-resources.html) +as well, provide it with the \fBAWS_SESSION_TOKEN\f1 +\fBauthMechanismProperties\f1\f1 value in your +\fBconnection string\f1, as follows: +.PP +.EX + mongo \(aqmongodb+srv://:@cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS&authMechanismProperties=AWS_SESSION_TOKEN:\(aq +.EE +.PP If the AWS access key ID, secret access key, or session token include -the \(aqat\(aq sign \fB@\fP, colon \fB:\fP, slash \fB/\fP, or the percent sign \fB%\fP -characters, those characters must be converted using \fI\%percent encoding\fP\&. -.sp +the following characters: +.PP +.EX + : / ? # [ ] @ +.EE +.PP +those characters must be converted using percent encoding (https://tools.ietf.org/html/rfc3986#section\-2.1)\&. +.PP Alternatively, the AWS access key ID, and secret access key, and optionally session token can each be provided outside of the connection -string using the \fI\%\-\-username\fP, \fI\%\-\-password\fP, and -\fI\%\-\-awsIamSessionToken\fP options instead, like so: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \(aqmongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq \-\-username \-\-password \-\-awsIamSessionToken -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +string using the \fB\-\-username\f1\f1, \fB\-\-password\f1\f1, and +\fB\-\-awsIamSessionToken\f1\f1 options instead, like so: +.PP +.EX + mongo \(aqmongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq \-\-username \-\-password \-\-awsIamSessionToken +.EE +.PP When provided as command line parameters, these three options do not require percent encoding. -.sp +.PP You may also set these credentials on your platform using standard -\fI\%AWS IAM environment variables\fP\&. -The \fI\%mongo\fP shell checks for the following environment -variables when you use the \fBMONGODB\-AWS\fP -\fBauthentication mechanism\fP: -.INDENT 0.0 +AWS IAM environment variables (https://docs.aws.amazon.com/cli/latest/userguide/cli\-configure\-envvars.html#envvars\-list)\&. +The \fBmongo\f1\f1 shell checks for the following environment +variables when you use the \fBMONGODB\-AWS\f1 +\fBauthentication mechanism\f1\f1: +.RS .IP \(bu 2 -\fBAWS_ACCESS_KEY_ID\fP +\fBAWS_ACCESS_KEY_ID\f1 .IP \(bu 2 -\fBAWS_SECRET_ACCESS_KEY\fP +\fBAWS_SECRET_ACCESS_KEY\f1 .IP \(bu 2 -\fBAWS_SESSION_TOKEN\fP -.UNINDENT -.sp +\fBAWS_SESSION_TOKEN\f1 +.RE +.PP If set, these credentials do not need to be specified in the connection -string or via the explicit options to the \fI\%mongo\fP shell -(i.e. \fI\%\-\-username\fP and \fI\%\-\-password\fP). -.sp -The following example sets these environment variables in the \fBbash\fP +string or via the explicit options to the \fBmongo\f1\f1 shell +(i.e. \fB\-\-username\f1\f1 and \fB\-\-password\f1\f1). +.PP +The following example sets these environment variables in the \fBbash\f1 shell: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -export AWS_ACCESS_KEY_ID=\(aq\(aq -export AWS_SECRET_ACCESS_KEY=\(aq\(aq -export AWS_SESSION_TOKEN=\(aq\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + export AWS_ACCESS_KEY_ID=\(aq\(aq + export AWS_SECRET_ACCESS_KEY=\(aq\(aq + export AWS_SESSION_TOKEN=\(aq\(aq +.EE +.PP Syntax for setting environment variables in other shells will be different. Consult the documentation for your platform for more information. -.sp +.PP You can verify that these environment variables have been set with the following command: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -env | grep AWS -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + env | grep AWS +.EE +.PP Once set, the following example connects to a MongoDB Atlas cluster using these environment variables: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \(aqmongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.SS Execute JavaScript Against the \fI\%mongo\fP Shell -.sp -To execute a JavaScript file without evaluating the \fB~/.mongorc.js\fP +.PP +.EX + mongo \(aqmongodb+srv://cluster0.example.com/testdb?authSource=$external&authMechanism=MONGODB\-AWS\(aq +.EE +.SS EXECUTE JAVASCRIPT AGAINST THE MONGO SHELL +.PP +To execute a JavaScript file without evaluating the ~/.mongorc.js file before starting a shell session, use the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-shell \-\-norc alternate\-environment.js -.ft P -.fi -.UNINDENT -.UNINDENT -.sp +.PP +.EX + mongo \-\-shell \-\-norc alternate\-environment.js +.EE +.PP To execute a JavaScript file with authentication, with password prompted rather than provided on the command\-line, use the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo script\-file.js \-u \-p -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -\fBisInteractive()\fP -.UNINDENT -.UNINDENT -.SS Use \fI\%\-\-eval\fP to Execute JavaScript Code -.sp -You may use the \fI\%\-\-eval\fP option to execute +.PP +.EX + mongo script\-file.js \-u \-p +.EE +.PP +\fBisInteractive()\f1\f1 +.SS USE --EVAL TO EXECUTE JAVASCRIPT CODE +.PP +You may use the \fB\-\-eval\f1\f1 option to execute JavaScript directly from the command line. -.sp +.PP For example, the following operation evaluates a JavaScript string which queries a collection and prints the results as JSON. -.sp -On Linux and macOS, you will need to use single quotes (e.g. \fB\(aq\fP) +.PP +On Linux and macOS, you will need to use single quotes (e.g. \fB\(aq\f1) to enclose the JavaScript, using the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-eval \(aqdb.collection.find().forEach(printjson)\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -On Windows, you will need to use double quotes (e.g. \fB"\fP) +.PP +.EX + mongo \-\-eval \(aqdb.collection.find().forEach(printjson)\(aq +.EE +.PP +On Windows, you will need to use double quotes (e.g. \fB"\f1) to enclose the JavaScript, using the following form: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongo \-\-eval "db.collection.find().forEach(printjson)" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 +.PP +.EX + mongo \-\-eval "db.collection.find().forEach(printjson)" +.EE +.RS .IP \(bu 2 -/reference/mongo\-shell +\fBmongo\f1 Shell Quick Reference\f1 .IP \(bu 2 -/reference/method +\fBmongosh\f1 Methods\f1 .IP \(bu 2 -/mongo +\fBLegacy mongo\f1 Shell\f1 .IP \(bu 2 -\fBisInteractive()\fP -.UNINDENT -.UNINDENT -.UNINDENT -.SH AUTHOR -MongoDB Documentation Project -.SH COPYRIGHT -2008-2020 -.\" Generated by docutils manpage writer. -. +\fBisInteractive()\f1\f1 +.RE diff --git a/debian/mongod.1 b/debian/mongod.1 index a49aeefc92a..e848aaed888 100644 --- a/debian/mongod.1 +++ b/debian/mongod.1 @@ -1,2248 +1,1979 @@ -.\" Man page generated from reStructuredText. -. -.TH "MONGOD" "1" "Jun 23, 2020" "4.4" "mongodb-manual" -.SH NAME -mongod \- MongoDB Server -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SS On this page -.INDENT 0.0 -.IP \(bu 2 -\fI\%Synopsis\fP -.IP \(bu 2 -\fI\%Options\fP -.INDENT 2.0 -.IP \(bu 2 -\fI\%Core Options\fP -.IP \(bu 2 -\fI\%Free Monitoring\fP -.IP \(bu 2 -\fI\%LDAP Authentication or Authorization Options\fP -.IP \(bu 2 -\fI\%Storage Options\fP -.IP \(bu 2 -\fI\%WiredTiger Options\fP -.IP \(bu 2 -\fI\%Replication Options\fP -.IP \(bu 2 -\fI\%Sharded Cluster Options\fP -.IP \(bu 2 -\fI\%TLS Options\fP -.IP \(bu 2 -\fI\%SSL Options (Deprecated)\fP -.IP \(bu 2 -\fI\%Profiler Options\fP -.IP \(bu 2 -\fI\%Audit Options\fP -.IP \(bu 2 -\fI\%SNMP Options\fP -.IP \(bu 2 -\fI\%inMemory Options\fP -.IP \(bu 2 -\fI\%Encryption Key Management Options\fP -.UNINDENT -.UNINDENT +.TH mongod 1 +.SH MONGOD .SH SYNOPSIS -.sp -\fI\%mongod\fP is the primary daemon process for the MongoDB +\fBmongod\f1\f1 is the primary daemon process for the MongoDB system. It handles data requests, manages data access, and performs background management operations. -.sp +.PP This document provides a complete overview of all command line options -for \fI\%mongod\fP\&. These command line options are primarily useful -for testing: In common operation, use the configuration file -options to control the behavior of +for \fBmongod\f1\f1\&. These command line options are primarily useful +for testing: In common operation, use the \fBconfiguration file +options\f1 to control the behavior of your database. -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -conf\-file\-command\-line\-mapping -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 +.PP +\fBConfiguration File Settings and Command\-Line Options Mapping\f1 +.PP Starting in version 4.0, MongoDB disables support for TLS 1.0 encryption on systems where TLS 1.1+ is available. For -more details, see 4.0\-disable\-tls\&. -.UNINDENT -.UNINDENT +more details, see \fBDisable TLS 1.0\f1\&. .SH OPTIONS -.INDENT 0.0 -.INDENT 3.5 -.IP "Starting in version 4.2" -.INDENT 0.0 +.RS .IP \(bu 2 -MongoDB deprecates the SSL options and insteads adds new +MongoDB removes the \fB\-\-serviceExecutor\f1 command\-line option and the +corresponding \fBnet.serviceExecutor\f1 configuration option. +.RE +.RS +.IP \(bu 2 +MongoDB removes the \fB\-\-noIndexBuildRetry\f1 command\-line option +and the corresponding \fBstorage.indexBuildRetry\f1 option. +.RE +.RS +.IP \(bu 2 +MongoDB deprecates the SSL options and instead adds new corresponding TLS options. .IP \(bu 2 MongoDB adds -\fI\%\-\-tlsClusterCAFile\fP/\fBnet.tls.clusterCAFile\fP\&. (Also availalbe +\fB\-\-tlsClusterCAFile\f1\f1/\fBnet.tls.clusterCAFile\f1\f1\&. (Also available in 3.4.18+, 3.6.9+, 4.0.3+) -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.IP "Starting in version 4.4" -.INDENT 0.0 -.IP \(bu 2 -MongoDB removes the \fB\-\-noIndexBuildRetry\fP command\-line option -and the corresponding \fBstorage.indexBuildRetry\fP option. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Core Options -.INDENT 0.0 -.TP -.B \-\-help, \-h -Returns information on the options and use of \fBmongod\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-version -Returns the \fBmongod\fP release number. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-config , \-f +.RE +.SS CORE OPTIONS +.PP +\fBmongod \-\-help\f1, \fBmongod \-h\f1 +.RS +.PP +Returns information on the options and use of \fBmongod\f1\f1\&. +.RE +.PP +\fBmongod \-\-version\f1 +.RS +.PP +Returns the \fBmongod\f1\f1 release number. +.RE +.PP +\fBmongod \-\-config\f1, \fBmongod \-f\f1 +.RS +.PP Specifies a configuration file for runtime configuration options. The configuration file is the preferred method for runtime configuration of -\fBmongod\fP\&. The options are equivalent to the command\-line -configuration options. See /reference/configuration\-options for +\fBmongod\f1\f1\&. The options are equivalent to the command\-line +configuration options. See \fBConfiguration File Options\f1 for more information. -.sp -Ensure the configuration file uses ASCII encoding. The \fBmongod\fP +.PP +Ensure the configuration file uses ASCII encoding. The \fBmongod\f1\f1 instance does not support configuration files with non\-ASCII encoding, including UTF\-8. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-configExpand -\fIDefault\fP: none -.sp -New in version 4.2. - -.sp -Enables using Expansion Directives +.RE +.PP +\fBmongod \-\-configExpand\f1 +.RS +.PP +\fIDefault\f1: none +.PP +Enables using \fBExpansion Directives\f1 in configuration files. Expansion directives allow you to set externally sourced values for configuration file options. -.sp -\fI\%\-\-configExpand\fP supports the following expansion directives: -.TS -center; -|l|l|. -_ -T{ -Value -T} T{ -Description -T} -_ -T{ -\fBnone\fP -T} T{ -Default. \fBmongod\fP does not expand expansion directives. -\fBmongod\fP fails to start if any configuration file settings -use expansion directives. -T} -_ -T{ -\fBrest\fP -T} T{ -\fBmongod\fP expands \fB__rest\fP expansion directives when -parsing the configuration file. -T} -_ -T{ -\fBexec\fP -T} T{ -\fBmongod\fP expands \fB__exec\fP expansion directives when -parsing the configuration file. -T} -_ -.TE -.sp -You can specify multiple expansion directives as a comma\-separated -list, e.g. \fBrest, exec\fP\&. If the configuration file contains -expansion directives not specified to \fI\%\-\-configExpand\fP, the \fBmongod\fP -returns an error and terminates. -.sp -See externally\-sourced\-values for configuration files -for more information on expansion directives. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-verbose, \-v -Increases the amount of internal reporting returned on standard output -or in log files. Increase the verbosity with the \fB\-v\fP form by -including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in version 4.2, MongoDB includes the Debug verbosity level -(1\-5) in the log messages\&. For example, -if the verbosity level is 2, MongoDB logs \fBD2\fP\&. In previous -versions, MongoDB log messages only specified \fBD\fP for Debug level. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-quiet -Runs \fBmongod\fP in a quiet mode that attempts to limit the amount -of output. -.sp -This option suppresses: -.INDENT 7.0 +.PP +\fB\-\-configExpand\f1\f1 supports the following expansion directives: +.RS .IP \(bu 2 -output from database commands +.RS +.IP \(bu 4 +Value +.IP \(bu 4 +Description +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBnone\f1 +.IP \(bu 4 +Default. \fBmongod\f1\f1 does not expand expansion directives. +\fBmongod\f1\f1 fails to start if any configuration file settings +use expansion directives. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBrest\f1 +.IP \(bu 4 +\fBmongod\f1\f1 expands \fB__rest\f1 expansion directives when +parsing the configuration file. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBexec\f1 +.IP \(bu 4 +\fBmongod\f1\f1 expands \fB__exec\f1 expansion directives when +parsing the configuration file. +.RE +.RE +.PP +You can specify multiple expansion directives as a comma\-separated +list, e.g. \fBrest, exec\f1\&. If the configuration file contains +expansion directives not specified to \fB\-\-configExpand\f1\f1, the \fBmongod\f1\f1 +returns an error and terminates. +.PP +See \fBExternally Sourced Configuration File Values\f1 for configuration files +for more information on expansion directives. +.RE +.PP +\fBmongod \-\-verbose\f1, \fBmongod \-v\f1 +.RS +.PP +Increases the amount of internal reporting returned on standard output +or in log files. Increase the verbosity with the \fB\-v\f1 form by +including the option multiple times, (e.g. \fB\-vvvvv\f1\&.) +.PP +Starting in version 4.2, MongoDB includes the Debug verbosity level +(1\-5) in the \fBlog messages\f1\&. For example, +if the verbosity level is 2, MongoDB logs \fBD2\f1\&. In previous +versions, MongoDB log messages only specified \fBD\f1 for Debug level. +.RE +.PP +\fBmongod \-\-quiet\f1 +.RS +.PP +Runs \fBmongod\f1\f1 in a quiet mode that attempts to limit the amount +of output. +.PP +This option suppresses: +.RS +.IP \(bu 2 +output from \fBdatabase commands\f1 .IP \(bu 2 replication activity .IP \(bu 2 connection accepted events .IP \(bu 2 connection closed events -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-port -\fIDefault\fP: -.INDENT 7.0 +.RE +.RE +.PP +\fBmongod \-\-port\f1 +.RS +.PP +\fIDefault\f1: +.RS .IP \(bu 2 -27017 if \fI\%mongod\fP is not a shard member or a config server member +27017 if \fBmongod\f1\f1 is not a shard member or a config server member .IP \(bu 2 -27018 if \fI\%mongod\fP is a \fI\%shard member\fP +27018 if \fBmongod\f1\f1 is a \fBshard member\f1\f1 .IP \(bu 2 -27019 if \fI\%mongod\fP is a \fI\%config server member\fP -.UNINDENT -.sp +27019 if \fBmongod\f1\f1 is a \fBconfig server member\f1\f1 +.RE +.PP The TCP port on which the MongoDB instance listens for client connections. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-bind_ip -\fIDefault\fP: localhost -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 3.6, \fBmongod\fP bind to localhost -by default. See 3.6\-bind\-to\-localhost\&. -.UNINDENT -.UNINDENT -.sp +.RE +.PP +\fBmongod \-\-bind_ip\f1 +.RS +.PP +\fIDefault\f1: localhost +.PP +Starting in MongoDB 3.6, \fBmongod\f1\f1 bind to localhost +by default. See \fBDefault Bind to Localhost\f1\&. +.PP The hostnames and/or IP addresses and/or full Unix domain socket -paths on which \fBmongod\fP should listen for client connections. You -may attach \fBmongod\fP to any interface. To bind to multiple +paths on which \fBmongod\f1\f1 should listen for client connections. You +may attach \fBmongod\f1\f1 to any interface. To bind to multiple addresses, enter a list of comma\-separated values. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost,/tmp/mongod.sock\fP -.UNINDENT -.UNINDENT -.sp +.PP You can specify both IPv4 and IPv6 addresses, or hostnames that resolve to an IPv4 or IPv6 address. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost, 2001:0DB8:e132:ba26:0d5c:2774:e7f9:d513\fP -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -If specifying an IPv6 address \fIor\fP a hostname that resolves to an -IPv6 address to \fI\%\-\-bind_ip\fP, you must start \fBmongod\fP with -\fI\%\-\-ipv6\fP to enable IPv6 support. Specifying an IPv6 address -to \fI\%\-\-bind_ip\fP does not enable IPv6 support. -.UNINDENT -.UNINDENT -.sp +.PP +If specifying an IPv6 address \fIor\f1 a hostname that resolves to an +IPv6 address to \fB\-\-bind_ip\f1\f1, you must start \fBmongod\f1\f1 with +\fB\-\-ipv6\f1\f1 to enable IPv6 support. Specifying an IPv6 address +to \fB\-\-bind_ip\f1\f1 does not enable IPv6 support. +.PP If specifying a -\fI\%link\-local IPv6 address\fP -(\fBfe80::/10\fP), you must append the -\fI\%zone index\fP -to that address (i.e. \fBfe80::
%\fP). -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp -\fBlocalhost,fe80::a00:27ff:fee0:1fcf%enp0s3\fP -.UNINDENT -.UNINDENT -.INDENT 7.0 -.INDENT 3.5 -.SS Tip -.sp +link\-local IPv6 address (https://en.wikipedia.org/wiki/Link\-local_address#IPv6) +(\fBfe80::/10\f1), you must append the +zone index (https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses_(with_zone_index)) +to that address (i.e. \fBfe80::
%\f1). +.PP When possible, use a logical DNS hostname instead of an ip address, particularly when configuring replica set members or sharded cluster members. The use of logical DNS hostnames avoids configuration changes due to ip address changes. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP 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 -/administration/security\-checklist\&. At minimum, consider -enabling authentication and -hardening network infrastructure\&. -.UNINDENT -.UNINDENT -.sp +\fBSecurity Checklist\f1\&. At minimum, consider +\fBenabling authentication\f1 and +\fBhardening network infrastructure\f1\&. +.PP For more information about IP Binding, refer to the -/core/security\-mongodb\-configuration documentation. -.sp -To bind to all IPv4 addresses, enter \fB0.0.0.0\fP\&. -.sp -To bind to all IPv4 and IPv6 addresses, enter \fB::,0.0.0.0\fP or -starting in MongoDB 4.2, an asterisk \fB"*"\fP (enclose the asterisk in +\fBIP Binding\f1 documentation. +.PP +To bind to all IPv4 addresses, enter \fB0.0.0.0\f1\&. +.PP +To bind to all IPv4 and IPv6 addresses, enter \fB::,0.0.0.0\f1 or +starting in MongoDB 4.2, an asterisk \fB"*"\f1 (enclose the asterisk in quotes to avoid filename pattern expansion). Alternatively, use the -\fBnet.bindIpAll\fP setting. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 +\fBnet.bindIpAll\f1\f1 setting. +.RS .IP \(bu 2 -\fB\-\-bind_ip\fP and \fB\-\-bind_ip_all\fP are mutually exclusive. -Specifying both options causes \fBmongod\fP to throw an error and +\fB\-\-bind_ip\f1 and \fB\-\-bind_ip_all\f1 are mutually exclusive. +Specifying both options causes \fBmongod\f1\f1 to throw an error and terminate. .IP \(bu 2 -The command\-line option \fB\-\-bind\fP overrides the configuration -file setting \fBnet.bindIp\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-bind_ip_all -New in version 3.6. - -.sp -If specified, the \fBmongod\fP instance binds to all IPv4 -addresses (i.e. \fB0.0.0.0\fP). If \fBmongod\fP starts with -\fI\%\-\-ipv6\fP, \fI\%\-\-bind_ip_all\fP also binds to all IPv6 addresses -(i.e. \fB::\fP). -.sp -\fBmongod\fP only supports IPv6 if started with \fI\%\-\-ipv6\fP\&. Specifying -\fI\%\-\-bind_ip_all\fP alone does not enable IPv6 support. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +The command\-line option \fB\-\-bind\f1 overrides the configuration +file setting \fBnet.bindIp\f1\f1\&. +.RE +.RE +.PP +\fBmongod \-\-bind_ip_all\f1 +.RS +.PP +If specified, the \fBmongod\f1\f1 instance binds to all IPv4 +addresses (i.e. \fB0.0.0.0\f1). If \fBmongod\f1\f1 starts with +\fB\-\-ipv6\f1\f1, \fB\-\-bind_ip_all\f1\f1 also binds to all IPv6 addresses +(i.e. \fB::\f1). +.PP +\fBmongod\f1\f1 only supports IPv6 if started with \fB\-\-ipv6\f1\f1\&. Specifying +\fB\-\-bind_ip_all\f1\f1 alone does not enable IPv6 support. +.PP 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 -/administration/security\-checklist\&. At minimum, consider -enabling authentication and -hardening network infrastructure\&. -.UNINDENT -.UNINDENT -.sp +\fBSecurity Checklist\f1\&. At minimum, consider +\fBenabling authentication\f1 and +\fBhardening network infrastructure\f1\&. +.PP For more information about IP Binding, refer to the -/core/security\-mongodb\-configuration documentation. -.sp -Alternatively, you can set the \fB\-\-bind_ip\fP option to \fB::,0.0.0.0\fP -or, starting in MongoDB 4.2, to an asterisk \fB"*"\fP (enclose the +\fBIP Binding\f1 documentation. +.PP +Alternatively, you can set the \fB\-\-bind_ip\f1 option to \fB::,0.0.0.0\f1 +or, starting in MongoDB 4.2, to an asterisk \fB"*"\f1 (enclose the asterisk in quotes to avoid filename pattern expansion). -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fB\-\-bind_ip\fP and \fB\-\-bind_ip_all\fP are mutually exclusive. That +.PP +\fB\-\-bind_ip\f1 and \fB\-\-bind_ip_all\f1 are mutually exclusive. That is, you can specify one or the other, but not both. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-clusterIpSourceAllowlist -New in version 3.6. - -.sp -A list of IP addresses/CIDR (\fI\%Classless Inter\-Domain Routing\fP) ranges against which the -\fI\%mongod\fP validates authentication requests from other members of -the replica set and, if part of a sharded cluster, the \fBmongos\fP -instances. The \fI\%mongod\fP verifies that the originating IP is +.RE +.PP +\fBmongod \-\-clusterIpSourceAllowlist\f1 +.RS +.PP +A list of IP addresses/CIDR (Classless Inter\-Domain Routing (https://tools.ietf.org/html/rfc4632)) ranges against which the +\fBmongod\f1\f1 validates authentication requests from other members of +the replica set and, if part of a sharded cluster, the \fBmongos\f1\f1 +instances. The \fBmongod\f1\f1 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 the -\fI\%mongod\fP or \fBmongos\fP\&. -.sp -\fI\%\-\-clusterIpSourceAllowlist\fP has no effect on a \fI\%mongod\fP started without -authentication\&. -.sp -\fI\%\-\-clusterIpSourceAllowlist\fP accepts multiple comma\-separated IPv4/6 addresses or Classless -Inter\-Domain Routing (\fI\%CIDR\fP) ranges: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongod \-\-clusterIpSourceAllowlist 192.0.2.0/24,127.0.0.1,::1 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -Ensure \fI\%\-\-clusterIpSourceAllowlist\fP includes the IP address \fIor\fP CIDR ranges that include the -IP address of each replica set member or \fBmongos\fP in the +\fBmongod\f1\f1 or \fBmongos\f1\f1\&. +.PP +\fB\-\-clusterIpSourceAllowlist\f1\f1 has no effect on a \fBmongod\f1\f1 started without +\fBauthentication\f1\&. +.PP +\fB\-\-clusterIpSourceAllowlist\f1\f1 accepts multiple comma\-separated IPv4/6 addresses or Classless +Inter\-Domain Routing (CIDR (https://tools.ietf.org/html/rfc4632)) ranges: +.PP +.EX + mongod \-\-clusterIpSourceAllowlist 192.0.2.0/24,127.0.0.1,::1 +.EE +.PP +Ensure \fB\-\-clusterIpSourceAllowlist\f1\f1 includes the IP address \fIor\f1 CIDR ranges that include the +IP address of each replica set member or \fBmongos\f1\f1 in the deployment to ensure healthy communication between cluster components. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ipv6 -Enables IPv6 support. \fBmongod\fP disables IPv6 support by default. -.sp -Setting \fI\%\-\-ipv6\fP does \fInot\fP direct the \fBmongod\fP to listen on any -local IPv6 addresses or interfaces. To configure the \fBmongod\fP to +.RE +.PP +\fBmongod \-\-clusterIpSourceWhitelist\f1 +.RS +.PP +\fIDeprecated in version 5.0:\f1 +Use \fB\-\-clusterIpSourceAllowlist\f1\f1 instead. +.PP +A list of IP addresses/CIDR (Classless Inter\-Domain Routing (https://tools.ietf.org/html/rfc4632)) ranges against which the +\fBmongod\f1\f1 validates authentication requests from other members of +the replica set and, if part of a sharded cluster, the \fBmongos\f1\f1 +instances. The \fBmongod\f1\f1 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 the +\fBmongod\f1\f1 or \fBmongos\f1\f1\&. +.PP +\fB\-\-clusterIpSourceWhitelist\f1\f1 has no effect on a \fBmongod\f1\f1 started without +\fBauthentication\f1\&. +.PP +\fB\-\-clusterIpSourceWhitelist\f1\f1 accepts multiple comma\-separated IPv4/6 addresses or Classless +Inter\-Domain Routing (CIDR (https://tools.ietf.org/html/rfc4632)) ranges: +.PP +.EX + mongod \-\-clusterIpSourceWhitelist 192.0.2.0/24,127.0.0.1,::1 +.EE +.PP +Ensure \fB\-\-clusterIpSourceWhitelist\f1\f1 includes the IP address \fIor\f1 CIDR ranges that include the +IP address of each replica set member or \fBmongos\f1\f1 in the +deployment to ensure healthy communication between cluster components. +.RE +.PP +\fBmongod \-\-ipv6\f1 +.RS +.PP +Enables IPv6 support. \fBmongod\f1\f1 disables IPv6 support by default. +.PP +Setting \fB\-\-ipv6\f1\f1 does \fInot\f1 direct the \fBmongod\f1\f1 to listen on any +local IPv6 addresses or interfaces. To configure the \fBmongod\f1\f1 to listen on an IPv6 interface, you must either: -.INDENT 7.0 +.RS .IP \(bu 2 -Configure \fI\%\-\-bind_ip\fP with one or more IPv6 addresses or -hostnames that resolve to IPv6 addresses, \fBor\fP +Configure \fB\-\-bind_ip\f1\f1 with one or more IPv6 addresses or +hostnames that resolve to IPv6 addresses, \fBor\f1 .IP \(bu 2 -Set \fI\%\-\-bind_ip_all\fP to \fBtrue\fP\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-listenBacklog -\fIDefault\fP: Target system \fBSOMAXCONN\fP constant -.sp -New in version 3.6. - -.sp +Set \fB\-\-bind_ip_all\f1\f1 to \fBtrue\f1\&. +.RE +.RE +.PP +\fBmongod \-\-listenBacklog\f1 +.RS +.PP +\fIDefault\f1: Target system \fBSOMAXCONN\f1 constant +.PP The maximum number of connections that can exist in the listen queue. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP Consult your local system\(aqs documentation to understand the limitations and configuration requirements before using this parameter. -.UNINDENT -.UNINDENT -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP To prevent undefined behavior, specify a value for this -parameter between \fB1\fP and the local system \fBSOMAXCONN\fP +parameter between \fB1\f1 and the local system \fBSOMAXCONN\f1 constant. -.UNINDENT -.UNINDENT -.sp -The default value for the \fBlistenBacklog\fP parameter is set at -compile time to the target system \fBSOMAXCONN\fP constant. -\fBSOMAXCONN\fP is the maximum valid value that is documented for -the \fIbacklog\fP parameter to the \fIlisten\fP system call. -.sp -Some systems may interpret \fBSOMAXCONN\fP symbolically, and others -numerically. The actual \fIlisten backlog\fP applied in practice may -differ from any numeric interpretation of the \fBSOMAXCONN\fP constant -or argument to \fB\-\-listenBacklog\fP, and may also be constrained by -system settings like \fBnet.core.somaxconn\fP on Linux. -.sp -Passing a value for the \fBlistenBacklog\fP parameter that exceeds the -\fBSOMAXCONN\fP constant for the local system is, by the letter of the +.PP +The default value for the \fBlistenBacklog\f1 parameter is set at +compile time to the target system \fBSOMAXCONN\f1 constant. +\fBSOMAXCONN\f1 is the maximum valid value that is documented for +the \fIbacklog\f1 parameter to the \fIlisten\f1 system call. +.PP +Some systems may interpret \fBSOMAXCONN\f1 symbolically, and others +numerically. The actual \fIlisten backlog\f1 applied in practice may +differ from any numeric interpretation of the \fBSOMAXCONN\f1 constant +or argument to \fB\-\-listenBacklog\f1, and may also be constrained by +system settings like \fBnet.core.somaxconn\f1 on Linux. +.PP +Passing a value for the \fBlistenBacklog\f1 parameter that exceeds the +\fBSOMAXCONN\f1 constant for the local system is, by the letter of the standards, undefined behavior. Higher values may be silently integer truncated, may be ignored, may cause unexpected resource consumption, or have other adverse consequences. -.sp +.PP On systems with workloads that exhibit connection spikes, for which it is empirically known that the local system can honor higher -values for the \fIbacklog\fP parameter than the \fBSOMAXCONN\fP constant, -setting the \fBlistenBacklog\fP parameter to a higher value may reduce +values for the \fIbacklog\f1 parameter than the \fBSOMAXCONN\f1 constant, +setting the \fBlistenBacklog\f1 parameter to a higher value may reduce operation latency as observed by the client by reducing the number of connections which are forced into a backoff state. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-maxConns -The maximum number of simultaneous connections that \fBmongod\fP will +.RE +.PP +\fBmongod \-\-maxConns\f1 +.RS +.PP +The maximum number of simultaneous connections that \fBmongod\f1\f1 will accept. This setting has no effect if it is higher than your operating system\(aqs configured maximum connection tracking threshold. -.sp +.PP Do not assign too low of a value to this option, or you will encounter errors during normal application operation. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logpath +.RE +.PP +\fBmongod \-\-logpath\f1 +.RS +.PP Sends all diagnostic logging information to a log file instead of to -standard output or to the host\(aqs syslog system. MongoDB creates +standard output or to the host\(aqs \fBsyslog\f1 system. MongoDB creates the log file at the path you specify. -.sp +.PP By default, MongoDB will move any existing log file rather than overwrite -it. To instead append to the log file, set the \fI\%\-\-logappend\fP option. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syslog -Sends all logging output to the host\(aqs syslog system rather -than to standard output or to a log file (\fI\%\-\-logpath\fP). -.sp -The \fI\%\-\-syslog\fP option is not supported on Windows. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fBsyslog\fP daemon generates timestamps when it logs a message, not +it. To instead append to the log file, set the \fB\-\-logappend\f1\f1 option. +.RE +.PP +\fBmongod \-\-syslog\f1 +.RS +.PP +Sends all logging output to the host\(aqs \fBsyslog\f1 system rather +than to standard output or to a log file (\fB\-\-logpath\f1\f1). +.PP +The \fB\-\-syslog\f1\f1 option is not supported on Windows. +.PP +The \fBsyslog\f1 daemon generates timestamps when it logs a message, not when MongoDB issues the message. This can lead to misleading timestamps for log entries, especially when the system is under heavy load. We -recommend using the \fI\%\-\-logpath\fP option for production systems to +recommend using the \fB\-\-logpath\f1\f1 option for production systems to ensure accurate timestamps. -.UNINDENT -.UNINDENT -.sp -Starting in version 4.2, MongoDB includes the component in its log messages to \fBsyslog\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -\&... ACCESS [repl writer worker 5] Unsupported modification to roles collection ... -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syslogFacility -\fIDefault\fP: user -.sp +.PP +Starting in version 4.2, MongoDB includes the \fBcomponent\f1 in its log messages to \fBsyslog\f1\&. +.PP +.EX + ... ACCESS [repl writer worker 5] Unsupported modification to roles collection ... +.EE +.RE +.PP +\fBmongod \-\-syslogFacility\f1 +.RS +.PP +\fIDefault\f1: user +.PP Specifies the facility level used when logging messages to syslog. The value you specify must be supported by your operating system\(aqs implementation of syslog. To use this option, you -must enable the \fI\%\-\-syslog\fP option. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logappend -Appends new entries to the end of the existing log file when the \fBmongod\fP -instance restarts. Without this option, \fI\%mongod\fP will back up the +must enable the \fB\-\-syslog\f1\f1 option. +.RE +.PP +\fBmongod \-\-logappend\f1 +.RS +.PP +Appends new entries to the end of the existing log file when the \fBmongod\f1\f1 +instance restarts. Without this option, \fBmongod\f1\f1 will back up the existing log and create a new file. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-logRotate -\fIDefault\fP: rename -.sp -Determines the behavior for the \fBlogRotate\fP command. -Specify either \fBrename\fP or \fBreopen\fP: -.INDENT 7.0 +.RE +.PP +\fBmongod \-\-logRotate\f1 +.RS +.PP +\fIDefault\f1: rename +.PP +Determines the behavior for the \fBlogRotate\f1\f1 command when +rotating the server log and/or the audit log. Specify either +\fBrename\f1 or \fBreopen\f1: +.RS .IP \(bu 2 -\fBrename\fP renames the log file. +\fBrename\f1 renames the log file. .IP \(bu 2 -\fBreopen\fP closes and reopens the log file following the typical -Linux/Unix log rotate behavior. Use \fBreopen\fP when using the +\fBreopen\f1 closes and reopens the log file following the typical +Linux/Unix log rotate behavior. Use \fBreopen\f1 when using the Linux/Unix logrotate utility to avoid log loss. -.sp -If you specify \fBreopen\fP, you must also use \fI\%\-\-logappend\fP\&. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-timeStampFormat -\fIDefault\fP: iso8601\-local -.sp +.IP +If you specify \fBreopen\f1, you must also use \fB\-\-logappend\f1\f1\&. +.RE +.RE +.PP +\fBmongod \-\-timeStampFormat\f1 +.RS +.PP +\fIDefault\f1: iso8601\-local +.PP The time format for timestamps in log messages. Specify one of the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBiso8601\-utc\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBiso8601\-utc\f1 +.IP \(bu 4 Displays timestamps in Coordinated Universal Time (UTC) in the ISO\-8601 format. For example, for New York at the start of the -Epoch: \fB1970\-01\-01T00:00:00.000Z\fP -T} -_ -T{ -\fBiso8601\-local\fP -T} T{ +Epoch: \fB1970\-01\-01T00:00:00.000Z\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBiso8601\-local\f1 +.IP \(bu 4 Displays timestamps in local time in the ISO\-8601 format. For example, for New York at the start of the Epoch: -\fB1969\-12\-31T19:00:00.000\-05:00\fP -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 4.4, \fI\%\-\-timeStampFormat\fP no longer supports \fBctime\fP\&. -An example of \fBctime\fP formatted date is: \fBWed Dec 31 -18:17:54.811\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-traceExceptions +\fB1969\-12\-31T19:00:00.000\-05:00\f1 +.RE +.RE +.PP +Starting in MongoDB 4.4, \fB\-\-timeStampFormat\f1\f1 no longer supports \fBctime\f1\&. +An example of \fBctime\f1 formatted date is: \fBWed Dec 31 +18:17:54.811\f1\&. +.RE +.PP +\fBmongod \-\-traceExceptions\f1 +.RS +.PP For internal diagnostic use only. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-pidfilepath -Specifies a file location to store the process ID (PID) of the \fBmongod\fP -process. The user running the \fBmongod\fP or \fBmongos\fP -process must be able to write to this path. If the \fI\%\-\-pidfilepath\fP option is not +.RE +.PP +\fBmongod \-\-pidfilepath\f1 +.RS +.PP +Specifies a file location to store the process ID (PID) of the \fBmongod\f1\f1 +process. The user running the \fBmongod\f1 or \fBmongos\f1 +process must be able to write to this path. If the \fB\-\-pidfilepath\f1\f1 option is not specified, the process does not create a PID file. This option is generally -only useful in combination with the \fI\%\-\-fork\fP option. -.INDENT 7.0 -.INDENT 3.5 -.IP "Linux" -.sp +only useful in combination with the \fB\-\-fork\f1\f1 option. +.PP On Linux, PID file management is generally the responsibility of -your distro\(aqs init system: usually a service file in the \fB/etc/init.d\fP -directory, or a systemd unit file registered with \fBsystemctl\fP\&. Only -use the \fI\%\-\-pidfilepath\fP option if you are not using one of these init +your distro\(aqs init system: usually a service file in the \fB/etc/init.d\f1 +directory, or a systemd unit file registered with \fBsystemctl\f1\&. Only +use the \fB\-\-pidfilepath\f1\f1 option if you are not using one of these init systems. For more information, please see the respective -Installation Guide for your operating system. -.UNINDENT -.UNINDENT -.INDENT 7.0 -.INDENT 3.5 -.IP "macOS" -.sp -On macOS, PID file management is generally handled by \fBbrew\fP\&. Only use -the \fI\%\-\-pidfilepath\fP option if you are not using \fBbrew\fP on your macOS system. +\fBInstallation Guide\f1 for your operating system. +.PP +On macOS, PID file management is generally handled by \fBbrew\f1\&. Only use +the \fB\-\-pidfilepath\f1\f1 option if you are not using \fBbrew\f1 on your macOS system. For more information, please see the respective -Installation Guide for your operating system. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyFile +\fBInstallation Guide\f1 for your operating system. +.RE +.PP +\fBmongod \-\-keyFile\f1 +.RS +.PP Specifies 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\&. \fI\%\-\-keyFile\fP implies -\fI\%\-\-auth\fP\&. See inter\-process\-auth for more +\fBsharded cluster\f1 or \fBreplica set\f1\&. \fB\-\-keyFile\f1\f1 implies +\fB\-\-auth\f1\f1\&. See \fBInternal/Membership Authentication\f1 for more information. -.sp -Starting in MongoDB 4.2, keyfiles for internal membership -authentication use YAML format to allow for +.PP +Starting in MongoDB 4.2, \fBkeyfiles for internal membership +authentication\f1 use YAML format to allow for multiple keys in a keyfile. The YAML format accepts content of: -.INDENT 7.0 +.RS .IP \(bu 2 a single key string (same as in earlier versions), .IP \(bu 2 multiple key strings (each string must be enclosed in quotes), or .IP \(bu 2 sequence of key strings. -.UNINDENT -.sp +.RE +.PP The YAML format is compatible with the existing single\-key keyfiles that use the text file format. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-setParameter +.RE +.PP +\fBmongod \-\-setParameter\f1 +.RS +.PP Specifies one of the MongoDB parameters described in -/reference/parameters\&. You can specify multiple \fBsetParameter\fP +\fBMongoDB Server Parameters\f1\&. You can specify multiple \fBsetParameter\f1 fields. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-nounixsocket -Disables listening on the UNIX domain socket. \fI\%\-\-nounixsocket\fP applies only +.RE +.PP +\fBmongod \-\-nounixsocket\f1 +.RS +.PP +Disables listening on the UNIX domain socket. \fB\-\-nounixsocket\f1\f1 applies only to Unix\-based systems. -.sp -The \fBmongod\fP process +.PP +The \fBmongod\f1\f1 process always listens on the UNIX socket unless one of the following is true: -.INDENT 7.0 +.RS .IP \(bu 2 -\fI\%\-\-nounixsocket\fP is set +\fB\-\-nounixsocket\f1\f1 is set .IP \(bu 2 -\fBnet.bindIp\fP is not set +\fBnet.bindIp\f1\f1 is not set .IP \(bu 2 -\fBnet.bindIp\fP does not specify \fBlocalhost\fP or its associated IP address -.UNINDENT -.sp -\fBmongod\fP installed from official \&.deb and \&.rpm packages -have the \fBbind_ip\fP configuration set to \fB127.0.0.1\fP by +\fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address +.RE +.PP +\fBmongod\f1\f1 installed from official \fB\&.deb\f1 and \fB\&.rpm\f1 packages +have the \fBbind_ip\f1 configuration set to \fB127.0.0.1\f1 by default. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-unixSocketPrefix -\fIDefault\fP: /tmp -.sp -The path for the UNIX socket. \fI\%\-\-unixSocketPrefix\fP applies only +.RE +.PP +\fBmongod \-\-unixSocketPrefix\f1 +.RS +.PP +\fIDefault\f1: /tmp +.PP +The path for the UNIX socket. \fB\-\-unixSocketPrefix\f1\f1 applies only to Unix\-based systems. -.sp +.PP If this option has no value, the -\fBmongod\fP process creates a socket with \fB/tmp\fP as a prefix. MongoDB +\fBmongod\f1\f1 process creates a socket with \fB/tmp\f1 as a prefix. MongoDB creates and listens on a UNIX socket unless one of the following is true: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBnet.unixDomainSocket.enabled\fP is \fBfalse\fP +\fBnet.unixDomainSocket.enabled\f1\f1 is \fBfalse\f1 .IP \(bu 2 -\fI\%\-\-nounixsocket\fP is set +\fB\-\-nounixsocket\f1\f1 is set .IP \(bu 2 -\fBnet.bindIp\fP is not set +\fBnet.bindIp\f1\f1 is not set .IP \(bu 2 -\fBnet.bindIp\fP does not specify \fBlocalhost\fP or its associated IP address -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-filePermissions -\fIDefault\fP: \fB0700\fP -.sp +\fBnet.bindIp\f1\f1 does not specify \fBlocalhost\f1 or its associated IP address +.RE +.RE +.PP +\fBmongod \-\-filePermissions\f1 +.RS +.PP +\fIDefault\f1: \fB0700\f1 +.PP Sets the permission for the UNIX domain socket file. -.sp -\fI\%\-\-filePermissions\fP applies only to Unix\-based systems. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fork -Enables a daemon mode that runs the \fBmongod\fP process in the -background. By default \fBmongod\fP does not run as a daemon: -typically you will run \fBmongod\fP as a daemon, either by using -\fI\%\-\-fork\fP or by using a controlling process that handles the -daemonization process (e.g. as with \fBupstart\fP and \fBsystemd\fP). -.sp -The \fI\%\-\-fork\fP option is not supported on Windows. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-auth +.PP +\fB\-\-filePermissions\f1\f1 applies only to Unix\-based systems. +.RE +.PP +\fBmongod \-\-fork\f1 +.RS +.PP +Enables a \fBdaemon\f1 mode that runs the \fBmongod\f1\f1 process in the +background. By default \fBmongod\f1\f1 does not run as a daemon: +typically you will run \fBmongod\f1\f1 as a daemon, either by using +\fB\-\-fork\f1\f1 or by using a controlling process that handles the +daemonization process (e.g. as with \fBupstart\f1 and \fBsystemd\f1). +.PP +Using the \fB\-\-fork\f1\f1 option requires that you configure log +output for the \fBmongod\f1\f1 with one of the following: +.RS +.IP \(bu 2 +\fB\-\-logpath\f1\f1 +.IP \(bu 2 +\fB\-\-syslog\f1\f1 +.RE +.PP +The \fB\-\-fork\f1\f1 option is not supported on Windows. +.RE +.PP +\fBmongod \-\-auth\f1 +.RS +.PP Enables authorization to control user\(aqs access to database resources and operations. When authorization is enabled, MongoDB requires all clients to authenticate themselves first in order to determine the access for the client. -.sp -Configure users via the mongo shell\&. If no users exist, the localhost interface +.PP +Configure users via the \fBmongo shell\f1\&. If no users exist, the localhost interface will continue to have access to the database until you create the first user. -.sp -See Security +.PP +See \fBSecurity\f1 for more information. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noauth +.RE +.PP +\fBmongod \-\-noauth\f1 +.RS +.PP Disables authentication. Currently the default. Exists for future compatibility and clarity. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-transitionToAuth -New in version 3.4: Allows the \fBmongod\fP to accept and create authenticated and -non\-authenticated connections to and from other \fI\%mongod\fP -and \fBmongos\fP instances in the deployment. Used for +.RE +.PP +\fBmongod \-\-transitionToAuth\f1 +.RS +.PP +Allows the \fBmongod\f1\f1 to accept and create authenticated and +non\-authenticated connections to and from other \fBmongod\f1\f1 +and \fBmongos\f1\f1 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 as -\fI\%\-\-keyFile\fP\&. - -.sp -For example, if using keyfiles for -internal authentication, the \fBmongod\fP creates -an authenticated connection with any \fI\%mongod\fP or \fBmongos\fP +from a no\-auth configuration to \fBinternal authentication\f1\&. Requires specifying a \fBinternal +authentication\f1 mechanism such as +\fB\-\-keyFile\f1\f1\&. +.PP +For example, if using \fBkeyfiles\f1 for +\fBinternal authentication\f1, the \fBmongod\f1\f1 creates +an authenticated connection with any \fBmongod\f1\f1 or \fBmongos\f1\f1 in the deployment using a matching keyfile. If the security mechanisms do -not match, the \fBmongod\fP utilizes a non\-authenticated connection instead. -.sp -A \fBmongod\fP running with \fI\%\-\-transitionToAuth\fP does not enforce user access -controls\&. Users may connect to your deployment without any +not match, the \fBmongod\f1\f1 utilizes a non\-authenticated connection instead. +.PP +A \fBmongod\f1\f1 running with \fB\-\-transitionToAuth\f1\f1 does not enforce \fBuser access +controls\f1\&. Users may connect to your deployment without any access control checks and perform read, write, and administrative operations. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -A \fBmongod\fP running with internal authentication and \fIwithout\fP \fI\%\-\-transitionToAuth\fP requires clients to connect -using user access controls\&. Update clients to -connect to the \fBmongod\fP using the appropriate user -prior to restarting \fBmongod\fP without \fI\%\-\-transitionToAuth\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-cpu -Forces the \fBmongod\fP process to report the percentage of CPU time in +.PP +A \fBmongod\f1\f1 running with \fBinternal authentication\f1 and \fIwithout\f1 \fB\-\-transitionToAuth\f1\f1 requires clients to connect +using \fBuser access controls\f1\&. Update clients to +connect to the \fBmongod\f1\f1 using the appropriate \fBuser\f1 +prior to restarting \fBmongod\f1\f1 without \fB\-\-transitionToAuth\f1\f1\&. +.RE +.PP +\fBmongod \-\-cpu\f1 +.RS +.PP +Forces the \fBmongod\f1\f1 process to report the percentage of CPU time in write lock, every four seconds. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sysinfo +.RE +.PP +\fBmongod \-\-sysinfo\f1 +.RS +.PP Returns diagnostic system information and then exits. The information provides the page size, the number of physical pages, and the number of available physical pages. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noscripting +.RE +.PP +\fBmongod \-\-noscripting\f1 +.RS +.PP Disables the scripting engine. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-notablescan -Forbids operations that require a collection scan. See \fBnotablescan\fP for additional information. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-shutdown -The \fI\%\-\-shutdown\fP option cleanly and safely terminates the \fBmongod\fP -process. When invoking \fBmongod\fP with this option you must set the -\fI\%\-\-dbpath\fP option either directly or by way of the -configuration file and the -\fI\%\-\-config\fP option. -.sp -The \fI\%\-\-shutdown\fP option is available only on Linux systems. -.sp -For additional ways to shut down, see also terminate\-mongod\-processes\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-redactClientLogData -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A \fBmongod\fP running with \fI\%\-\-redactClientLogData\fP redacts any message accompanying a given -log event before logging. This prevents the \fBmongod\fP from writing +.RE +.PP +\fBmongod \-\-notablescan\f1 +.RS +.PP +Forbids operations that require a collection scan. See \fBnotablescan\f1\f1 for additional information. +.RE +.PP +\fBmongod \-\-shutdown\f1 +.RS +.PP +The \fB\-\-shutdown\f1\f1 option cleanly and safely terminates the \fBmongod\f1\f1 +process. When invoking \fBmongod\f1\f1 with this option you must set the +\fB\-\-dbpath\f1\f1 option either directly or by way of the +\fBconfiguration file\f1 and the +\fB\-\-config\f1\f1 option. +.PP +The \fB\-\-shutdown\f1\f1 option is available only on Linux systems. +.PP +For additional ways to shut down, see also \fBStop mongod\f1 Processes\f1\&. +.RE +.PP +\fBmongod \-\-redactClientLogData\f1 +.RS +.PP +A \fBmongod\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 redacts any message accompanying a given +log event before logging. This prevents the \fBmongod\f1\f1 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. -.sp -Use \fI\%\-\-redactClientLogData\fP in conjunction with -/core/security\-encryption\-at\-rest and -/core/security\-transport\-encryption to assist compliance with +.PP +Use \fB\-\-redactClientLogData\f1\f1 in conjunction with +\fBEncryption at Rest\f1 and +\fBTLS/SSL (Transport Encryption)\f1 to assist compliance with regulatory requirements. -.sp +.PP For example, a MongoDB deployment might store Personally Identifiable -Information (PII) in one or more collections. The \fBmongod\fP logs events +Information (PII) in one or more collections. The \fBmongod\f1\f1 logs events such as those related to CRUD operations, sharding metadata, etc. It is -possible that the \fBmongod\fP may expose PII as a part of these logging -operations. A \fBmongod\fP running with \fI\%\-\-redactClientLogData\fP removes any message +possible that the \fBmongod\f1\f1 may expose PII as a part of these logging +operations. A \fBmongod\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 removes any message accompanying these events before being output to the log, effectively removing the PII. -.sp -Diagnostics on a \fBmongod\fP running with \fI\%\-\-redactClientLogData\fP may be more difficult +.PP +Diagnostics on a \fBmongod\f1\f1 running with \fB\-\-redactClientLogData\f1\f1 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 of \fI\%\-\-redactClientLogData\fP on log output. -.sp -On a running \fBmongod\fP, use \fBsetParameter\fP with the -\fBredactClientLogData\fP parameter to configure this setting. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-networkMessageCompressors -\fIDefault\fP: snappy,zstd,zlib -.sp -New in version 3.4. - -.sp +\fBprocess logging\f1 manual page for an +example of the effect of \fB\-\-redactClientLogData\f1\f1 on log output. +.PP +On a running \fBmongod\f1\f1, use \fBsetParameter\f1\f1 with the +\fBredactClientLogData\f1\f1 parameter to configure this setting. +.RE +.PP +\fBmongod \-\-networkMessageCompressors\f1 +.RS +.PP +\fIDefault\f1: snappy,zstd,zlib +.PP Specifies the default compressor(s) to use for -communication between this \fBmongod\fP instance and: -.INDENT 7.0 +communication between this \fBmongod\f1\f1 instance and: +.RS .IP \(bu 2 other members of the deployment if the instance is part of a replica set or a sharded cluster .IP \(bu 2 -a \fBmongo\fP shell +\fBmongosh\f1\f1 .IP \(bu 2 -drivers that support the \fBOP_COMPRESSED\fP message format. -.UNINDENT -.sp +drivers that support the \fBOP_COMPRESSED\f1 message format. +.RE +.PP MongoDB supports the following compressors: -.INDENT 7.0 +.RS .IP \(bu 2 -snappy +\fBsnappy\f1 .IP \(bu 2 -zlib (Available starting in MongoDB 3.6) +\fBzlib\f1 (Available starting in MongoDB 3.6) .IP \(bu 2 -zstd (Available starting in MongoDB 4.2) -.UNINDENT -.sp -\fBIn versions 3.6 and 4.0\fP, \fI\%mongod\fP and -\fBmongos\fP enable network compression by default with -\fBsnappy\fP as the compressor. -.sp -\fBStarting in version 4.2\fP, \fI\%mongod\fP and -\fBmongos\fP instances default to both \fBsnappy,zstd,zlib\fP +\fBzstd\f1 (Available starting in MongoDB 4.2) +.RE +.PP +\fBIn versions 3.6 and 4.0\f1, \fBmongod\f1\f1 and +\fBmongos\f1\f1 enable network compression by default with +\fBsnappy\f1 as the compressor. +.PP +\fBStarting in version 4.2\f1, \fBmongod\f1\f1 and +\fBmongos\f1\f1 instances default to both \fBsnappy,zstd,zlib\f1 compressors, in that order. -.sp -To disable network compression, set the value to \fBdisabled\fP\&. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP +To disable network compression, set the value to \fBdisabled\f1\&. +.PP Messages are compressed when both parties enable network compression. Otherwise, messages between the parties are uncompressed. -.UNINDENT -.UNINDENT -.sp +.PP 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 \fBmongo\fP shell specifies the following network -compressors \fBzlib,snappy\fP and the \fI\%mongod\fP specifies -\fBsnappy,zlib\fP, messages between \fBmongo\fP shell and -\fI\%mongod\fP uses \fBzlib\fP\&. -.sp +example, if \fBmongosh\f1\f1 specifies the following network +compressors \fBzlib,snappy\f1 and the \fBmongod\f1\f1 specifies +\fBsnappy,zlib\f1, messages between \fBmongosh\f1\f1 and +\fBmongod\f1\f1 uses \fBzlib\f1\&. +.PP If the parties do not share at least one common compressor, messages -between the parties are uncompressed. For example, if a -\fBmongo\fP shell specifies the network compressor -\fBzlib\fP and \fI\%mongod\fP specifies \fBsnappy\fP, messages -between \fBmongo\fP shell and \fI\%mongod\fP are not compressed. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-timeZoneInfo +between the parties are uncompressed. For example, if +\fBmongosh\f1\f1 specifies the network compressor +\fBzlib\f1 and \fBmongod\f1\f1 specifies \fBsnappy\f1, messages +between \fBmongosh\f1\f1 and \fBmongod\f1\f1 are not +compressed. +.RE +.PP +\fBmongod \-\-timeZoneInfo\f1 +.RS +.PP 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. -.sp -The configuration file included with Linux and macOS packages sets the time -zone database path to \fB/usr/share/zoneinfo\fP by default. -.sp -The built\-in time zone database is a copy of the \fI\%Olson/IANA time zone -database\fP\&. 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 -\fI\%https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip\fP\&. -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -wget https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip -unzip timezonedb\-latest.zip -mongod \-\-timeZoneInfo timezonedb\-2017b/ -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBprocessManagement.timeZoneInfo\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-serviceExecutor -\fIDefault\fP: synchronous -.sp -New in version 3.6. - -.sp -Determines the threading and execution model \fBmongod\fP uses to -execute client requests. The \fB\-\-serviceExecutor\fP option accepts one -of the following values: -.TS -center; -|l|l|. -_ -T{ -Value -T} T{ -Description -T} -_ -T{ -\fBsynchronous\fP -T} T{ -The \fBmongod\fP uses synchronous networking and manages its -networking thread pool on a per connection basis. Previous -versions of MongoDB managed threads in this way. -T} -_ -T{ -\fBadaptive\fP -T} T{ -The \fBmongod\fP 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. -T} -_ -.TE -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-outputConfig -New in version 4.2. - -.sp -Outputs the \fBmongod\fP instance\(aqs configuration options, formatted -in YAML, to \fBstdout\fP and exits the \fBmongod\fP instance. For -configuration options that uses externally\-sourced\-values, -\fI\%\-\-outputConfig\fP returns the resolved value for those options. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 +.PP +The configuration file included with Linux and macOS packages sets the +time zone database path to \fB/usr/share/zoneinfo\f1 by default. +.PP +The built\-in time zone database is a copy of the Olson/IANA time zone +database (https://www.iana.org/time\-zones)\&. It is updated along with +MongoDB releases, but the time zone database release cycle +differs from the MongoDB release cycle. The most recent release of +the time zone database is available on our download site (https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip)\&. +.PP +.EX + wget https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip + unzip timezonedb\-latest.zip + mongod \-\-timeZoneInfo timezonedb\-2017b/ +.EE +.PP +MongoDB uses the third party timelib (https://github.com/derickr/timelib) library to provide accurate +conversions between timezones. Due to a recent update, \fBtimelib\f1 +could create inaccurate time zone conversions in older versions of +MongoDB. +.PP +To explicitly link to the time zone database in versions of MongoDB +prior to 5.0, 4.4.7, 4.2.14, and 4.0.25, download the time zone +database (https://downloads.mongodb.org/olson_tz_db/timezonedb\-latest.zip)\&. +and use the \fBtimeZoneInfo\f1\f1 parameter. +.PP +\fBprocessManagement.timeZoneInfo\f1\f1\&. +.RE +.PP +\fBmongod \-\-outputConfig\f1 +.RS +.PP +Outputs the \fBmongod\f1\f1 instance\(aqs configuration options, formatted +in YAML, to \fBstdout\f1 and exits the \fBmongod\f1\f1 instance. For +configuration options that uses \fBExternally Sourced Configuration File Values\f1, +\fB\-\-outputConfig\f1\f1 returns the resolved value for those options. +.PP This may include any configured passwords or secrets previously obfuscated through the external source. -.UNINDENT -.UNINDENT -.sp +.PP For usage examples, see: -.INDENT 7.0 +.RS .IP \(bu 2 -expansion\-directive\-output +\fBOutput the Configuration File with Resolved Expansion Directive Values\f1 .IP \(bu 2 -/tutorial/convert\-command\-line\-options\-to\-yaml -.UNINDENT -.UNINDENT -.SS Free Monitoring -.sp -New in version 4.0. - -.INDENT 0.0 -.TP -.B \-\-enableFreeMonitoring -New in version 4.0: Available for MongoDB Community Edition. - -.sp -Enables or disables free MongoDB Cloud monitoring\&. \fI\%\-\-enableFreeMonitoring\fP accepts the following +\fBConvert Command\-Line Options to YAML\f1 +.RE +.RE +.SS FREE MONITORING +.PP +\fBmongod \-\-enableFreeMonitoring\f1 +.RS +.PP +Available for MongoDB Community Edition. +.PP +Enables or disables \fBfree MongoDB Cloud monitoring\f1\&. \fB\-\-enableFreeMonitoring\f1\f1 accepts the following values: -.TS -center; -|l|l|. -_ -T{ -\fBruntime\fP -T} T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 +Value +.IP \(bu 4 +Description +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBruntime\f1 +.IP \(bu 4 Default. You can enable or disable free monitoring during runtime. -.sp +.IP To enable or disable free monitoring during runtime, see -\fBdb.enableFreeMonitoring()\fP and -\fBdb.disableFreeMonitoring()\fP\&. -.sp +\fBdb.enableFreeMonitoring()\f1\f1 and +\fBdb.disableFreeMonitoring()\f1\f1\&. +.IP To enable or disable free monitoring during runtime when running with access control, users must have required -privileges. See \fBdb.enableFreeMonitoring()\fP and -\fBdb.disableFreeMonitoring()\fP for details. -T} -_ -T{ -\fBon\fP -T} T{ +privileges. See \fBdb.enableFreeMonitoring()\f1\f1 and +\fBdb.disableFreeMonitoring()\f1\f1 for details. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBon\f1 +.IP \(bu 4 Enables free monitoring at startup; i.e. registers for free monitoring. When enabled at startup, you cannot disable free monitoring during runtime. -T} -_ -T{ -\fBoff\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBoff\f1 +.IP \(bu 4 Disables free monitoring at startup, regardless of whether you have previously registered for free monitoring. When disabled at startup, you cannot enable free monitoring during runtime. -T} -_ -.TE -.sp +.RE +.RE +.PP Once enabled, the free monitoring state remains enabled until explicitly disabled. That is, you do not need to re\-enable each time you start the server. -.sp +.PP For the corresponding configuration file setting, see -\fBcloud.monitoring.free.state\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-freeMonitoringTag -New in version 4.0: Available for MongoDB Community Edition. - -.sp +\fBcloud.monitoring.free.state\f1\f1\&. +.RE +.PP +\fBmongod \-\-freeMonitoringTag\f1 +.RS +.PP +Available for MongoDB Community Edition. +.PP Optional tag to describe environment context. The tag can be sent as -part of the free MongoDB Cloud monitoring registration at start up. -.sp +part of the \fBfree MongoDB Cloud monitoring\f1 registration at start up. +.PP For the corresponding configuration file setting, see -\fBcloud.monitoring.free.tags\fP\&. -.UNINDENT -.SS LDAP Authentication or Authorization Options -.INDENT 0.0 -.TP -.B \-\-ldapServers :,:,...,: -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The LDAP server against which the \fBmongod\fP authenticates users or +\fBcloud.monitoring.free.tags\f1\f1\&. +.RE +.SS LDAP AUTHENTICATION OR AUTHORIZATION OPTIONS +.PP +\fBmongod \-\-ldapServers\f1 +.RS +.PP +The LDAP server against which the \fBmongod\f1\f1 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. -.sp +.PP If your LDAP infrastructure partitions the LDAP directory over multiple LDAP -servers, specify \fIone\fP LDAP server or any of its replicated instances to -\fI\%\-\-ldapServers\fP\&. MongoDB supports following LDAP referrals as defined in \fI\%RFC 4511 -4.1.10\fP\&. Do not use \fI\%\-\-ldapServers\fP +servers, specify \fIone\f1 LDAP server or any of its replicated instances to +\fB\-\-ldapServers\f1\f1\&. MongoDB supports following LDAP referrals as defined in RFC 4511 +4.1.10 (https://www.rfc\-editor.org/rfc/rfc4511.txt)\&. Do not use \fB\-\-ldapServers\f1\f1 for listing every LDAP server in your infrastructure. -.sp -This setting can be configured on a running \fBmongod\fP using -\fBsetParameter\fP\&. -.sp -If unset, \fBmongod\fP cannot use LDAP authentication or authorization\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapValidateLDAPServerConfig -\fIAvailable in MongoDB Enterprise\fP -.sp -A flag that determines if the \fI\%mongod\fP instance checks -the availability of the \fI\%LDAP server(s)\fP as part of its startup: -.INDENT 7.0 +.PP +This setting can be configured on a running \fBmongod\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +If unset, \fBmongod\f1\f1 cannot use \fBLDAP authentication or authorization\f1\&. +.RE +.PP +\fBmongod \-\-ldapValidateLDAPServerConfig\f1 +.RS +.PP +\fIAvailable in MongoDB Enterprise\f1 +.PP +A flag that determines if the \fBmongod\f1\f1 instance checks +the availability of the \fBLDAP server(s)\f1\f1 as part of its startup: +.RS .IP \(bu 2 -If \fBtrue\fP, the \fI\%mongod\fP instance performs the +If \fBtrue\f1, the \fBmongod\f1\f1 instance performs the availability check and only continues to start up if the LDAP server is available. .IP \(bu 2 -If \fBfalse\fP, the \fI\%mongod\fP instance skips the +If \fBfalse\f1, the \fBmongod\f1\f1 instance skips the availability check; i.e. the instance starts up even if the LDAP server is unavailable. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapQueryUser -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The identity with which \fBmongod\fP binds as, when connecting to or +.RE +.RE +.PP +\fBmongod \-\-ldapQueryUser\f1 +.RS +.PP +The identity with which \fBmongod\f1\f1 binds as, when connecting to or performing queries on an LDAP server. -.sp +.PP Only required if any of the following are true: -.INDENT 7.0 +.RS .IP \(bu 2 -Using LDAP authorization\&. +Using \fBLDAP authorization\f1\&. .IP \(bu 2 -Using an LDAP query for \fI\%username transformation\fP\&. +Using an LDAP query for \fBusername transformation\f1\f1\&. .IP \(bu 2 The LDAP server disallows anonymous binds -.UNINDENT -.sp -You must use \fI\%\-\-ldapQueryUser\fP with \fI\%\-\-ldapQueryPassword\fP\&. -.sp -If unset, \fBmongod\fP will not attempt to bind to the LDAP server. -.sp -This setting can be configured on a running \fBmongod\fP using -\fBsetParameter\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Windows MongoDB deployments can use \fI\%\-\-ldapBindWithOSDefaults\fP -instead of \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapQueryPassword\fP\&. You cannot specify -both \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapBindWithOSDefaults\fP at the same time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapQueryPassword -New in version 3.4: Available in MongoDB Enterprise only. -.sp +.RE +.PP +You must use \fB\-\-ldapQueryUser\f1\f1 with \fB\-\-ldapQueryPassword\f1\f1\&. +.PP +If unset, \fBmongod\f1\f1 will not attempt to bind to the LDAP server. +.PP +This setting can be configured on a running \fBmongod\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1 +instead of \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify +both \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time. +.RE +.PP +\fBmongod \-\-ldapQueryPassword\f1 +.RS +.PP The password used to bind to an LDAP server when using -\fI\%\-\-ldapQueryUser\fP\&. You must use \fI\%\-\-ldapQueryPassword\fP with -\fI\%\-\-ldapQueryUser\fP\&. - -.sp -If unset, \fBmongod\fP will not attempt to bind to the LDAP server. -.sp -This setting can be configured on a running \fBmongod\fP using -\fBsetParameter\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Windows MongoDB deployments can use \fI\%\-\-ldapBindWithOSDefaults\fP -instead of \fI\%\-\-ldapQueryPassword\fP and \fI\%\-\-ldapQueryPassword\fP\&. You cannot specify -both \fI\%\-\-ldapQueryPassword\fP and \fI\%\-\-ldapBindWithOSDefaults\fP at the same time. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindWithOSDefaults -\fIDefault\fP: false -.sp -New in version 3.4: Available in MongoDB Enterprise for the Windows platform only. - -.sp -Allows \fBmongod\fP to authenticate, or bind, using your Windows login +\fB\-\-ldapQueryUser\f1\f1\&. You must use \fB\-\-ldapQueryPassword\f1\f1 with +\fB\-\-ldapQueryUser\f1\f1\&. +.PP +If unset, \fBmongod\f1\f1 will not attempt to bind to the LDAP server. +.PP +This setting can be configured on a running \fBmongod\f1\f1 using +\fBsetParameter\f1\f1\&. +.PP +Starting in MongoDB 4.4, the \fBldapQueryPassword\f1 +\fBsetParameter\f1\f1 command accepts either a string or +an array of strings. If set to an array, each password is tried +until one succeeds. This can be used to perform a rollover of the +LDAP account password without downtime for MongoDB. +.PP +Windows MongoDB deployments can use \fB\-\-ldapBindWithOSDefaults\f1\f1 +instead of \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1\&. You cannot specify +both \fB\-\-ldapQueryPassword\f1\f1 and \fB\-\-ldapBindWithOSDefaults\f1\f1 at the same time. +.RE +.PP +\fBmongod \-\-ldapBindWithOSDefaults\f1 +.RS +.PP +\fIDefault\f1: false +.PP +Available in MongoDB Enterprise for the Windows platform only. +.PP +Allows \fBmongod\f1\f1 to authenticate, or bind, using your Windows login credentials when connecting to the LDAP server. -.sp +.PP Only required if: -.INDENT 7.0 +.RS .IP \(bu 2 -Using LDAP authorization\&. +Using \fBLDAP authorization\f1\&. .IP \(bu 2 -Using an LDAP query for \fI\%username transformation\fP\&. +Using an LDAP query for \fBusername transformation\f1\f1\&. .IP \(bu 2 The LDAP server disallows anonymous binds -.UNINDENT -.sp -Use \fI\%\-\-ldapBindWithOSDefaults\fP to replace \fI\%\-\-ldapQueryUser\fP and -\fI\%\-\-ldapQueryPassword\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindMethod -\fIDefault\fP: simple -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The method \fBmongod\fP uses to authenticate to an LDAP server. -Use with \fI\%\-\-ldapQueryUser\fP and \fI\%\-\-ldapQueryPassword\fP to +.RE +.PP +Use \fB\-\-ldapBindWithOSDefaults\f1\f1 to replace \fB\-\-ldapQueryUser\f1\f1 and +\fB\-\-ldapQueryPassword\f1\f1\&. +.RE +.PP +\fBmongod \-\-ldapBindMethod\f1 +.RS +.PP +\fIDefault\f1: simple +.PP +The method \fBmongod\f1\f1 uses to authenticate to an LDAP server. +Use with \fB\-\-ldapQueryUser\f1\f1 and \fB\-\-ldapQueryPassword\f1\f1 to connect to the LDAP server. -.sp -\fI\%\-\-ldapBindMethod\fP supports the following values: -.INDENT 7.0 +.PP +\fB\-\-ldapBindMethod\f1\f1 supports the following values: +.RS .IP \(bu 2 -\fBsimple\fP \- \fBmongod\fP uses simple authentication. +\fBsimple\f1 \- \fBmongod\f1\f1 uses simple authentication. .IP \(bu 2 -\fBsasl\fP \- \fBmongod\fP uses SASL protocol for authentication -.UNINDENT -.sp -If you specify \fBsasl\fP, you can configure the available SASL mechanisms -using \fI\%\-\-ldapBindSaslMechanisms\fP\&. \fBmongod\fP defaults to -using \fBDIGEST\-MD5\fP mechanism. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapBindSaslMechanisms -\fIDefault\fP: DIGEST\-MD5 -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A comma\-separated list of SASL mechanisms \fBmongod\fP can -use when authenticating to the LDAP server. The \fBmongod\fP and the -LDAP server must agree on at least one mechanism. The \fBmongod\fP +\fBsasl\f1 \- \fBmongod\f1\f1 uses SASL protocol for authentication +.RE +.PP +If you specify \fBsasl\f1, you can configure the available SASL mechanisms +using \fB\-\-ldapBindSaslMechanisms\f1\f1\&. \fBmongod\f1\f1 defaults to +using \fBDIGEST\-MD5\f1 mechanism. +.RE +.PP +\fBmongod \-\-ldapBindSaslMechanisms\f1 +.RS +.PP +\fIDefault\f1: DIGEST\-MD5 +.PP +A comma\-separated list of SASL mechanisms \fBmongod\f1\f1 can +use when authenticating to the LDAP server. The \fBmongod\f1\f1 and the +LDAP server must agree on at least one mechanism. The \fBmongod\f1\f1 dynamically loads any SASL mechanism libraries installed on the host machine at runtime. -.sp +.PP Install and configure the appropriate libraries for the selected -SASL mechanism(s) on both the \fBmongod\fP host and the remote +SASL mechanism(s) on both the \fBmongod\f1\f1 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. -.sp -If using the \fBGSSAPI\fP SASL mechanism for use with -security\-kerberos, verify the following for the -\fBmongod\fP host machine: -.INDENT 7.0 -.TP -.B \fBLinux\fP -.INDENT 7.0 +.PP +If using the \fBGSSAPI\f1 SASL mechanism for use with +\fBKerberos Authentication\f1, verify the following for the +\fBmongod\f1\f1 host machine: +.PP +\fBLinux\f1\f1 +.RS +.RS .IP \(bu 2 -The \fBKRB5_CLIENT_KTNAME\fP environment -variable resolves to the name of the client keytab\-files +The \fBKRB5_CLIENT_KTNAME\f1 environment +variable resolves to the name of the client \fBLinux Keytab Files\f1 for the host machine. For more on Kerberos environment variables, please defer to the -\fI\%Kerberos documentation\fP\&. +Kerberos documentation (https://web.mit.edu/kerberos/krb5\-1.13/doc/admin/env_variables.html)\&. .IP \(bu 2 The client keytab includes a -kerberos\-user\-principal for the \fBmongod\fP to use when +\fBUser Principal\f1 for the \fBmongod\f1\f1 to use when connecting to the LDAP server and execute LDAP queries. -.UNINDENT -.TP -.B \fBWindows\fP +.RE +.RE +.PP +\fBWindows\f1\f1 +.RS +.PP If connecting to an Active Directory server, the Windows Kerberos configuration automatically generates a -\fI\%Ticket\-Granting\-Ticket\fP -when the user logs onto the system. Set \fI\%\-\-ldapBindWithOSDefaults\fP to -\fBtrue\fP to allow \fBmongod\fP to use the generated credentials when +Ticket\-Granting\-Ticket (https://msdn.microsoft.com/en\-us/library/windows/desktop/aa380510(v=vs.85).aspx) +when the user logs onto the system. Set \fB\-\-ldapBindWithOSDefaults\f1\f1 to +\fBtrue\f1 to allow \fBmongod\f1\f1 to use the generated credentials when connecting to the Active Directory server and execute queries. -.UNINDENT -.sp -Set \fI\%\-\-ldapBindMethod\fP to \fBsasl\fP to use this option. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.RE +.PP +Set \fB\-\-ldapBindMethod\f1\f1 to \fBsasl\f1 to use this option. +.PP For a complete list of SASL mechanisms see the -\fI\%IANA listing\fP\&. +IANA listing (http://www.iana.org/assignments/sasl\-mechanisms/sasl\-mechanisms.xhtml)\&. Defer to the documentation for your LDAP or Active Directory service for identifying the SASL mechanisms compatible with the service. -.sp +.PP 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. -.sp +.PP For more information on SASL, defer to the following resources: -.INDENT 0.0 +.RS .IP \(bu 2 -For Linux, please see the \fI\%Cyrus SASL documentation\fP\&. +For Linux, please see the Cyrus SASL documentation (https://www.cyrusimap.org/sasl/)\&. .IP \(bu 2 -For Windows, please see the \fI\%Windows SASL documentation\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapTransportSecurity -\fIDefault\fP: tls -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -By default, \fBmongod\fP creates a TLS/SSL secured connection to the LDAP +For Windows, please see the Windows SASL documentation (https://msdn.microsoft.com/en\-us/library/cc223500.aspx)\&. +.RE +.RE +.PP +\fBmongod \-\-ldapTransportSecurity\f1 +.RS +.PP +\fIDefault\f1: tls +.PP +By default, \fBmongod\f1\f1 creates a TLS/SSL secured connection to the LDAP server. -.sp +.PP For Linux deployments, you must configure the appropriate TLS Options in -\fB/etc/openldap/ldap.conf\fP file. Your operating system\(aqs package manager +\fB/etc/openldap/ldap.conf\f1 file. Your operating system\(aqs package manager creates this file as part of the MongoDB Enterprise installation, via the -\fBlibldap\fP dependency. See the documentation for \fBTLS Options\fP in the -\fI\%ldap.conf OpenLDAP documentation\fP +\fBlibldap\f1 dependency. See the documentation for \fBTLS Options\f1 in the +ldap.conf OpenLDAP documentation (http://www.openldap.org/software/man.cgi?query=ldap.conf&manpath=OpenLDAP+2.4\-Release) for more complete instructions. -.sp +.PP 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. -.sp -Set \fI\%\-\-ldapTransportSecurity\fP to \fBnone\fP to disable TLS/SSL between \fBmongod\fP and the LDAP +.PP +Set \fB\-\-ldapTransportSecurity\f1\f1 to \fBnone\f1 to disable TLS/SSL between \fBmongod\f1\f1 and the LDAP server. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -Setting \fI\%\-\-ldapTransportSecurity\fP to \fBnone\fP transmits plaintext information and possibly -credentials between \fBmongod\fP and the LDAP server. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapTimeoutMS -\fIDefault\fP: 10000 -.sp -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -The amount of time in milliseconds \fBmongod\fP should wait for an LDAP server +.PP +Setting \fB\-\-ldapTransportSecurity\f1\f1 to \fBnone\f1 transmits plaintext information and possibly +credentials between \fBmongod\f1\f1 and the LDAP server. +.RE +.PP +\fBmongod \-\-ldapTimeoutMS\f1 +.RS +.PP +\fIDefault\f1: 10000 +.PP +The amount of time in milliseconds \fBmongod\f1\f1 should wait for an LDAP server to respond to a request. -.sp -Increasing the value of \fI\%\-\-ldapTimeoutMS\fP may prevent connection failure between the +.PP +Increasing the value of \fB\-\-ldapTimeoutMS\f1\f1 may prevent connection failure between the MongoDB server and the LDAP server, if the source of the failure is a -connection timeout. Decreasing the value of \fI\%\-\-ldapTimeoutMS\fP reduces the time +connection timeout. Decreasing the value of \fB\-\-ldapTimeoutMS\f1\f1 reduces the time MongoDB waits for a response from the LDAP server. -.sp -This setting can be configured on a running \fBmongod\fP using -\fBsetParameter\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapUserToDNMapping -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -Maps the username provided to \fBmongod\fP for authentication to a LDAP -Distinguished Name (DN). You may need to use \fI\%\-\-ldapUserToDNMapping\fP to transform a +.PP +This setting can be configured on a running \fBmongod\f1\f1 using +\fBsetParameter\f1\f1\&. +.RE +.PP +\fBmongod \-\-ldapUserToDNMapping\f1 +.RS +.PP +Maps the username provided to \fBmongod\f1\f1 for authentication to a LDAP +Distinguished Name (DN). You may need to use \fB\-\-ldapUserToDNMapping\f1\f1 to transform a username into an LDAP DN in the following scenarios: -.INDENT 7.0 +.RS .IP \(bu 2 Performing LDAP authentication with simple LDAP binding, where users authenticate to MongoDB with usernames that are not full LDAP DNs. .IP \(bu 2 -Using an \fI\%LDAP authorization query template\fP that requires a DN. +Using an \fBLDAP authorization query template\f1\f1 that requires a DN. .IP \(bu 2 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. -.UNINDENT -.sp -\fI\%\-\-ldapUserToDNMapping\fP expects a quote\-enclosed JSON\-string representing an ordered array -of documents. Each document contains a regular expression \fBmatch\fP and -either a \fBsubstitution\fP or \fBldapQuery\fP template used for transforming the +.RE +.PP +\fB\-\-ldapUserToDNMapping\f1\f1 expects a quote\-enclosed JSON\-string representing an ordered array +of documents. Each document contains a regular expression \fBmatch\f1 and +either a \fBsubstitution\f1 or \fBldapQuery\f1 template used for transforming the incoming username. -.sp +.PP Each document in the array has the following form: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -{ - match: "" - substitution: "" | ldapQuery: "" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.TS -center; -|l|l|l|. -_ -T{ +.PP +.EX + { + match: "" + substitution: "" | ldapQuery: "" + } +.EE +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Field -T} T{ +.IP \(bu 4 Description -T} T{ +.IP \(bu 4 Example -T} -_ -T{ -\fBmatch\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBmatch\f1 +.IP \(bu 4 An ECMAScript\-formatted regular expression (regex) to match against a provided username. Each parenthesis\-enclosed section represents a -regex capture group used by \fBsubstitution\fP or \fBldapQuery\fP\&. -T} T{ -\fB"(.+)ENGINEERING"\fP -\fB"(.+)DBA"\fP -T} -_ -T{ -\fBsubstitution\fP -T} T{ +regex capture group used by \fBsubstitution\f1 or \fBldapQuery\f1\&. +.IP \(bu 4 +\fB"(.+)ENGINEERING"\f1 +\fB"(.+)DBA"\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBsubstitution\f1 +.IP \(bu 4 An LDAP distinguished name (DN) formatting template that converts the -authentication name matched by the \fBmatch\fP regex into a LDAP DN. +authentication name matched by the \fBmatch\f1 regex into a LDAP DN. Each curly bracket\-enclosed numeric value is replaced by the -corresponding \fI\%regex capture group\fP extracted -from the authentication username via the \fBmatch\fP regex. -.sp -The result of the substitution must be an \fI\%RFC4514\fP escaped string. -T} T{ +corresponding regex capture group (http://www.regular\-expressions.info/refcapture.html) extracted +from the authentication username via the \fBmatch\f1 regex. +.IP +The result of the substitution must be an RFC4514 (https://www.ietf.org/rfc/rfc4514.txt) escaped string. +.IP \(bu 4 \fB"cn={0},ou=engineering, -dc=example,dc=com"\fP -T} -_ -T{ -\fBldapQuery\fP -T} T{ +dc=example,dc=com"\f1 +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBldapQuery\f1 +.IP \(bu 4 A LDAP query formatting template that inserts the authentication -name matched by the \fBmatch\fP regex into an LDAP query URI encoded +name matched by the \fBmatch\f1 regex into an LDAP query URI encoded respecting RFC4515 and RFC4516. Each curly bracket\-enclosed numeric -value is replaced by the corresponding \fI\%regex capture group\fP extracted -from the authentication username via the \fBmatch\fP expression. -\fBmongod\fP executes the query against the LDAP server to retrieve -the LDAP DN for the authenticated user. \fBmongod\fP requires +value is replaced by the corresponding regex capture group (http://www.regular\-expressions.info/refcapture.html) extracted +from the authentication username via the \fBmatch\f1 expression. +\fBmongod\f1\f1 executes the query against the LDAP server to retrieve +the LDAP DN for the authenticated user. \fBmongod\f1\f1 requires exactly one returned result for the transformation to be -successful, or \fBmongod\fP skips this transformation. -T} T{ +successful, or \fBmongod\f1\f1 skips this transformation. +.IP \(bu 4 \fB"ou=engineering,dc=example, -dc=com??one?(user={0})"\fP -T} -_ -.TE -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -An explanation of \fI\%RFC4514\fP, -\fI\%RFC4515\fP, -\fI\%RFC4516\fP, or LDAP queries is out +dc=com??one?(user={0})"\f1 +.RE +.RE +.PP +An explanation of RFC4514 (https://www.ietf.org/rfc/rfc4514.txt), +RFC4515 (https://tools.ietf.org/search/rfc4515), +RFC4516 (https://tools.ietf.org/html/rfc4516), or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource. -.UNINDENT -.UNINDENT -.sp -For each document in the array, you must use either \fBsubstitution\fP or -\fBldapQuery\fP\&. You \fIcannot\fP specify both in the same document. -.sp -When performing authentication or authorization, \fBmongod\fP steps through +.PP +For each document in the array, you must use either \fBsubstitution\f1 or +\fBldapQuery\f1\&. You \fIcannot\f1 specify both in the same document. +.PP +When performing authentication or authorization, \fBmongod\f1\f1 steps through each document in the array in the given order, checking the authentication -username against the \fBmatch\fP filter. If a match is found, -\fBmongod\fP applies the transformation and uses the output for -authenticating the user. \fBmongod\fP does not check the remaining documents +username against the \fBmatch\f1 filter. If a match is found, +\fBmongod\f1\f1 applies the transformation and uses the output for +authenticating the user. \fBmongod\f1\f1 does not check the remaining documents in the array. -.sp +.PP If the given document does not match the provided authentication -name, \fI\%mongod\fP continues through the list of documents +name, \fBmongod\f1\f1 continues through the list of documents to find additional matches. If no matches are found in any document, or the transformation the document describes fails, -\fI\%mongod\fP returns an error. -.sp -Starting in MongoDB 4.4, \fI\%mongod\fP also returns an error +\fBmongod\f1\f1 returns an error. +.PP +Starting in MongoDB 4.4, \fBmongod\f1\f1 also returns an error if one of the transformations cannot be evaluated due to networking -or authentication failures to the LDAP server. \fI\%mongod\fP +or authentication failures to the LDAP server. \fBmongod\f1\f1 rejects the connection request and does not check the remaining documents in the array. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp +.PP +Starting in MongoDB 5.0, \fB\-\-ldapUserToDNMapping\f1\f1 +accepts an empty string \fB""\f1 or empty array \fB[ ]\f1 in place of a +mapping documnent. If providing an empty string or empty array to +\fB\-\-ldapUserToDNMapping\f1\f1, MongoDB will map the +authenticated username as the LDAP DN. Previously, providing an +empty mapping document would cause mapping to fail. +.PP The following shows two transformation documents. The first -document matches against any string ending in \fB@ENGINEERING\fP, placing +document matches against any string ending in \fB@ENGINEERING\f1, placing anything preceeding the suffix into a regex capture group. The -second document matches against any string ending in \fB@DBA\fP, placing +second document matches against any string ending in \fB@DBA\f1, placing anything preceeding the suffix into a regex capture group. -.sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 -You must pass the array to \fI\%\-\-ldapUserToDNMapping\fP as a string. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -"[ - { - match: "(.+)@ENGINEERING.EXAMPLE.COM", - substitution: "cn={0},ou=engineering,dc=example,dc=com" - }, - { - match: "(.+)@DBA.EXAMPLE.COM", - ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" - - } - -]" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -A user with username \fBalice@ENGINEERING.EXAMPLE.COM\fP matches the first -document. The regex capture group \fB{0}\fP corresponds to the string -\fBalice\fP\&. The resulting output is the DN -\fB"cn=alice,ou=engineering,dc=example,dc=com"\fP\&. -.sp -A user with username \fBbob@DBA.EXAMPLE.COM\fP matches the second document. -The regex capture group \fB{0}\fP corresponds to the string \fBbob\fP\&. The +.PP +.EX + "[ + { + match: "(.+)@ENGINEERING.EXAMPLE.COM", + substitution: "cn={0},ou=engineering,dc=example,dc=com" + }, + { + match: "(.+)@DBA.EXAMPLE.COM", + ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})" + + } + + ]" +.EE +.PP +A user with username \fBalice@ENGINEERING.EXAMPLE.COM\f1 matches the first +document. The regex capture group \fB{0}\f1 corresponds to the string +\fBalice\f1\&. The resulting output is the DN +\fB"cn=alice,ou=engineering,dc=example,dc=com"\f1\&. +.PP +A user with username \fBbob@DBA.EXAMPLE.COM\f1 matches the second document. +The regex capture group \fB{0}\f1 corresponds to the string \fBbob\f1\&. The resulting output is the LDAP query -\fB"ou=dba,dc=example,dc=com??one?(user=bob)"\fP\&. \fBmongod\fP executes this +\fB"ou=dba,dc=example,dc=com??one?(user=bob)"\f1\&. \fBmongod\f1\f1 executes this query against the LDAP server, returning the result -\fB"cn=bob,ou=dba,dc=example,dc=com"\fP\&. -.UNINDENT -.UNINDENT -.sp -If \fI\%\-\-ldapUserToDNMapping\fP is unset, \fBmongod\fP applies no transformations to the username +\fB"cn=bob,ou=dba,dc=example,dc=com"\f1\&. +.PP +If \fB\-\-ldapUserToDNMapping\f1\f1 is unset, \fBmongod\f1\f1 applies no transformations to the username when attempting to authenticate or authorize a user against the LDAP server. -.sp -This setting can be configured on a running \fBmongod\fP using the -\fBsetParameter\fP database command. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-ldapAuthzQueryTemplate -New in version 3.4: Available in MongoDB Enterprise only. - -.sp -A relative LDAP query URL formatted conforming to \fI\%RFC4515\fP and \fI\%RFC4516\fP that \fBmongod\fP executes to obtain +.PP +This setting can be configured on a running \fBmongod\f1\f1 using the +\fBsetParameter\f1\f1 database command. +.RE +.PP +\fBmongod \-\-ldapAuthzQueryTemplate\f1 +.RS +.PP +A relative LDAP query URL formatted conforming to RFC4515 (https://tools.ietf.org/search/rfc4515) and RFC4516 (https://tools.ietf.org/html/rfc4516) that \fBmongod\f1\f1 executes to obtain the LDAP groups to which the authenticated user belongs to. The query is -relative to the host or hosts specified in \fI\%\-\-ldapServers\fP\&. -.sp +relative to the host or hosts specified in \fB\-\-ldapServers\f1\f1\&. +.PP In the URL, you can use the following substituion tokens: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Substitution Token -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fB{USER}\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB{USER}\f1 +.IP \(bu 4 Substitutes the authenticated username, or the -\fBtransformed\fP -username if a \fI\%username mapping\fP is specified. -T} -_ -T{ -\fB{PROVIDED_USER}\fP -T} T{ +\fBtransformed\f1\f1 +username if a \fBusername mapping\f1\f1 is specified. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB{PROVIDED_USER}\f1 +.IP \(bu 4 Substitutes the supplied username, i.e. before either -authentication or \fBLDAP transformation\fP\&. -.sp -New in version 4.2. -T} -_ -.TE -.sp +authentication or \fBLDAP transformation\f1\f1\&. +.RE +.RE +.PP When constructing the query URL, ensure that the order of LDAP parameters respects RFC4516: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -[ dn [ ? [attributes] [ ? [scope] [ ? [filter] [ ? [Extensions] ] ] ] ] ] -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -If your query includes an attribute, \fBmongod\fP assumes that the query +.PP +.EX + [ dn [ ? [attributes] [ ? [scope] [ ? [filter] [ ? [Extensions] ] ] ] ] ] +.EE +.PP +If your query includes an attribute, \fBmongod\f1\f1 assumes that the query retrieves a the DNs which this entity is member of. -.sp -If your query does not include an attribute, \fBmongod\fP assumes +.PP +If your query does not include an attribute, \fBmongod\f1\f1 assumes the query retrieves all entities which the user is member of. -.sp -For each LDAP DN returned by the query, \fBmongod\fP assigns the authorized -user a corresponding role on the \fBadmin\fP database. If a role on the on the -\fBadmin\fP database exactly matches the DN, \fBmongod\fP grants the user the +.PP +For each LDAP DN returned by the query, \fBmongod\f1\f1 assigns the authorized +user a corresponding role on the \fBadmin\f1 database. If a role on the on the +\fBadmin\f1 database exactly matches the DN, \fBmongod\f1\f1 grants the user the roles and privileges assigned to that role. See the -\fBdb.createRole()\fP method for more information on creating roles. -.INDENT 7.0 -.INDENT 3.5 -.SS Example -.sp +\fBdb.createRole()\f1\f1 method for more information on creating roles. +.PP This LDAP query returns any groups listed in the LDAP user object\(aqs -\fBmemberOf\fP attribute. -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -"{USER}?memberOf?base" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Your LDAP configuration may not include the \fBmemberOf\fP attribute as part +\fBmemberOf\f1 attribute. +.PP +.EX + "{USER}?memberOf?base" +.EE +.PP +Your LDAP configuration may not include the \fBmemberOf\f1 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. -.UNINDENT -.UNINDENT -.sp -If unset, \fBmongod\fP cannot authorize users using LDAP. -.sp -This setting can be configured on a running \fBmongod\fP using the -\fBsetParameter\fP database command. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -An explanation of \fI\%RFC4515\fP, -\fI\%RFC4516\fP or LDAP queries is out +.PP +If unset, \fBmongod\f1\f1 cannot authorize users using LDAP. +.PP +This setting can be configured on a running \fBmongod\f1\f1 using the +\fBsetParameter\f1\f1 database command. +.PP +An explanation of RFC4515 (https://tools.ietf.org/search/rfc4515), +RFC4516 (https://tools.ietf.org/html/rfc4516) or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Storage Options -.INDENT 0.0 -.TP -.B \-\-storageEngine string -\fIDefault\fP: \fBwiredTiger\fP -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +.RE +.SS STORAGE OPTIONS +.PP +\fBmongod \-\-storageEngine\f1 +.RS +.PP +\fIDefault\f1: \fBwiredTiger\f1 +.PP Starting in version 4.2, MongoDB removes the deprecated MMAPv1 storage engine. -.UNINDENT -.UNINDENT -.sp -Specifies the storage engine for the \fBmongod\fP database. Available +.PP +Specifies the storage engine for the \fBmongod\f1\f1 database. Available values include: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBwiredTiger\fP -T} T{ -To specify the /core/wiredtiger\&. -T} -_ -T{ -\fBinMemory\fP -T} T{ -To specify the /core/inmemory\&. -.sp -New in version 3.2: Available in MongoDB Enterprise only. -T} -_ -.TE -.sp -If you attempt to start a \fBmongod\fP with a -\fI\%\-\-dbpath\fP that contains data files produced by a -storage engine other than the one specified by \fI\%\-\-storageEngine\fP, \fBmongod\fP +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBwiredTiger\f1 +.IP \(bu 4 +To specify the \fBWiredTiger Storage Engine\f1\&. +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBinMemory\f1 +.IP \(bu 4 +To specify the \fBIn\-Memory Storage Engine\f1\&. +.IP +Available in MongoDB Enterprise only. +.RE +.RE +.PP +If you attempt to start a \fBmongod\f1\f1 with a +\fB\-\-dbpath\f1\f1 that contains data files produced by a +storage engine other than the one specified by \fB\-\-storageEngine\f1\f1, \fBmongod\f1\f1 will refuse to start. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-dbpath -\fIDefault\fP: \fB/data/db\fP on Linux and macOS, \fB\edata\edb\fP on Windows -.sp -The directory where the \fBmongod\fP instance stores its data. -.sp +.RE +.PP +\fBmongod \-\-dbpath\f1 +.RS +.PP +\fIDefault\f1: \fB/data/db\f1 on Linux and macOS, \fB\data\db\f1 on Windows +.PP +The directory where the \fBmongod\f1\f1 instance stores its data. +.PP If using the default -configuration file +\fBconfiguration file\f1 included with a package manager installation of MongoDB, the -corresponding \fBstorage.dbPath\fP setting uses a different +corresponding \fBstorage.dbPath\f1\f1 setting uses a different default. -.sp -The files in \fI\%\-\-dbpath\fP must correspond to the storage engine -specified in \fI\%\-\-storageEngine\fP\&. If the data files do not -correspond to \fI\%\-\-storageEngine\fP, \fBmongod\fP will refuse to +.PP +The files in \fB\-\-dbpath\f1\f1 must correspond to the storage engine +specified in \fB\-\-storageEngine\f1\f1\&. If the data files do not +correspond to \fB\-\-storageEngine\f1\f1, \fBmongod\f1\f1 will refuse to start. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-directoryperdb +.RE +.PP +\fBmongod \-\-directoryperdb\f1 +.RS +.PP Uses a separate directory to store data for each database. The -directories are under the \fI\%\-\-dbpath\fP directory, and each subdirectory +directories are under the \fB\-\-dbpath\f1\f1 directory, and each subdirectory name corresponds to the database name. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.sp -To change the \fI\%\-\-directoryperdb\fP option for existing +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.PP +Starting in MongoDB 5.0, dropping the final collection in a database +(or dropping the database itself) when \fB\-\-directoryperdb\f1\f1 is +enabled deletes the newly empty subdirectory for that database. +.PP +To change the \fB\-\-directoryperdb\f1\f1 option for existing deployments: -.INDENT 7.0 +.RS .IP \(bu 2 For standalone instances: -.INDENT 2.0 -.IP 1. 3 -Use \fI\%mongodump\fP on the existing -\fI\%mongod\fP instance to generate a backup. -.IP 2. 3 -Stop the \fI\%mongod\fP instance. -.IP 3. 3 -Add the \fI\%\-\-directoryperdb\fP value \fBand\fP +.RS +.IP \(bu 4 +Use \fBmongodump\f1\f1 on the existing +\fBmongod\f1\f1 instance to generate a backup. +.IP \(bu 4 +Stop the \fBmongod\f1\f1 instance. +.IP \(bu 4 +Add the \fB\-\-directoryperdb\f1\f1 value \fBand\f1 configure a new data directory -.IP 4. 3 -Restart the \fI\%mongod\fP instance. -.IP 5. 3 -Use \fI\%mongorestore\fP to populate the new data +.IP \(bu 4 +Restart the \fBmongod\f1\f1 instance. +.IP \(bu 4 +Use \fBmongorestore\f1\f1 to populate the new data directory. -.UNINDENT +.RE .IP \(bu 2 For replica sets: -.INDENT 2.0 -.IP 1. 3 +.RS +.IP \(bu 4 Stop a secondary member. -.IP 2. 3 -Add the \fI\%\-\-directoryperdb\fP value \fBand\fP +.IP \(bu 4 +Add the \fB\-\-directoryperdb\f1\f1 value \fBand\f1 configure a new data directory to that secondary member. -.IP 3. 3 +.IP \(bu 4 Restart that secondary. -.IP 4. 3 -Use initial sync to populate +.IP \(bu 4 +Use \fBinitial sync\f1 to populate the new data directory. -.IP 5. 3 +.IP \(bu 4 Update remaining secondaries in the same fashion. -.IP 6. 3 +.IP \(bu 4 Step down the primary, and update the stepped\-down member in the same fashion. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-syncdelay -\fIDefault\fP: 60 -.sp +.RE +.RE +.RE +.PP +\fBmongod \-\-syncdelay\f1 +.RS +.PP +\fIDefault\f1: 60 +.PP Controls how much time can pass before MongoDB flushes data to the data -files via an fsync operation. -.sp +files via an \fBfsync\f1 operation. +.PP \fBDo not set this value on -production systems.\fP In almost every situation, you should use the +production systems.\f1 In almost every situation, you should use the default setting. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -If you set \fI\%\-\-syncdelay\fP to \fB0\fP, MongoDB will not sync the +.PP +If you set \fB\-\-syncdelay\f1\f1 to \fB0\f1, MongoDB will not sync the memory mapped files to disk. -.UNINDENT -.UNINDENT -.sp -The \fBmongod\fP process writes data very quickly to the journal and -lazily to the data files. \fI\%\-\-syncdelay\fP has no effect on the -\fBjournal\fP files or journaling, -but if \fI\%\-\-syncdelay\fP is set to \fB0\fP the journal will eventually consume -all available disk space. If you set \fI\%\-\-syncdelay\fP to \fB0\fP for testing -purposes, you should also set \fI\%\-\-nojournal\fP -to \fBtrue\fP\&. -.sp -The \fBserverStatus\fP command reports the background flush -thread\(aqs status via the \fBbackgroundFlushing\fP field. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-upgrade +.PP +The \fBmongod\f1\f1 process writes data very quickly to the journal and +lazily to the data files. \fB\-\-syncdelay\f1\f1 has no effect on the +\fBjournal\f1\f1 files or \fBjournaling\f1, +but if \fB\-\-syncdelay\f1\f1 is set to \fB0\f1 the journal will eventually consume +all available disk space. If you set \fB\-\-syncdelay\f1\f1 to \fB0\f1 for testing +purposes, you should also set \fB\-\-nojournal\f1\f1 +to \fBtrue\f1\&. +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.RE +.PP +\fBmongod \-\-upgrade\f1 +.RS +.PP Upgrades the on\-disk data format of the files specified by the -\fI\%\-\-dbpath\fP to the latest version, if needed. -.sp -This option only affects the operation of the \fBmongod\fP if the data +\fB\-\-dbpath\f1\f1 to the latest version, if needed. +.PP +This option only affects the operation of the \fBmongod\f1\f1 if the data files are in an old format. -.sp +.PP In most cases you should not set this value, so you can exercise the most control over your upgrade process. See the MongoDB release notes for more information about the upgrade process. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-repair -Changed in version 4.0.3. - -.sp -Runs a repair routine on all databases for a \fI\%mongod\fP -instance. The operation attempts to salvage corrupt data as well as -rebuilds all the indexes. The operation discards any corrupt data -that cannot be salvaged. -.INDENT 7.0 -.INDENT 3.5 -.SS Tip -.sp -If you are running with journaling enabled, there is +.RE +.PP +\fBmongod \-\-repair\f1 +.RS +.PP +Runs a repair routine on all databases for a \fBmongod\f1\f1 +instance. +.PP +Starting in MongoDB 5.0: +.RS +.IP \(bu 2 +The repair operation validates the collections to find any +inconsistencies and fixes them if possible, which avoids +rebuilding the indexes. +.IP \(bu 2 +If a collection\(aqs data file is salvaged or if the collection has +inconsistencies that the validate step is unable to fix, then all +indexes are rebuilt. +.RE +.PP +In MongoDB 4.4 and previous versions, the repair operation attempts +to: +.RS +.IP \(bu 2 +Salvage corrupt data. The operation discards any corrupt +data that cannot be salvaged. +.IP \(bu 2 +Rebuild indexes. The operation validates collections and rebuilds +all indexes for collections with inconsistencies between the +collection data and one or more indexes. The operation also +rebuilds indexes for all salvaged and modified collections. +(\fIChanged in version 4.4.\f1) +.RE +.PP +If you are running with \fBjournaling\f1 enabled, there is almost never any need to run repair since the server can use the journal files to restore the data files to a clean state automatically. However, you may need to run repair in cases where you need to recover from a disk\-level data corruption. -.UNINDENT -.UNINDENT -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -.INDENT 0.0 +.RS .IP \(bu 2 -Only use \fI\%mongod \-\-repair\fP if you have no other options. +Only use \fBmongod \-\-repair\f1\f1 if you have no other options. The operation removes and does not save any corrupt data during the repair process. .IP \(bu 2 -Avoid running \fI\%\-\-repair\fP against +Avoid running \fB\-\-repair\f1\f1 against a replica set member: -.INDENT 2.0 -.IP \(bu 2 -To repair a replica set member, if you have an intact +.RS +.IP \(bu 4 +To repair a \fBreplica set\f1 member, if you have an intact copy of your data available (e.g. a recent backup or an intact -member of the replica set), restore from that intact -copy instead(see /tutorial/resync\-replica\-set\-member). -.IP \(bu 2 -If you do choose to run \fI\%mongod \-\-repair\fP against a +member of the \fBreplica set\f1), restore from that intact +copy instead(see \fBResync a Member of a Replica Set\f1). +.IP \(bu 4 +If you do choose to run \fBmongod \-\-repair\f1\f1 against a replica set member and the operation modifies the data or the metadata, you must still perform a full resync in order for the member to rejoin the replica set. -.UNINDENT +.RE .IP \(bu 2 -Before using \fI\%\-\-repair\fP, make a backup -copy of the \fI\%dbpath\fP directory. +Before using \fB\-\-repair\f1\f1, make a backup +copy of the \fBdbpath\f1\f1 directory. .IP \(bu 2 If repair fails to complete for any reason, you must restart the -instance using the \fI\%\-\-repair\fP option. -.UNINDENT -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-journal -Enables the durability journal to ensure data files remain valid +instance using the \fB\-\-repair\f1\f1 option. +.RE +.RE +.PP +\fBmongod \-\-journal\f1 +.RS +.PP +Enables the durability \fBjournal\f1 to ensure data files remain valid and recoverable. This option applies only when you specify the -\fI\%\-\-dbpath\fP option. \fBmongod\fP enables journaling by default. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.sp -If any voting member of a replica set uses the in\-memory -storage engine, you must set -\fBwriteConcernMajorityJournalDefault\fP to \fBfalse\fP\&. -.sp +\fB\-\-dbpath\f1\f1 option. \fBmongod\f1\f1 enables journaling by default. +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.PP +If any voting member of a replica set uses the \fBin\-memory +storage engine\f1, you must set +\fBwriteConcernMajorityJournalDefault\f1\f1 to \fBfalse\f1\&. +.PP Starting in version 4.2 (and 4.0.13 and 3.6.14 ), if a replica set -member uses the in\-memory storage engine +member uses the \fBin\-memory storage engine\f1 (voting or non\-voting) but the replica set has -\fBwriteConcernMajorityJournalDefault\fP set to true, the +\fBwriteConcernMajorityJournalDefault\f1\f1 set to true, the replica set member logs a startup warning. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-nojournal -Disables journaling\&. \fBmongod\fP +.RE +.PP +\fBmongod \-\-nojournal\f1 +.RS +.PP +Disables \fBjournaling\f1\&. \fBmongod\f1\f1 enables journaling by default. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.sp -Starting in MongoDB 4.0, you cannot specify \fI\%\-\-nojournal\fP option or \fBstorage.journal.enabled: -false\fP for replica set members that use the +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.PP +Starting in MongoDB 4.0, you cannot specify \fB\-\-nojournal\f1\f1 option or \fBstorage.journal.enabled: +false\f1\f1 for replica set members that use the WiredTiger storage engine. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-journalCommitInterval -\fIDefault\fP: 100 -.sp +.RE +.PP +\fBmongod \-\-journalCommitInterval\f1 +.RS +.PP +\fIDefault\f1: 100 +.PP The maximum amount of time in milliseconds that -the \fBmongod\fP process allows between +the \fBmongod\f1\f1 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. -.sp +.PP On WiredTiger, the default journal commit interval is 100 milliseconds. Additionally, a write that includes or implies -\fBj:true\fP will cause an immediate sync of the journal. For details +\fBj:true\f1 will cause an immediate sync of the journal. For details or additional conditions that affect the frequency of the sync, see -journal\-process\&. -.sp -Not available for \fI\%mongod\fP instances that use the -in\-memory storage engine\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Known Issue in 4.2.0: The \fI\%\-\-journalCommitInterval\fP is missing in 4.2.0. -.UNINDENT -.UNINDENT -.UNINDENT -.SS WiredTiger Options -.INDENT 0.0 -.TP -.B \-\-wiredTigerCacheSizeGB +\fBJournaling Process\f1\&. +.PP +Not available for \fBmongod\f1\f1 instances that use the +\fBin\-memory storage engine\f1\&. +.PP +Known Issue in 4.2.0: The \fB\-\-journalCommitInterval\f1\f1 is missing in 4.2.0. +.RE +.SS WIREDTIGER OPTIONS +.PP +\fBmongod \-\-wiredTigerCacheSizeGB\f1 +.RS +.PP Defines the maximum size of the internal cache that WiredTiger will use for all data. The memory consumed by an index build (see -\fBmaxIndexBuildMemoryUsageMegabytes\fP) is separate from the +\fBmaxIndexBuildMemoryUsageMegabytes\f1\f1) is separate from the WiredTiger cache memory. -.sp -Values can range from \fB0.25\fP GB to \fB10000\fP GB. -.sp +.PP +Values can range from \fB0.25\f1 GB to \fB10000\f1 GB. +.PP Starting in MongoDB 3.4, the default WiredTiger internal cache size is the larger of either: -.INDENT 7.0 +.RS .IP \(bu 2 50% of (RAM \- 1 GB), or .IP \(bu 2 256 MB. -.UNINDENT -.sp +.RE +.PP For example, on a system with a total of 4GB of RAM the WiredTiger -cache will use 1.5GB of RAM (\fB0.5 * (4 GB \- 1 GB) = 1.5 GB\fP). +cache will use 1.5GB of RAM (\fB0.5 * (4 GB \- 1 GB) = 1.5 GB\f1). Conversely, a system with a total of 1.25 GB of RAM will allocate 256 MB to the WiredTiger cache because that is more than half of the -total RAM minus one gigabyte (\fB0.5 * (1.25 GB \- 1 GB) = 128 MB < 256 MB\fP). -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +total RAM minus one gigabyte (\fB0.5 * (1.25 GB \- 1 GB) = 128 MB < 256 MB\f1). +.PP 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. -.sp -To see the memory limit, see \fBhostInfo.system.memLimitMB\fP\&. -.UNINDENT -.UNINDENT -.sp +.PP +To see the memory limit, see \fBhostInfo.system.memLimitMB\f1\f1\&. +.PP Avoid increasing the WiredTiger internal cache size above its default value. -.sp +.PP With WiredTiger, MongoDB utilizes both the WiredTiger internal cache and the filesystem cache. -.sp +.PP Via the filesystem cache, MongoDB automatically uses all free memory that is not used by the WiredTiger cache or by other processes. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%\-\-wiredTigerCacheSizeGB\fP limits the size of the WiredTiger internal +.PP +The \fB\-\-wiredTigerCacheSizeGB\f1\f1 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. -.sp +.PP To accommodate the additional consumers of RAM, you may have to decrease WiredTiger internal cache size. -.UNINDENT -.UNINDENT -.sp +.PP The default WiredTiger internal cache size value assumes that there is a -single \fI\%mongod\fP instance per machine. If a single machine +single \fBmongod\f1\f1 instance per machine. If a single machine contains multiple MongoDB instances, then you should decrease the setting to -accommodate the other \fI\%mongod\fP +accommodate the other \fBmongod\f1\f1 instances. -.sp -If you run \fI\%mongod\fP in a container (e.g. \fBlxc\fP, -\fBcgroups\fP, Docker, etc.) that does \fInot\fP have access to all of the -RAM available in a system, you must set \fI\%\-\-wiredTigerCacheSizeGB\fP to a value +.PP +If you run \fBmongod\f1\f1 in a container (e.g. \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\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerMaxCacheOverflowFileSizeGB -.INDENT 7.0 -.INDENT 3.5 -.IP "Deprecated in MongoDB 4.4" -.sp -MongoDB deprecates the \fB\-\-wiredTigerMaxCacheOverflowFileSizeGB\fP +\fBmemLimitMB\f1\f1\&. +.RE +.PP +\fBmongod \-\-wiredTigerMaxCacheOverflowFileSizeGB\f1 +.RS +.PP +MongoDB deprecates the \fB\-\-wiredTigerMaxCacheOverflowFileSizeGB\f1 option. The option has no effect starting in MongoDB 4.4. -.UNINDENT -.UNINDENT -.sp +.PP Specifies the maximum size (in GB) for the "lookaside (or cache -overflow) table" file \fBWiredTigerLAS.wt\fP for MongoDB +overflow) table" file WiredTigerLAS.wt for MongoDB 4.2.1\-4.2.x and 4.0.12\-4.0.x. The file no longer exists starting in version 4.4. -.sp +.PP The setting can accept the following values: -.TS -center; -|l|l|. -_ -T{ +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fB0\fP -T} T{ -The default value. If set to \fB0\fP, the file size is +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fB0\f1 +.IP \(bu 4 +The default value. If set to \fB0\f1, the file size is unbounded. -T} -_ -T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 number >= 0.1 -T} T{ -The maximum size (in GB). If the \fBWiredTigerLAS.wt\fP -file exceeds this size, \fI\%mongod\fP exits with a -fatal assertion. You can clear the \fBWiredTigerLAS.wt\fP -file and restart \fI\%mongod\fP\&. -T} -_ -.TE -.sp +.IP \(bu 4 +The maximum size (in GB). If the WiredTigerLAS.wt +file exceeds this size, \fBmongod\f1\f1 exits with a +fatal assertion. You can clear the WiredTigerLAS.wt +file and restart \fBmongod\f1\f1\&. +.RE +.RE +.PP To change the maximum size during runtime, use the -\fBwiredTigerMaxCacheOverflowSizeGB\fP parameter. -.sp -\fIAvailable starting in MongoDB 4.2.1 (and 4.0.12)\fP -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerJournalCompressor -\fIDefault\fP: snappy -.sp +\fBwiredTigerMaxCacheOverflowSizeGB\f1\f1 parameter. +.PP +\fIAvailable starting in MongoDB 4.2.1 (and 4.0.12)\f1 +.RE +.PP +\fBmongod \-\-wiredTigerJournalCompressor\f1 +.RS +.PP +\fIDefault\f1: snappy +.PP Specifies the type of compression to use to compress WiredTiger journal data. -.sp +.PP Available compressors are: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBnone\fP +\fBnone\f1 .IP \(bu 2 -snappy +\fBsnappy\f1 .IP \(bu 2 -zlib +\fBzlib\f1 .IP \(bu 2 -zstd (Available starting in MongoDB 4.2) -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerDirectoryForIndexes -When you start \fBmongod\fP with \fI\%\-\-wiredTigerDirectoryForIndexes\fP, \fBmongod\fP stores indexes and collections in separate -subdirectories under the data (i.e. \fI\%\-\-dbpath\fP) directory. -Specifically, \fBmongod\fP stores the indexes in a subdirectory named -\fBindex\fP and the collection data in a subdirectory named -\fBcollection\fP\&. -.sp +\fBzstd\f1 (Available starting in MongoDB 4.2) +.RE +.RE +.PP +\fBmongod \-\-wiredTigerDirectoryForIndexes\f1 +.RS +.PP +When you start \fBmongod\f1\f1 with \fB\-\-wiredTigerDirectoryForIndexes\f1\f1, \fBmongod\f1\f1 stores indexes and collections in separate +subdirectories under the data (i.e. \fB\-\-dbpath\f1\f1) directory. +Specifically, \fBmongod\f1\f1 stores the indexes in a subdirectory named +\fBindex\f1 and the collection data in a subdirectory named +\fBcollection\f1\&. +.PP By using a symbolic link, you can specify a different location for -the indexes. Specifically, when \fI\%mongod\fP instance is \fBnot\fP -running, move the \fBindex\fP subdirectory to the destination and -create a symbolic link named \fBindex\fP under the data directory to +the indexes. Specifically, when \fBmongod\f1\f1 instance is \fBnot\f1 +running, move the \fBindex\f1 subdirectory to the destination and +create a symbolic link named \fBindex\f1 under the data directory to the new destination. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerCollectionBlockCompressor -\fIDefault\fP: snappy -.sp +.RE +.PP +\fBmongod \-\-wiredTigerCollectionBlockCompressor\f1 +.RS +.PP +\fIDefault\f1: snappy +.PP Specifies the default compression for collection data. You can override this on a per\-collection basis when creating collections. -.sp +.PP Available compressors are: -.INDENT 7.0 +.RS .IP \(bu 2 -\fBnone\fP +\fBnone\f1 .IP \(bu 2 -snappy +\fBsnappy\f1 .IP \(bu 2 -zlib +\fBzlib\f1 .IP \(bu 2 -zstd (Available starting MongoDB 4.2) -.UNINDENT -.sp -\fI\%\-\-wiredTigerCollectionBlockCompressor\fP affects all collections created. If you change -the value of \fI\%\-\-wiredTigerCollectionBlockCompressor\fP on an existing MongoDB deployment, all new +\fBzstd\f1 (Available starting MongoDB 4.2) +.RE +.PP +\fB\-\-wiredTigerCollectionBlockCompressor\f1\f1 affects all collections created. If you change +the value of \fB\-\-wiredTigerCollectionBlockCompressor\f1\f1 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. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-wiredTigerIndexPrefixCompression -\fIDefault\fP: true -.sp -Enables or disables prefix compression for index data. -.sp -Specify \fBtrue\fP for \fI\%\-\-wiredTigerIndexPrefixCompression\fP to enable prefix compression for -index data, or \fBfalse\fP to disable prefix compression for index data. -.sp -The \fI\%\-\-wiredTigerIndexPrefixCompression\fP setting affects all indexes created. If you change -the value of \fI\%\-\-wiredTigerIndexPrefixCompression\fP on an existing MongoDB deployment, all new +.RE +.PP +\fBmongod \-\-wiredTigerIndexPrefixCompression\f1 +.RS +.PP +\fIDefault\f1: true +.PP +Enables or disables \fBprefix compression\f1 for index data. +.PP +Specify \fBtrue\f1 for \fB\-\-wiredTigerIndexPrefixCompression\f1\f1 to enable \fBprefix compression\f1 for +index data, or \fBfalse\f1 to disable prefix compression for index data. +.PP +The \fB\-\-wiredTigerIndexPrefixCompression\f1\f1 setting affects all indexes created. If you change +the value of \fB\-\-wiredTigerIndexPrefixCompression\f1\f1 on an existing MongoDB deployment, all new indexes will use prefix compression. Existing indexes are not affected. -.UNINDENT -.SS Replication Options -.INDENT 0.0 -.TP -.B \-\-replSet +.RE +.SS REPLICATION OPTIONS +.PP +\fBmongod \-\-replSet\f1 +.RS +.PP Configures replication. Specify a replica set name as an argument to this set. All hosts in the replica set must have the same set name. -.sp +.PP Starting in MongoDB 4.0, -.INDENT 7.0 +.RS .IP \(bu 2 -For the WiredTiger storage engine, \fI\%\-\-replSet\fP cannot be used in -conjunction with \fI\%\-\-nojournal\fP\&. -.UNINDENT -.sp -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. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-oplogSize +For the WiredTiger storage engine, \fB\-\-replSet\f1\f1 cannot be used in +conjunction with \fB\-\-nojournal\f1\f1\&. +.RE +.PP +If your application connects to more than one replica set, each set must +have a distinct name. Some drivers group replica set connections by +replica set name. +.RE +.PP +\fBmongod \-\-oplogSize\f1 +.RS +.PP Specifies a maximum size in megabytes for the replication operation log -(i.e., the oplog). -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 +(i.e., the \fBoplog\f1). +.PP Starting in MongoDB 4.0, the oplog can grow past its configured size -limit to avoid deleting the \fBmajority commit point\fP\&. -.UNINDENT -.UNINDENT -.sp -By default, the \fBmongod\fP process creates an oplog based on +limit to avoid deleting the \fBmajority commit point\f1\f1\&. +.PP +By default, the \fBmongod\f1\f1 process creates an \fBoplog\f1 based on the maximum amount of space available. For 64\-bit systems, the oplog is typically 5% of available disk space. -.sp -Once the \fBmongod\fP has created the oplog for the first time, -changing the \fI\%\-\-oplogSize\fP option will not affect the size of +.PP +Once the \fBmongod\f1\f1 has created the oplog for the first time, +changing the \fB\-\-oplogSize\f1\f1 option will not affect the size of the oplog. To change the minimum oplog retention period after -starting the \fI\%mongod\fP, use -\fBreplSetResizeOplog\fP\&. \fBreplSetResizeOplog\fP +starting the \fBmongod\f1\f1, use +\fBreplSetResizeOplog\f1\f1\&. \fBreplSetResizeOplog\f1\f1 enables you to resize the oplog dynamically without restarting the -\fI\%mongod\fP process. To persist the changes made using -\fBreplSetResizeOplog\fP through a restart, update the value -of \fI\%\-\-oplogSize\fP\&. -.sp -See replica\-set\-oplog\-sizing for more information. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-oplogMinRetentionHours -New in version 4.4: Specifies the minimum number of hours to preserve an oplog entry, +\fBmongod\f1\f1 process. To persist the changes made using +\fBreplSetResizeOplog\f1\f1 through a restart, update the value +of \fB\-\-oplogSize\f1\f1\&. +.PP +See \fBOplog Size\f1 for more information. +.RE +.PP +\fBmongod \-\-oplogMinRetentionHours\f1 +.RS +.PP +Specifies the minimum number of hours to preserve an oplog entry, where the decimal values represent the fractions of an hour. For -example, a value of \fB1.5\fP represents one hour and thirty +example, a value of \fB1.5\f1 represents one hour and thirty minutes. -.sp -The value must be greater than or equal to \fB0\fP\&. A value of \fB0\fP -indicates that the \fI\%mongod\fP should truncate the oplog +.PP +The value must be greater than or equal to \fB0\f1\&. A value of \fB0\f1 +indicates that the \fBmongod\f1\f1 should truncate the oplog starting with the oldest entries to maintain the configured maximum oplog size. - -.sp -Defaults to \fB0\fP\&. -.sp -A \fI\%mongod\fP started with \fB\-\-oplogMinRetentionHours\fP -only removes an oplog entry \fIif\fP: -.INDENT 7.0 +.PP +Defaults to \fB0\f1\&. +.PP +A \fBmongod\f1\f1 started with \fB\-\-oplogMinRetentionHours\f1 +only removes an oplog entry \fIif\f1: +.RS .IP \(bu 2 -The oplog has reached the maximum configured oplog size \fIand\fP +The oplog has reached the maximum configured oplog size \fIand\f1 .IP \(bu 2 The oplog entry is older than the configured number of hours based on the host system clock. -.UNINDENT -.sp -The \fI\%mongod\fP has the following behavior when configured +.RE +.PP +The \fBmongod\f1\f1 has the following behavior when configured with a minimum oplog retention period: -.INDENT 7.0 +.RS .IP \(bu 2 The oplog can grow without constraint so as to retain oplog entries for the configured number of hours. This may result in reduction or @@ -2250,2138 +1981,1860 @@ exhaustion of system disk space due to a combination of high write volume and large retention period. .IP \(bu 2 If the oplog grows beyond its maximum size, the -\fI\%mongod\fP may continue to hold that disk space even if -the oplog returns to its maximum size \fIor\fP is configured for a -smaller maximum size. See replSetResizeOplog\-cmd\-compact\&. +\fBmongod\f1\f1 may continue to hold that disk space even if +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\&. .IP \(bu 2 -The \fI\%mongod\fP compares the system wall clock to an +The \fBmongod\f1\f1 compares the system wall clock to an oplog entries creation wall clock time when enforcing oplog entry retention. Clock drift between cluster components may result in unexpected oplog retention behavior. See -production\-notes\-clock\-synchronization for more information on +\fBClock Synchronization\f1 for more information on clock synchronization across cluster members. -.UNINDENT -.sp +.RE +.PP To change the minimum oplog retention period after starting the -\fI\%mongod\fP, use \fBreplSetResizeOplog\fP\&. -\fBreplSetResizeOplog\fP enables you to resize the oplog -dynamically without restarting the \fI\%mongod\fP process. To -persist the changes made using \fBreplSetResizeOplog\fP +\fBmongod\f1\f1, use \fBreplSetResizeOplog\f1\f1\&. +\fBreplSetResizeOplog\f1\f1 enables you to resize the oplog +dynamically without restarting the \fBmongod\f1\f1 process. To +persist the changes made using \fBreplSetResizeOplog\f1\f1 through a restart, update the value of -\fI\%\-\-oplogMinRetentionHours\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-enableMajorityReadConcern -\fIDefault\fP: true -.sp -Starting in MongoDB 3.6, MongoDB enables support for -\fB"majority"\fP read concern by default. -.sp -You can disable read concern \fB"majority"\fP 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 \fB"majority"\fP, -see disable\-read\-concern\-majority\&. -.sp -To disable, set \fI\%\-\-enableMajorityReadConcern\fP to false. \fI\%\-\-enableMajorityReadConcern\fP has no effect for -MongoDB versions: 4.0.0, 4.0.1, 4.0.2, 3.6.0. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -In general, avoid disabling \fB"majority"\fP 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 a three\-member PSA shards, disable to prevent the -storage cache pressure from immobilizing the deployment. -.sp -Disabling \fB"majority"\fP read concern affects support for -transactions on sharded clusters. Specifically: -.INDENT 0.0 -.IP \(bu 2 -A transaction cannot use read concern \fB"snapshot"\fP if -the transaction involves a shard that has disabled read -concern "majority"\&. -.IP \(bu 2 -A transaction that writes to multiple shards errors if any of the -transaction\(aqs read or write operations involves a shard that has -disabled read concern \fB"majority"\fP\&. -.UNINDENT -.sp -However, it does not affect transactions -on replica sets. For transactions on replica sets, you can specify -read concern \fB"majority"\fP (or \fB"snapshot"\fP -or \fB"local"\fP ) for multi\-document transactions even if -read concern \fB"majority"\fP is disabled. -.sp -Disabling \fB"majority"\fP read concern disables support -for /changeStreams for MongoDB 4.0 and earlier. For MongoDB -4.2+, disabling read concern \fB"majority"\fP has no effect on change -streams availability. -.UNINDENT -.UNINDENT -.UNINDENT -.SS Sharded Cluster Options -.INDENT 0.0 -.TP -.B \-\-configsvr -\fIRequired if starting a config server.\fP -.sp -Declares that this \fBmongod\fP instance serves as the config -server of a sharded cluster. When +\fB\-\-oplogMinRetentionHours\f1\f1\&. +.RE +.PP +\fBmongod \-\-enableMajorityReadConcern\f1 +.RS +.PP +\fIDefault\f1: true +.PP +Configures support for \fB"majority"\f1\f1 read concern. +.PP +Starting in MongoDB 5.0, +\fB\-\-enableMajorityReadConcern\f1\f1 cannot be changed +and is always set to \fBtrue\f1\&. In earlier versions of MongoDB, +\fB\-\-enableMajorityReadConcern\f1\f1 was configurable. +.PP +If you are using a three\-member primary\-secondary\-arbiter (PSA) +architecture, the write concern \fB"majority"\f1\f1 can cause +performance issues if a secondary is unavailable or lagging. See +\fBMitigate Performance Issues with PSA Replica Set\f1 for advice on how to mitigate these +issues. +.RE +.SS SHARDED CLUSTER OPTIONS +.PP +\fBmongod \-\-configsvr\f1 +.RS +.PP +\fIRequired if starting a config server.\f1 +.PP +Declares that this \fBmongod\f1\f1 instance serves as the \fBconfig +server\f1 of a sharded cluster. When running with this option, clients (i.e. other cluster components) -cannot write data to any database other than \fBconfig\fP -and \fBadmin\fP\&. The default port for a \fBmongod\fP with this option is -\fB27019\fP and the default \fI\%\-\-dbpath\fP directory is -\fB/data/configdb\fP, unless specified. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in 3.4, you must deploy config servers as a replica set. -The use of the deprecated mirrored \fI\%mongod\fP instances as +cannot write data to any database other than \fBconfig\f1 +and \fBadmin\f1\&. The default port for a \fBmongod\f1\f1 with this option is +\fB27019\f1 and the default \fB\-\-dbpath\f1\f1 directory is +\fB/data/configdb\f1, unless specified. +.PP +When starting a MongoDB server with \fB\-\-configsvr\f1, you must also +specify a \fB\-\-replSet\f1\f1\&. +.PP +The use of the deprecated mirrored \fBmongod\f1\f1 instances as config servers (SCCC) is no longer supported. -.sp +.PP The replica set config servers (CSRS) must run the -WiredTiger storage engine\&. -.UNINDENT -.UNINDENT -.sp -The \fI\%\-\-configsvr\fP option creates a local oplog\&. -.sp -Do not use the \fI\%\-\-configsvr\fP option with \fI\%\-\-shardsvr\fP\&. Config +\fBWiredTiger storage engine\f1\&. +.PP +The \fB\-\-configsvr\f1\f1 option creates a local \fBoplog\f1\&. +.PP +Do not use the \fB\-\-configsvr\f1\f1 option with \fB\-\-shardsvr\f1\f1\&. Config servers cannot be a shard server. -.sp -Do not use the \fI\%\-\-configsvr\fP with the -\fBskipShardingConfigurationChecks\fP parameter. That is, if -you are temporarily starting the \fI\%mongod\fP as a +.PP +Do not use the \fB\-\-configsvr\f1\f1 with the +\fBskipShardingConfigurationChecks\f1\f1 parameter. That is, if +you are temporarily starting the \fBmongod\f1\f1 as a standalone for maintenance operations, include the parameter -\fBskipShardingConfigurationChecks\fP and exclude \fI\%\-\-configsvr\fP\&. +\fBskipShardingConfigurationChecks\f1\f1 and exclude \fB\-\-configsvr\f1\f1\&. Once maintenance has completed, remove the -\fBskipShardingConfigurationChecks\fP parameter and restart -with \fI\%\-\-configsvr\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-configsvrMode -\fBAvailable in MongoDB 3.2 version only\fP -.sp -If set to \fBsccc\fP, indicates that the config servers are deployed -as three mirrored \fI\%mongod\fP instances, even if one or more -config servers is also a member of a replica set. \fBconfigsvrMode\fP -only accepts the value \fBsccc\fP\&. -.sp +\fBskipShardingConfigurationChecks\f1\f1 parameter and restart +with \fB\-\-configsvr\f1\f1\&. +.RE +.PP +\fBmongod \-\-configsvrMode\f1 +.RS +.PP +\fBAvailable in MongoDB 3.2 version only\f1 +.PP +If set to \fBsccc\f1, indicates that the config servers are deployed +as three mirrored \fBmongod\f1\f1 instances, even if one or more +config servers is also a member of a replica set. \fBconfigsvrMode\f1 +only accepts the value \fBsccc\f1\&. +.PP If unset, config servers running as replica sets expect to use the "config server replica set" protocol for writing to config servers, rather than the "mirrored mongod" write protocol. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-shardsvr -\fIRequired if starting a shard server.\fP -.sp -Configures this \fBmongod\fP instance as a shard in a +.RE +.PP +\fBmongod \-\-shardsvr\f1 +.RS +.PP +\fIRequired if starting a shard server.\f1 +.PP +Configures this \fBmongod\f1\f1 instance as a shard in a sharded cluster. The default port for these instances is -\fB27018\fP\&. -.sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -Starting in MongoDB 3.6, you must deploy shards as replica sets. See the \fI\%\-\-replSet\fP -option to deploy \fBmongod\fP as part of a replica set. -.UNINDENT -.UNINDENT -.sp -Do not use the \fI\%\-\-shardsvr\fP with the -\fBskipShardingConfigurationChecks\fP parameter. That is, if -you are temporarily starting the \fI\%mongod\fP as a +\fB27018\f1\&. +.PP +When starting a MongoDB server with \fB\-\-shardsvr\f1, you must also +specify a \fB\-\-replSet\f1\f1\&. +.PP +Do not use the \fB\-\-shardsvr\f1\f1 with the +\fBskipShardingConfigurationChecks\f1\f1 parameter. That is, if +you are temporarily starting the \fBmongod\f1\f1 as a standalone for maintenance operations, include the parameter -\fBskipShardingConfigurationChecks\fP and exclude \fI\%\-\-shardsvr\fP\&. +\fBskipShardingConfigurationChecks\f1\f1 and exclude \fB\-\-shardsvr\f1\f1\&. Once maintenance has completed, remove the -\fBskipShardingConfigurationChecks\fP parameter and restart -with \fI\%\-\-shardsvr\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-moveParanoia +\fBskipShardingConfigurationChecks\f1\f1 parameter and restart +with \fB\-\-shardsvr\f1\f1\&. +.RE +.PP +\fBmongod \-\-moveParanoia\f1 +.RS +.PP If specified, during chunk migration, a shard saves, -to the \fBmoveChunk\fP directory of the \fB\-\-dbpath\fP, all documents +to the \fBmoveChunk\f1 directory of the \fB\-\-dbpath\f1, all documents migrated from that shard. -.sp +.PP MongoDB does not automatically delete the data saved in the -\fBmoveChunk\fP directory. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noMoveParanoia -Changed in version 3.2: Starting in 3.2, MongoDB uses \fB\-\-noMoveParanoia\fP as the default. - -.sp +\fBmoveChunk\f1 directory. +.RE +.PP +\fBmongod \-\-noMoveParanoia\f1 +.RS +.PP +Starting in 3.2, MongoDB uses \fB\-\-noMoveParanoia\f1 as the default. +.PP During chunk migration, a shard does not save documents migrated from the shard. -.UNINDENT -.SS TLS Options -.INDENT 0.0 -.INDENT 3.5 -.SS See -.sp -/tutorial/configure\-ssl for full +.RE +.SS TLS OPTIONS +.PP +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 for full documentation of MongoDB\(aqs support. -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsMode -New in version 4.2. - -.sp +.PP +\fBmongod \-\-tlsMode\f1 +.RS +.PP Enables TLS used for all network connections. The -argument to the \fI\%\-\-tlsMode\fP option can be one of the following: -.TS -center; -|l|l|. -_ -T{ +argument to the \fB\-\-tlsMode\f1\f1 option can be one of the following: +.RS +.IP \(bu 2 +.RS +.IP \(bu 4 Value -T} T{ +.IP \(bu 4 Description -T} -_ -T{ -\fBdisabled\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBdisabled\f1 +.IP \(bu 4 The server does not use TLS. -T} -_ -T{ -\fBallowTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBallowTLS\f1 +.IP \(bu 4 Connections between servers do not use TLS. For incoming connections, the server accepts both TLS and non\-TLS. -T} -_ -T{ -\fBpreferTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBpreferTLS\f1 +.IP \(bu 4 Connections between servers use TLS. For incoming connections, the server accepts both TLS and non\-TLS. -T} -_ -T{ -\fBrequireTLS\fP -T} T{ +.RE +.IP \(bu 2 +.RS +.IP \(bu 4 +\fBrequireTLS\f1 +.IP \(bu 4 The server uses and accepts only TLS encrypted connections. -T} -_ -.TE -.sp -If \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP is not +.RE +.RE +.PP +If \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 is not specified and you are not using x.509 authentication, the system\-wide CA certificate store will be used when connecting to an TLS\-enabled server. -.sp -If using x.509 authentication, \fB\-\-tlsCAFile\fP or \fBtls.CAFile\fP -must be specified unless using \fI\%\-\-tlsCertificateSelector\fP\&. -.sp +.PP +If using x.509 authentication, \fB\-\-tlsCAFile\f1 or \fBtls.CAFile\f1 +must be specified unless using \fB\-\-tlsCertificateSelector\f1\f1\&. +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFile -New in version 4.2: Specifies the \fB\&.pem\fP file that contains both the TLS +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsCertificateKeyFile\f1 +.RS +.PP +Specifies the \&.pem file that contains both the TLS certificate and key. - -.sp +.PP Starting with MongoDB 4.0 on macOS or Windows, you can use the -\fI\%\-\-tlsCertificateSelector\fP option to specify a +\fB\-\-tlsCertificateSelector\f1\f1 option to specify a certificate from the operating system\(aqs secure certificate store -instead of a PEM key file. \fI\%\-\-tlsCertificateKeyFile\fP and -\fI\%\-\-tlsCertificateSelector\fP options are mutually exclusive. +instead of a PEM key file. \fB\-\-tlsCertificateKeyFile\f1\f1 and +\fB\-\-tlsCertificateSelector\f1\f1 options are mutually exclusive. You can only specify one. -.INDENT 7.0 +.RS .IP \(bu 2 -On Linux/BSD, you must specify \fI\%\-\-tlsCertificateKeyFile\fP +On Linux/BSD, you must specify \fB\-\-tlsCertificateKeyFile\f1\f1 when TLS/SSL is enabled. .IP \(bu 2 On Windows or macOS, you must specify either -\fI\%\-\-tlsCertificateKeyFile\fP or -\fI\%\-\-tlsCertificateSelector\fP when TLS/SSL is enabled. -.sp -\fBIMPORTANT:\fP -.INDENT 2.0 -.INDENT 3.5 -For Windows \fBonly\fP, MongoDB 4.0 and later do not support -encrypted PEM files. The \fI\%mongod\fP fails to start if +\fB\-\-tlsCertificateKeyFile\f1\f1 or +\fB\-\-tlsCertificateSelector\f1\f1 when TLS/SSL is enabled. +.IP +For Windows \fBonly\f1, MongoDB 4.0 and later do not support +encrypted PEM files. The \fBmongod\f1\f1 fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with TLS on Windows, -use \fI\%\-\-tlsCertificateSelector\fP\&. -.UNINDENT -.UNINDENT -.UNINDENT -.sp +use \fB\-\-tlsCertificateSelector\f1\f1\&. +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-tlsCertificateKeyFilePassword -New in version 4.2. - -.sp +\fBConfigure mongod\f1 and mongos\f1 for TLS/SSL\f1 and +\fBTLS/SSL Configuration for Clients\f1 . +.RE +.PP +\fBmongod \-\-tlsCertificateKeyFilePassword\f1 +.RS +.PP Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\%\-\-tlsCertificateKeyFile\fP). Use the -\fI\%\-\-tlsCertificateKeyFilePassword\fP option only if the +\fB\-\-tlsCertificateKeyFile\f1\f1). Use the +\fB\-\-tlsCertificateKeyFilePassword\f1\f1 option only if the certificate\-key file is encrypted. In all cases, the -\fBmongod\fP will redact the password from all logging and +\fBmongod\f1\f1 will redact the password from all logging and reporting output. -.sp +.PP Starting in MongoDB 4.0: -.INDENT 7.0 +.RS .IP \(bu 2 On Linux/BSD, if the private key in the PEM file is encrypted and -you do not specify the \fI\%\-\-tlsCertificateKeyFilePassword\fP option, MongoDB will prompt for a -passphrase. See ssl\-certificate\-password\&. +you do not specify the \fB\-\-tlsCertificateKeyFilePassword\f1\f1 option, MongoDB will prompt for a +passphrase. See \fBTLS/SSL Certificate Passphrase\f1\&. .IP \(bu 2 On macOS, if the private key in the PEM file is encrypted, you must explicitly specify the -\fI\%\-\-tlsCertificateKeyFilePassword\fP option. Alternatively, +\fB\-\-tlsCertificateKeyFilePassword\f1\f1 option. Alternatively, you can use a certificate from the secure system store (see -\fI\%\-\-tlsCertificateSelector\fP) instead of a PEM file or use an +\fB\-\-tlsCertificateSelector\f1\f1) instead of a PEM file or use an unencrypted PEM file. .IP \(bu 2 On Windows, MongoDB does not support encrypted certificates. -The \fI\%mongod\fP fails if it encounters an encrypted -PEM file. Use \fI\%\-\-tlsCertificateSelector\fP instead. -.UNINDENT -.sp +The \fBmongod\f1\f1 fails if it encounters an encrypted +PEM file. Use \fB\-\-tlsCertificateSelector\f1\f1 instead. +.RE +.PP For more information about TLS and MongoDB, see -/tutorial/configure\-ssl and -/tutorial/configure\-ssl\-clients . -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-clusterAuthMode