自管理的配置文件选项

外部来源的值

以下扩展指令可用：

有关完整文档，请参阅适用于自管理部署的外部来源配置文件值。

扩展指令和 --configExpand

如果在配置文件中使用扩展指令，则在启动 mongod 或 mongos 时必须包含 --configExpand 选项。例如：

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

如果配置文件包含扩展指令，而您在启动 mongod / mongos 时没有在 --configExpand 选项中指定该指令，则 mongod / mongos 将无法启动。

有关完整文档，请参阅适用于自管理部署的外部来源配置文件值。

systemLog.component 选项

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

systemLog.component.accessControl.verbosity

类型：整型

默认值：0

访问控制相关组件的日志信息详细级别。请参阅 ACCESS 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.command.verbosity

类型：整型

默认值：0

与命令相关的组件的日志消息详细级别。请参阅 COMMAND 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.control.verbosity

类型：整型

默认值：0

与控制操作相关的组件的日志消息详细级别。请参阅 CONTROL 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.ftdc.verbosity

类型：整型

默认值：0

与诊断数据集合操作相关的组件的日志消息详细级别。请参阅 FTDC 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.geo.verbosity

类型：整型

默认值：0

与地理空间分析操作相关的组件的日志消息详细级别。请参阅 GEO 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.index.verbosity

类型：整型

默认值：0

与索引操作相关的组件的日志消息详细级别。请参阅 INDEX 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.network.verbosity

类型：整型

默认值：0

与网络操作相关的组件的日志消息详细级别。请参阅 NETWORK 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.query.verbosity

类型：整型

默认值：0

与查询操作相关的组件的日志消息详细级别。请参阅 QUERY 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.queryStats.verbosity

类型：整型

默认值：0

与 $queryStats 调用相关组件的日志消息详细级别。请参阅 QUERYSTATS 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是默认的日志详细程度级别，仅包括信息性消息。在此级别上不记录 $queryStats 调用。

• 1 到 2 会增加详细级别，以包含algorithm为 "hmac-sha-256" 的 $queryStats 调用。所有 HMAC 密钥均已被隐藏。

• 3 到 5 会增加详细级别，以包括 $queryStats 个调用，其中 algorithm 是 "hmac-sha-256"，以及相应的结果。每个结果都有自己的条目，最后一个条目带有字符串 "we finished"。

systemLog.component.replication.verbosity

类型：整型

默认值：0

复制相关组件的日志信息详细级别。请参阅 REPL 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.replication.election.verbosity

类型：整型

默认值：0

与选举相关组件的日志信息详细级别。请参阅 ELECTION 组件。

如果未设置 systemLog.component.replication.election.verbosity，则 systemLog.component.replication.verbosity 级别也适用于选举组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.replication.heartbeats.verbosity

类型：整型

默认值：0

与心跳相关组件的日志消息详细级别。请参阅 REPL_HB 组件。

如果未设置 systemLog.component.replication.heartbeats.verbosity，则 systemLog.component.replication.verbosity 级别也适用于心跳组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.replication.initialSync.verbosity

类型：整型

默认值：0

与 InitialSync 相关的组件的日志消息详细级别。请参阅 INITSYNC 组件。

如果未设置 systemLog.component.replication.initialSync.verbosity，则 systemLog.component.replication.verbosity 级别也适用于 initialSync 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.replication.rollback.verbosity

类型：整型

默认值：0

与回滚相关的组件的日志消息详细程度。请参阅 ROLLBACK 组件。

如果未设置 systemLog.component.replication.rollback.verbosity，则 systemLog.component.replication.verbosity 级别也适用于回滚组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.sharding.verbosity

类型：整型

默认值：0

分片相关组件的日志信息详细级别。请参阅 SHARDING 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.verbosity

类型：整型

默认值：0

与存储相关的组件的日志消息详细级别。请参阅 STORAGE 组件。

如果未设置 systemLog.component.storage.journal.verbosity，则 systemLog.component.storage.verbosity 级别也适用于日志组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.journal.verbosity

类型：整型

默认值：0

与日志相关的组件的日志消息详细级别。请参阅 JOURNAL 组件。

如果未设置 systemLog.component.storage.journal.verbosity，则日志组件具有与父级存储组件相同的详细级别：具体来说，如果已设置，则为 systemLog.component.storage.verbosity 级别，否则为默认的详细级别。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.recovery.verbosity

类型：整型

默认值：0

与恢复相关的组件的日志消息详细级别。请参阅 RECOVERY 组件。

如果未设置 systemLog.component.storage.recovery.verbosity，则 systemLog.component.storage.verbosity 级别也适用于恢复组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎相关的组件的日志消息详细级别。请参阅 WT 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtBackup.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的备份操作相关的组件的日志消息详细级别。请参阅 WTBACKUP 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtCheckpoint.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的检查点操作相关的组件的日志消息详细级别。请参阅 WTCHKPT 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtCompact.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的压实操作相关的组件的日志消息详细级别。请参阅 WTCMPCT 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtEviction.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的逐出操作相关的组件的日志消息详细级别。请参阅 WTEVICT 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtHS.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的历史记录存储操作相关的组件的日志消息详细级别。请参阅 WTHS 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtRecovery.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的恢复操作相关的组件的日志消息详细级别。请参阅 WTRECOV 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtRTS.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的回滚到稳定 (RTS) 操作相关组件的日志消息详细级别。请参阅 WTRTS 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtSalvage.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的数据打捞 (salvage) 操作相关的组件的日志消息详细级别。请参阅 WTSLVG 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtTimestamp.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

WiredTiger 存储引擎使用的时间戳相关组件的日志消息详细级别。请参阅 WTTS 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtTransaction.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

WiredTiger 存储引擎执行的事务操作相关组件的日志消息详细级别。请参阅 WTTXN 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtVerify.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的验证操作相关的组件的日志消息详细级别。请参阅 WTVRFY 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.storage.wt.wtWriteLog.verbosity

类型：整型

默认：-1

5.3 版本中的新增功能。

与 WiredTiger 存储引擎执行的日志写入操作相关的组件的日志消息详细级别。请参阅 WTWRTLOG 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.transaction.verbosity

类型：整型

默认值：0

与事务相关组件的日志信息详细级别。请参阅 TXN 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

systemLog.component.write.verbosity

类型：整型

默认值：0

与写入操作相关的组件的日志消息详细级别。请参阅 WRITE 组件。

详细程度级别的范围可以从 0 到 5：

• 0 是 MongoDB 的默认日志详细程度级别，它包括信息性消息。

• 1 到 5 提高详细程度级别以包括调试消息。

net.unixDomainSocket 选项

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

net.unixDomainSocket.enabled

类型：布尔值

默认值：true

启用或禁用 UNIX 域套接字上的侦听。net.unixDomainSocket.enabled 仅适用于基于 Unix 的系统。

当 net.unixDomainSocket.enabled 为 true 时， mongos 或 mongod 侦听 UNIX 套接字。

mongos 或 mongod 进程始终侦听 UNIX 套接字，除非满足以下条件之一：

• net.unixDomainSocket.enabled is false

• --nounixsocket 已设置。命令行选项优先于配置文件设置。

• net.bindIp 未设置

• net.bindIp 未指定 localhost 或其关联的 IP 地址

mongos 或 mongod 通过官方 .deb 和 .rpm 包安装）默认将 bind_ip 配置设置为 127.0.0.1。

net.unixDomainSocket.pathPrefix

类型：字符串

默认：/tmp

UNIX 套接字的路径。net.unixDomainSocket.pathPrefix 仅适用于基于 Unix 的系统。

如果此选项没有值，则 mongos 或 mongod 进程会创建一个以 /tmp 为前缀的套接字。MongoDB 创建并侦听 UNIX 套接字，除非满足以下条件之一：

• net.unixDomainSocket.enabled is false

• --nounixsocket 已设置

• net.bindIp 未设置

• net.bindIp 未指定 localhost 或其关联的 IP 地址

net.unixDomainSocket.filePermissions

类型：int

默认值：0700

设置 UNIX 域套接字文件的权限。

net.unixDomainSocket.filePermissions 仅适用于基于 Unix 的系统。

net.tls 选项

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

net.tls.mode

类型：字符串

对所有网络连接启用 TLS 模式。net.tls.mode 设置的参数可以是以下之一：

值	说明
disabled	该服务器不使用 TLS。
allowTLS	服务器之间的连接不使用 TLS。对于传入连接，服务器既接受 TLS，也接受非 TLS。
preferTLS	服务器之间的连接使用 TLS。对于传入连接，服务器既接受 TLS，也接受 TLS。
requireTLS	服务器仅使用并接受 TLS 加密连接。

如果未指定 --tlsCAFile 或 tls.CAFile 且您未使用 x.509 身份验证，则必须将 tlsUseSystemCA 参数设置为 true。这使得 MongoDB 在连接到启用 TLS 的服务器时使用系统范围的 CA 证书存储。

如果使用 x.509 身份验证，则必须指定 --tlsCAFile 或 tls.CAFile，除非使用 --tlsCertificateSelector。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

net.tls.certificateKeyFile

类型：字符串

包含 TLS 证书和密钥的 .pem 文件。

在 macOS 或 Windows 上，可以使用 net.tls.certificateSelector 设置指定来自操作系统的安全证书存储区的证书，而不是 PEM 密钥文件。certificateKeyFile 和 net.tls.certificateSelector 是互斥的。您只能指定一个。

• 在 Linux/BSD 上，当启用 TLS 时，您必须指定 net.tls.certificateKeyFile。

• 在 Windows 或 macOS 上，当启用 TLS 时，您必须指定 net.tls.certificateKeyFile 或 net.tls.certificateSelector。

  重要

  仅适用于 Windows，MongoDB 不支持加密的 PEM 文件。如果遇到加密的 PEM 文件，则 mongod 无法启动。要在 Windows 上安全地存储和访问用于 TLS 的证书，请使用 net.tls.certificateSelector。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

net.tls.certificateKeyFilePassword

类型：字符串

用于解密证书密钥文件的密码（即 certificateKeyFile）。仅当证书密钥文件已加密时才能使用 net.tls.certificateKeyFilePassword 选项。在所有情况下，mongos 或 mongod 都会对所有日志记录和报告输出中的密码进行脱敏。

在 Linux/BSD 上，如果 PEM 文件中的私钥已加密且您未指定 net.tls.certificateKeyFilePassword 选项，则 MongoDB 会提示您输入密码。

有关更多信息，请参阅 TLS/SSL 证书密码。

在 macOS 上，如果 PEM 文件中的私钥已加密，则必须明确指定 net.tls.certificateKeyFilePassword 选项。或者，您可以使用安全系统存储中的证书（请参阅 net.tls.certificateSelector）而不是 PEM 密钥文件，或者使用未加密的 PEM 文件。

在 Windows 上，MongoDB 不支持加密证书。如果 mongod 遇到加密的 PEM 文件，则会失败。请改用net.tls.certificateSelector。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

net.tls.certificateSelector

类型：字符串

指定证书属性，以便从操作系统的证书存储区中选择匹配的证书来用于 TLS/SSL。可在 Windows 和 macOS 上用作 net.tls.certificateKeyFile. 的替代方案。

net.tls.certificateKeyFile 和 net.tls.certificateSelector 选项是互斥的。您只能指定一个。

net.tls.certificateSelector 接受格式为 <property>=<value> 的参数，其中属性可以是以下之一：

属性	值类型	说明
subject	ASCII 字符串	证书上的主题名称或公用名
thumbprint	十六进制字符串	以十六进制表示的字节序列，用于通过 SHA-1 摘要识别公钥。 thumbprint 有时称为 fingerprint。

在使用系统 SSL 证书存储区时，会用 OCSP（在线证书状态协议）来验证证书的吊销状态。

mongod 搜索操作系统的安全证书存储区，查找验证指定 TLS 证书的完整证书链所需的 CA 证书。具体来说，安全证书存储区必须包含根 CA 以及构建 TLS 证书的完整证书链所需的任何中间 CA 证书。

警告

如果您使用 net.tls.certificateSelector 和/或 net.tls.clusterCertificateSelector，我们不建议使用 net.tls.CAFile 或 net.tls.clusterFile 来指定根 CA 证书和中间 CA 证书

例如，如果 TLS 证书是使用单个根 CA 证书签署的，则安全证书存储区必须包含相应的根 CA 证书。如果 TLS 证书是使用中间 CA 证书签署的，则安全证书存储区必须包含相应的中间 CA 证书和 根 CA 证书。

注意

针对以下情况无法使用 rotateCertificates 命令行或 db.rotateCertificates() shell 方法：将 net.tls.certificateSelector 或 --tlsCertificateSelector 集合用于 thumbprint 时

net.tls.clusterCertificateSelector

类型：字符串

指定证书属性，以便从操作系统的证书存储区中选择匹配的证书以用于内部 x.509 成员身份验证。

可在 Windows 和 macOS 上用作 net.tls.clusterFile 的替代方案。

net.tls.clusterFile 和 net.tls.clusterCertificateSelector 选项是互斥的。您只能指定一个。

net.tls.clusterCertificateSelector 接受格式为 <property>=<value> 的参数，其中属性可以是以下之一：

属性	值类型	说明
subject	ASCII 字符串	证书上的主题名称或公用名
thumbprint	十六进制字符串	以十六进制表示的字节序列，用于通过 SHA-1 摘要识别公钥。 thumbprint 有时称为 fingerprint。

mongod 搜索操作系统的安全证书存储区，查找验证指定集群证书的完整证书链所需的 CA 证书。具体来说，安全证书存储区必须包含根 CA 以及构建集群证书的完整证书链所需的任何中间 CA 证书。

警告

如果您使用 net.tls.certificateSelector 和/或 net.tls.clusterCertificateSelector，我们不建议使用 net.tls.CAFile 或 net.tls.clusterCAFile 来指定根和中间 CA 证书。

例如，如果集群证书是使用单个根 CA 证书签署的，则安全证书存储区必须包含该根 CA 证书。如果集群证书是使用中间 CA 证书签署的，则安全证书存储区必须包含中间 CA 证书和根 CA 证书。

如果显示的 x.509 证书在 mongod/mongos 主机系统时间后的 30 天内过期，则 mongod / mongos 会在连接时记录警告。

net.tls.clusterFile

类型：字符串

.pem 文件，其中包含用于集群或副本集的成员身份验证的 x.509 证书密钥文件。

在 macOS 或 Windows 上，可以使用 net.tls.clusterCertificateSelector 选项指定来自操作系统的安全证书存储区的证书，而不是 PEM 密钥文件。net.tls.clusterFile 和 net.tls.clusterCertificateSelector 选项是互斥的。您只能指定一个。

如果 net.tls.clusterFile 没有为内部集群身份验证指定 .pem 文件，或者未指定备选 net.tls.clusterCertificateSelector，则集群使用在 certificateKeyFile 设置中指定的 .pem 文件，或使用由 net.tls.certificateSelector 返回的证书。

如果使用 x.509 身份验证，则必须指定 --tlsCAFile 或 tls.CAFile，除非使用 --tlsCertificateSelector。

如果显示的 x.509 证书在 mongod/mongos 主机系统时间后的 30 天内过期，则 mongod / mongos 会在连接时记录警告。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

重要

仅适用于 Windows，MongoDB 不支持加密的 PEM 文件。如果遇到加密的 PEM 文件，则 mongod 无法启动。要安全地存储和访问用于 Windows 成员身份验证的证书，请使用 net.tls.clusterCertificateSelector。

net.tls.clusterPassword

类型：字符串

用于解密 x.509 证书密钥文件（由 --sslClusterFile 指定）的密码。仅当证书密钥文件已加密时才能使用 net.tls.clusterPassword 选项。任何情况下，mongos 或 mongod 都会对所有日志和报告输出中的密码进行脱敏。

在 Linux/BSD 上，如果 x.509 文件中的私钥已加密且未指定 net.tls.clusterPassword 选项，MongoDB 则会提示输入密码。

有关更多信息，请参阅 TLS/SSL 证书密码。

在 macOS 上，如果 x.509 文件中的私钥已加密，则必须明确指定 net.tls.clusterPassword 选项。另外，也可以使用安全系统存储区中的证书（请参阅 net.tls.clusterCertificateSelector）而不是集群 PEM 文件，或者使用未加密的 PEM 文件。

在 Windows 上，MongoDB 不支持加密证书。如果 mongod 遇到加密的 PEM 文件，则会失败。使用 net.tls.clusterCertificateSelector。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

net.tls.CAFile

类型：字符串

.pem 文件，其中包含来自证书颁发机构的根证书链。使用相对或绝对路径指定 .pem 文件的文件名。

仅限 Windows/macOS

如果使用 net.tls.certificateSelector 和/或 net.tls.clusterCertificateSelector，请勿使用 net.tls.CAFile 来指定根和中间 CA 证书。将验证 net.tls.certificateSelector 和/或 net.tls.clusterCertificateSelector 证书的完整信任链所需的所有 CA 证书存储在安全证书存储区中。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

net.tls.clusterCAFile

类型：字符串

包含来自证书授权机构的根证书链的 .pem 文件，用于验证建立连接的客户端提供的证书。使用相对或绝对路径指定 .pem 文件的文件名。net.tls.clusterCAFile 要求设置 net.tls.CAFile。

如果 net.tls.clusterCAFile 未指定 .pem 文件来验证建立连接的客户端的证书，集群就会使用 net.tls.CAFile 选项中指定的 .pem 文件。

net.tls.clusterCAFile 允许您使用单独的证书颁发机构来验证 TLS 握手的客户端到服务器和服务器到客户端部分。

从 4.0 版本开始，在 macOS 或 Windows 上，您可以使用操作系统安全存储服务中的证书而不是 PEM 密钥文件。请参阅 net.tls.clusterCertificateSelector。使用安全存储区时，您不需要但也可以指定 net.tls.clusterCAFile。

仅限 Windows/macOS

如果使用 net.tls.certificateSelector 和/或 net.tls.clusterCertificateSelector，请勿使用 net.tls.clusterCAFile 来指定根和中间 CA 证书。将验证 net.tls.certificateSelector 和/或 net.tls.clusterCertificateSelector 证书的完整信任链所需的所有 CA 证书存储在安全证书存储区中。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

net.tls.CRLFile

类型：字符串

包含证书吊销列表的 .pem 文件。使用相对或绝对路径指定 .pem 文件的文件名。

注意

• 在 macOS 上不能指定 net.tls.CRLFile。但您可以使用系统 SSL 证书存储区，该存储区使用 OCSP（在线证书状态协议）来验证证书的吊销状态。如要使用系统 SSL 证书存储区，请参阅 net.tls.certificateSelector。

• 为了检查证书吊销状况，MongoDB 默认enables OCSP（在线证书状态协议）作为指定 CRL 文件或使用系统 SSL 证书存储区的替代方法。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

net.tls.allowConnectionsWithoutCertificates

类型：布尔值

默认：false

如果为 false，则所有客户端都必须提供客户端TLS 证书。如果 true，则客户端不需要提供客户端证书，但 mongod 或 mongos 会对 TLS/SSL 连接进行加密。

如果客户端提供客户端证书，则无论您为 net.tls.allowConnectionsWithoutCertificates 设定什么值，mongos 或 mongod 都会使用 CAFile 指定的根证书链或系统 CA 存储执行证书验证（如果 tlsUseSystemCA 为 true），并拒绝证书无效的客户端。

如果您的混合部署包含不向或无法向 mongos 或 mongod 选项提供证书的客户端，请使用 net.tls.allowConnectionsWithoutCertificates。

有关 TLS 和 MongoDB 的详细信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及客户端的 TLS/SSL 配置。

net.tls.allowInvalidCertificates

类型：布尔值

默认：false

启用或禁用集群中其他服务器上的 TLS 证书的验证检查，并允许使用无效证书进行连接。

注意

如果您在使用 x.509 身份验证时指定 --tlsAllowInvalidCertificates 或 tls.allowInvalidCertificates: true，则无效证书仅足以建立 TLS 连接，但不足以进行身份验证。

使用 net.tls.allowInvalidCertificates 设置时，MongoDB 会记录有关使用无效证书的警告。

有关 TLS 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos 以及自管理内部/成员身份验证。

net.tls.allowInvalidHostnames

类型：布尔值

默认：false

当 net.tls.allowInvalidHostnames 为 true 时，MongoDB 禁用 TLS 证书中的主机名验证。这样，即使证书的主机名与指定的主机名不匹配，mongod 或 mongos 也能连接集群中的其他 MongoDB 实例。

有关 TLS 和 MongoDB 的更多信息，请参阅为 TLS/SSL 配置 mongod 和 mongos。

net.tls.disabledProtocols

类型：字符串

防止使用 TLS 运行的 MongoDB Server 接受使用特定协议的传入连接。要指定多个协议，请使用逗号分隔的协议列表，但不要在逗号后使用空格。如果在协议名称前包含空格，服务器会将其解释为无法识别的协议并且不会启动。

net.tls.disabledProtocols 可识别以下协议：TLS1_0、TLS1_1、TLS1_2 和 TLS1_3。

• 在 macOS 上，您无法在禁用 TLS1_1 的情况下，让 TLS1_0 和 TLS1_2 同时启用。您必须至少禁用后两者中的一个，比如 TLS1_0,TLS1_1。

• 若要列出多个协议，请指定为逗号分隔的协议列表，逗号后不带空格。例如 TLS1_0,TLS1_1。

• 指定无法识别的协议或在逗号后包含空格，将会阻止服务器启动。

• 指定的禁用协议将覆盖任何默认禁用的协议。

如果 TLS 1.1+ 在系统上可用，MongoDB 将禁用 TLS 1.0。如要启用 TLS 1.0，请指定 none 到 net.tls.disabledProtocols。

副本集和分片集群的成员必须至少使用一个共同协议。

提示

另请参阅：

禁用协议

net.tls.FIPSMode

类型：布尔值

默认：false

在 mongos 或 mongod 中启用或禁用 TLS 库的 FIPS 模式。您的系统必须有符合 FIPS 标准的库，才能使用 net.tls.FIPSMode 选项。

注意

只有 MongoDB Enterprise 支持与 FIPS 兼容的 TLS/SSL。有关更多信息，请参阅为 FIPS 配置 MongoDB 。

net.tls.logVersions

类型：字符串

指示 mongos 或 mongod 在客户端使用指定 TLS 版本进行连接时记录消息。

指定单个 TLS 版本或以逗号分隔的多个 TLS 版本的列表。

例子

如要指示 mongos 或 mongod 在客户端使用 TLS 1.2 或 TLS 1.3 进行连接时记录消息，请将 net.tls.logVersions 设置为 "TLS1_2,TLS1_3"。

net.compression 选项

net:
   compression:
      compressors: <string>

net.compression.compressors

Default: snappy,zstd,zlib

指定默认压缩程序用于此 mongod 或 mongos 实例与以下对象之间的通信：

• 部署的其他成员（如果实例是副本集或分片集群的一部分）

• mongosh

• 支持 OP_COMPRESSED 消息格式的驱动程序。

MongoDB 支持以下压缩程序：

• snappy

• zlib

• zstd

要禁用网络压缩，请将值设置为 disabled。

重要

当双方都启用网络压缩时，消息就会被压缩。否则，各方之间的消息不会被压缩。

如果指定多个压缩程序，则列出压缩程序的顺序与通信发起者都很重要。例如，如果 mongosh 指定以下网络压缩程序 zlib,snappy 且 mongod 指定 snappy,zlib，则在 mongosh 和 mongod 之间的消息使用 zlib。

如果各方未分享至少一个通用压缩程序，则各方之间的消息将不会被压缩。例如，如果 mongosh 指定网络压缩程序 zlib 且 mongod 指定 snappy，则 mongosh 与 mongod 之间的消息将不会被压缩。

密钥管理配置选项

security:
   enableEncryption: <boolean>
   encryptionCipherMode: <string>
   encryptionKeyFile: <string>
   kmip:
      keyIdentifier: <string>
      rotateMasterKey: <boolean>
      serverName: <string>
      port: <string>
      clientCertificateFile: <string>
      clientCertificatePassword: <string>
      clientCertificateSelector: <string>
      serverCAFile: <string>
      connectRetries: <int>
      connectTimeoutMS: <int>
      activateKeys: <boolean>
      keyStatePollingSeconds: <int>

security.enableEncryption

类型：布尔值

默认：false

对 WiredTiger 存储引擎启用加密。必须设置为 true，才能传递加密密钥和配置。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.encryptionCipherMode

类型：字符串

默认值：AES256-CBC

用于静态加密的密码模式：

模式	说明
AES256-CBC	采用密码分组链接模式的 256 位高级加密标准
AES256-GCM	采用 Galois/Counter 模式的 256 位高级加密标准 仅在 Linux 上可用。 Windows 上的 MongoDB Enterprise 不再支持将 AES256-GCM 作为静态加密的分组密码算法。仅 Linux 版本支持此用法。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.encryptionKeyFile

类型：字符串

通过 KMIP 以外的进程管理密钥时，本地密钥文件的路径。仅在通过 KMIP 以外的进程管理密钥时设置。如果已使用 KMIP 加密数据，则 MongoDB 会抛出错误。

要求 security.enableEncryption 为 true。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.keyIdentifier

类型：字符串

KMIP 服务器中现有密钥的唯一 KMIP 标识符。包括该设置可将与该标识符关联的密钥作为系统密钥。只能在第一次为 mongod 实例启用加密时使用该设置。要求 security.enableEncryption 为 True。

如果未指定，MongoDB 会请求 KMIP 服务器创建新密钥用作系统密钥。

如果 KMIP 服务器找不到指定标识符的密钥或者数据已使用密钥加密，则 MongoDB 将报告错误。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.rotateMasterKey

类型：布尔值

默认：false

如果为 true，则轮换主密钥并对内部密钥库重新加密。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

提示

另请参阅：

KMIP 主密钥轮换

security.kmip.serverName

类型：字符串

要连接的 KMIP 服务器的主机名或 IP 地址。要求 security.enableEncryption 为 true。

您可以将多个 KMIP 服务器指定为逗号分隔的列表，例如 server1.example.com,server2.example.com。启动时，mongod 会尝试按列出的顺序与每台服务器建立连接，并选择可以成功建立连接的第一台服务器。KMIP 服务器选择仅在启动时进行。

mongod 启动时验证与 KMIP 服务器的连接。

--kmipServerName 中指定的服务器名称必须与 KMIP 服务器出示的证书上的主题备用名称 SAN 或公用名 CN 相匹配。SAN 可以是系统名称或 IP 地址。

如果存在 SAN，则 mongod 不会尝试与 CN 配对。

如果 KMIP 服务器的主机名或 IP 地址与 SAN 和 CN 都不匹配，则 mongod 不会启动。

从 MongoDB 4.2 开始，在比较 SAN 时，MongoDB 可以比较 DNS 名称或 IP 地址。在之前的版本中，MongoDB 仅能比较 DNS 名称。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.port

类型：字符串

默认：5696

用于与 KMIP 服务器通信的端口号。需要 security.kmip.serverName。要求 security.enableEncryption 为 True。

如果使用 security.kmip.serverName 指定多个 KMIP 服务器，则 mongod 将对所有提供的 KMIP 服务器使用通过 security.kmip.port 指定的端口。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.clientCertificateFile

类型：字符串

用于在 KMIP 服务器上对 MongoDB 进行身份验证的 .pem 文件的路径。指定的 .pem 文件必须包含 TLS/SSL 证书和密钥。

如要使用此设置，还必须指定 security.kmip.serverName 设置。

注意

从 4.0 版本开始，在 macOS 或 Windows 上，您可以使用操作系统安全存储服务中的证书而不是 PEM 密钥文件。请参阅 security.kmip.clientCertificateSelector。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.clientCertificatePassword

类型：字符串

用来解密客户端证书的密码（即 security.kmip.clientCertificateFile），用于在 KMIP 服务器上对 MongoDB 进行身份验证。仅在证书加密时使用该选项。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.clientCertificateSelector

类型：字符串

5.0 版本中的新增功能：可在 Windows 和 macOS 上作为 security.kmip.clientCertificateFile 的替代方案。

security.kmip.clientCertificateFile 和 security.kmip.clientCertificateSelector 选项是互斥的。您只能指定一个。

指定证书属性，以便从操作系统的证书存储区中选择匹配的证书来在 KMIP 服务器上对 MongoDB 进行身份验证。

security.kmip.clientCertificateSelector 接受格式为 <property>=<value> 的参数，其中属性可以是以下之一：

属性	值类型	说明
subject	ASCII 字符串	证书上的主题名称或公用名
thumbprint	十六进制字符串	以十六进制表示的字节序列，用于通过 SHA-1 摘要识别公钥。 thumbprint 有时称为 fingerprint。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.serverCAFile

类型：字符串

CA 文件的路径。用于验证客户端与 KMIP 服务器的连接是否安全。

注意

从 4.0 版本开始，在 macOS 或 Windows 上，您可以使用操作系统安全存储服务中的证书而不是 PEM 密钥文件。请参阅 security.kmip.clientCertificateSelector。使用安全存储区时，您不需要但也可以指定 security.kmip.serverCAFile。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.connectRetries

类型：int

默认值：0

与 KMIP 服务器初次连接时的重试次数。与 connectTimeoutMS 一起使用可控制 mongod 在两次重试之间等待响应的时间。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.connectTimeoutMS

类型：int

默认值：5000

等待 KMIP 服务器响应的超时时间（以毫秒为单位）。如果指定了 connectRetries 设置，则每次重试时，mongod 将等待，直到达到使用 connectTimeoutMS 指定的值。

取值不得小于 1000。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。

security.kmip.activateKeys

类型：布尔值

默认值：true

5.3 版本中的新增功能。

在 KMIP 密钥创建后激活所有这些新创建的密钥，然后定期检查这些密钥是否处于活动状态。

如果 security.kmip.activateKeys 为 true 并且在 KMIP 服务器上已有密钥时，必须首先激活该密钥，否则，mongod 节点会无法启动。

如果 mongod 使用的密钥转换为非活动状态，则 mongod 节点将关闭，除非 kmipActivateKeys 为 false。为确保您拥有有效的密钥，请使用 security.kmip.rotateMasterKey 轮换 KMIP 主密钥。

security.kmip.keyStatePollingSeconds

类型：int

默认：900 秒

5.3 版本中的新增功能。

mongod 轮询 KMIP 服务器以获取有效密钥的频率（以秒为单位）。

要禁用轮询，请将值设置为 -1。

security.kmip.useLegacyProtocol

类型：布尔值

默认：false

版本 6.0.6 中的新增内容。

设置为 true 时，mongod 使用 KMIP 协议的 1.0 或 1.1 版，而不是默认版本。KMIP 协议的默认版本是 1.2。

要在 KMIP 1.0 或 1.1 版中使用审核日志加密，必须在启动时指定 auditEncryptKeyWithKMIPGet。

要使用 KMIP 协议 1.0 或 1.1 版本，请替换您的本地值并将如下条目添加到您的 mongod 配置文件中：

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

security.sasl 选项

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

security.sasl.hostName

类型：字符串

用于配置 SASL 和 Kerberos 身份验证的完全限定服务器域名。SASL 主机名仅覆盖 SASL 和 Kerberos 配置的主机名。

security.sasl.serviceName

类型：字符串

使用 SASL 的服务的注册名称。通过此选项，您可以按实例替换 Kerberos 主体名称的默认 Kerberos 服务名称组件。如未指定，则使用默认值 mongodb。

MongoDB 仅允许在启动时设置此选项。setParameter 无法更改此设置。

此选项仅在 MongoDB Enterprise 中可用。

重要

确保驱动程序支持备用服务名称。关于 mongosh 和其他连接到新 serviceName 的 MongoDB 工具，请参阅 gssapiServiceName 选项。

security.sasl.saslauthdSocketPath

类型：字符串

saslauthd 的 UNIX 域套接字文件的路径。

security.ldap 选项

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

security.ldap.servers

类型：字符串

仅在 MongoDB Enterprise 中可用。

特定 LDAP 服务器，mongod 或 mongos 在该服务器上对用户进行身份验证或决定授权用户可对给定数据库执行哪些操作。如果指定的 LDAP 服务器有任何复制的实例，则可以在逗号分隔的列表中指定每个复制的服务器的主机和端口。

如果您的 LDAP 基础架构将 LDAP 目录分区到多个 LDAP 服务器，请将一个LDAP 服务器或其任何复制实例指定为security.ldap.servers 。 MongoDB 支持 RFC45114.1 中定义的以下 LDAP10 引用。 。请勿使用security.ldap.servers列出基础架构中的每台 LDAP 服务器。

您可以为 LDAP 服务器添加前缀 srv: 和 srv_raw:。

如果连接字符串指定 "srv:<DNS_NAME>"，则 mongod 将验证 "_ldap._tcp.gc._msdcs.<DNS_NAME>" 是否存在，以使 SRV 支持 Active Directory。如果未找到，mongod 将验证 SRV 是否存在 "_ldap._tcp.<DNS_NAME>"。如果找不到 SRV 记录，则 mongod 会警告您用 "srv_raw:<DNS_NAME>" 代替。

如果您的连接字符串指定了 "srv_raw:<DNS_NAME>"，mongod 会对 "<DNS NAME>" 执行 SRV 记录查询。

可以在运行中的 mongod 或 mongos 上使用 setParameter 配置此设置。

如果未设置，mongod 或 mongos 将不能使用 LDAP 身份验证或授权。

security.ldap.bind.queryUser

类型：字符串

仅在 MongoDB Enterprise 中可用。

mongod 或 mongos 连接到 LDAP 服务器或在该服务器上执行查询时所绑定的身份。

仅当满足以下任一条件时才需要：

• 使用 LDAP 授权。

• 将 LDAP 查询用于 security.ldap.userToDNMapping

• LDAP 服务器不允许匿名绑定

您必须使用 queryUser 和 queryPassword。

如果未设置，则 mongod 或 mongos 不会尝试绑定到 LDAP 服务器。

可以在运行中的 mongod 或 mongos 上使用 setParameter 配置此设置。

注意

Windows MongoDB 部署可以使用 useOSDefaults 而不是 queryUser 和 queryPassword。不能同时指定 queryUser 和 useOSDefaults。

security.ldap.bind.queryPassword

类型：字符串或数组

仅在 MongoDB Enterprise 中可用。

使用 queryUser 时用于绑定到 LDAP 服务器的密码。您必须使用 queryPassword 与 queryUser。

如果未设置，则 mongod 或 mongos 不会尝试绑定到 LDAP 服务器。

您可以使用在运行中的 mongod 或mongos setParameter 上配置此设置。

ldapQueryPassword setParameter 命令接受字符串或字符串数组。如果将 ldapQueryPassword 设置为数组，则 MongoDB 会按顺序尝试每个密码，直到成功为止。使用大量密码滚动 LDAP 帐户密码，无需停机。

注意

Windows MongoDB 部署可以使用 useOSDefaults 而不是 queryUser 和 queryPassword。不能同时指定 queryPassword 和 useOSDefaults。

security.ldap.bind.useOSDefaults

类型：布尔值

默认：false

仅在 Windows 平台上的 MongoDB Enterprise 中可用。

在连接到 LDAP 服务器时，允许 mongod 或 mongos 使用您的 Windows 登录档案进行身份验证或绑定。

仅在以下情况下才需要：

• 使用 LDAP 授权。

• 将 LDAP 查询用于 username transformation

• LDAP 服务器不允许匿名绑定

使用 useOSDefaults 替换 queryUser 和 queryPassword。

security.ldap.bind.method

类型：字符串

默认值：简单

仅在 MongoDB Enterprise 中可用。

mongod 或 mongos 方法用于向 LDAP 服务器进行身份验证。与 queryUser 和 queryPassword 一起使用以连接到 LDAP 服务器。

method 支持以下值：

• simple — mongod 或 mongos 使用简单身份验证。

• sasl — mongod 或 mongos 使用 SASL 协议进行身份验证

如果指定 sasl，则可以使用 security.ldap.bind.saslMechanisms 配置可用的 SASL 机制。mongod 或 mongos 默认为使用 DIGEST-MD5 机制。

security.ldap.bind.saslMechanisms

类型：字符串

默认值：DIGEST-MD5

仅在 MongoDB Enterprise 中可用。

以逗号分隔的 SASL 机制列表 mongod 或 mongos 可使用此列表向 LDAP 服务器进行身份验证。mongod 或 mongos 和 LDAP 服务器必须就至少一种机制达成一致。mongod 或 mongos可在运行时动态加载主机上安装的任何 SASL 机制库。

在 mongod 或 mongos 主机和远程 LDAP 服务器主机上安装和配置所选 SASL 机制的相应库。默认情况下，操作系统可能包含某些 SASL 库。请遵循与每个 SASL 机制相关的文档来获取有关安装和配置的指南。

如果使用 GSSAPI SASL 机制用于 自管理部署 Kerberos 身份验证，则验证 mongod 或 mongos 主机上的以下内容：

Linux

• KRB5_CLIENT_KTNAME 环境变量会解析为主机客户端 Linux Keytab 文件的名称。有关 Kerberos 环境变量的更多信息，请参阅 Kerberos 文档。

• 客户端密钥表包含供 mongod 连接到 LDAP 服务器并执行 LDAP 查询时使用的 mongos用户主体。

Windows

如果连接到 Active Directory 服务器，Windows Kerberos 配置在用户登录系统时会自动生成 Ticket-Granting-Ticket。将 useOSDefaults 设置为 true 以允许 mongod 或 mongos 在连接到 Active Directory 服务器并执行查询时使用生成的证书。

将 method 设置为 sasl 以使用此选项。

注意

有关 SASL 机制的完整列表，请参阅 IANA 列表。请参阅 LDAP 或 Active Directory 服务的文档来识别与该服务兼容的 SASL 机制。

MongoDB 不是 SASL 机制库的来源，MongoDB 文档也不是安装或配置任何给定 SASL 机制的权威来源。如需获得文档和支持，请咨询 SASL 机制库供应商或所有者。

有关 SASL 的更多信息，请参阅以下资源：

• 对于 Linux，请参阅 Cyrus SASL 文档。

• 对于 Windows，请参阅 Windows SASL 文档。

security.ldap.transportSecurity

类型：字符串

默认值：tls

仅在 MongoDB Enterprise 中可用。

默认情况下，mongod 或 mongos会创建与 LDAP 服务器的 TLS/SSL 安全连接。

对于 Linux 部署，必须在 /etc/openldap/ldap.conf 文件中配置相应的 TLS 选项。操作系统的程序包管理器通过 libldap 依赖项创建此文件作为 MongoDB Enterprise 安装的一部分。有关更完整的说明，请参阅 ldap.conf OpenLDAP 文档 中的 。TLS Options

在 Windows 上部署时，必须将 LDAP 服务器 CA 证书添加到 Windows 证书管理工具中。该工具的确切名称和功能可能会因操作系统版本而异。有关证书管理的更多信息，请参阅您的 Windows 版本对应的文档。

将 transportSecurity 设置为 none 以禁用 mongod 或 mongos 与 LDAP 服务器之间的 TLS/SSL。

警告

将 transportSecurity 设置为 none，可在 mongod 或 mongos 和 LDAP 服务器之间传输明文信息，可能还会传输凭证。

security.ldap.timeoutMS

类型：int

默认值：10000

仅在 MongoDB Enterprise 中可用。

mongod 或 mongos 应等待 LDAP 服务器响应请求的时间，以毫秒为单位。

如果失败的根源是连接超时，增加 timeoutMS 的值可以防止 MongoDB 服务器和 LDAP 服务器之间的连接失败。降低 timeoutMS 的值会缩短 MongoDB 等待 LDAP 服务器响应的时间。

可以在运行中的 mongod 或 mongos 上使用 setParameter 配置此设置。

security.ldap.userToDNMapping

类型：字符串

仅在 MongoDB Enterprise 中可用。

将提供给 mongod 或 mongos 进行身份验证的用户名映射到 LDAP 唯一标识名 (DN)。在以下情况下，可能需要使用 userToDNMapping 将用户名转换为 LDAP DN：

• 通过 LDAP 简单绑定进行 LDAP 身份验证，其中用户使用非完整 LDAP DN 的用户名向 MongoDB 进行身份验证。

• 使用需要 DN 的 LDAP authorization query template。

• 将使用不同身份验证机制（如 x.509、kerberos）向 Mongo DB 进行身份验证的客户端的用户名转换为完整的 LDAP DN，以进行授权。

userToDNMapping 需要一个用引号括住的 JSON 字符串，代表一个有序的文档数组。每个文档都包含正则表达式 match 以及用于转换传入用户名的 substitution 或 ldapQuery 模板。

数组中的每个文档均采用以下形式：

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

字段	说明	例子
match	ECMAScript 格式的正则表达式 (regex)，用于与提供的用户名进行匹配。每个括号括起来的部分表示 substitution 或 ldapQuery 使用的正则表达式捕获组。	"(.+)ENGINEERING" "(.+)DBA"
substitution	LDAP 标识名 (DN) 格式模板，该模板将 match 正则表达式匹配的身份验证名称转换为 LDAP DN。每个大括号括起来的数值都会替换为相应的正则表达式捕获群组，这些群组通过 match 正则表达式从身份验证用户名中提取。 替换的结果必须是 RFC4514 转义字符串。	"cn={0},ou=engineering, dc=example,dc=com"
ldapQuery	LDAP 查询格式模板，该模板将匹配 match 正则表达式的身份验证名称插入到按照 RFC4515 和 RFC4516 编码的 LDAP 查询 URI 中。每个大括号内的数值都替换为相应的正则表达式捕获组，这些捕获组是通过match 表达式从身份验证用户名中提取而来的。mongod 或 mongos 针对 LDAP 服务器执行查询，以检索经身份验证用户的 LDAP DN。mongod 或 mongos 要求只有一个返回结果才能转换成功，也可以通过 mongod 或 mongos 跳过转换。	"ou=engineering,dc=example, dc=com??one?(user={0})"

注意

对 RFC4514、 RFC4515、RFC4516 或 LDAP 查询的解释超出了 MongoDB 文档的范围。请直接查看 RFC 或使用您首选的 LDAP 资源。

对于数组中的每个文档，必须使用 substitution 或 ldapQuery。不能在同一文档中同时指定两者。

执行身份验证或授权时，mongod 或 mongos 按给定顺序遍历数组中的每个文档，对照 match 过滤器检查身份验证用户名。如果找到匹配项，mongod 或 mongos 就会进行转换，并使用输出结果对用户进行身份验证。mongod 或 mongos 不会检查数组中的其余文档。

如果给定文档与提供的身份验证名称不匹配，mongod 或 mongos 会继续在文档列表中查找其他匹配项。如果在任何文档中都没有找到匹配项，或者文档描述的转换失败，mongod 或 mongos 将返回错误信息。

如果由于 LDAP 服务器的联网或身份验证失败而无法评估其中一个转换，mongod 或 mongos 还会返回错误。mongod 或 mongos 会拒绝连接请求，不检查数组中的其余文件。

从 MongoDB 5.0 开始，userToDNMapping 接受空字符串 "" 或空数组 [ ] 来代替映射文档。如果向 userToDNMapping 提供空字符串或空数组，MongoDB 会将经过身份验证的用户名映射为 LDAP DN。以前，提供空映射文档会导致映射失败。

例子

下面展示了两个转换文档。第一个文档匹配以 @ENGINEERING 结尾的任何字符串，将后缀前面的所有内容放入正则表达式捕获组中。第二个文档匹配以 @DBA 结尾的任何字符串，将后缀前面的所有内容放入正则表达式捕获组中。

重要

必须将数组作为字符串传递给 UserToDNMapping。

"[
   {
      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})"
   }
]"

用户名为 alice@ENGINEERING.EXAMPLE.COM 的用户匹配第一个文档。正则表达式捕获群组 {0} 对应于字符串 alice。生成的输出是 DN "cn=alice,ou=engineering,dc=example,dc=com"。

用户名为 bob@DBA.EXAMPLE.COM 的用户匹配第二个文档。正则表达式捕获群组 {0} 对应于字符串 bob。生成的输出是 LDAP 查询 "ou=dba,dc=example,dc=com??one?(user=bob)"。mongod 或 mongos 对 LDAP 服务器执行该查询，并返回结果 "cn=bob,ou=dba,dc=example,dc=com"。

如果未设置 userToDNMapping，则在尝试通过 LDAP 服务器对用户进行身份验证或授权时，mongod 或 mongos 不会对用户名进行转换。

可以在运行中的 mongod 或 mongos 上使用 setParameter 数据库命令配置此设置。

security.ldap.authz.queryTemplate

类型：字符串

仅在 MongoDB Enterprise 中可用。

格式符合 RFC4515 和 RFC4516 的相对 LDAP 查询 URL，由 mongod 执行，以获取已验证用户所属的 LDAP 组。查询相对于在 security.ldap.servers 中指定的一台或多台主机。

注意

为了获得更好的性能，可以考虑将用于 MongoDB 授权的 LDAP 群组放入各自的组织单位 (OU)。

在 URL 中，可以使用以下替换令牌：

替换令牌	说明
{USER}	使用经过身份验证的用户名进行替换，或者，如果指定了 userToDNMapping，则使用 transformed 用户名进行替换。
{PROVIDED_USER}	替换所提供的用户名，即在身份验证或 LDAP transformation 之前。

构造查询 URL 时，请确保 LDAP 参数的顺序遵循 RFC4516：

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

如果您的查询包含一个属性，则 mongod 会假定该查询检索该实体所属的 DN 的列表。

如果查询不包含属性，则 mongod 假定该查询检索用户所属的所有实体。

对于查询返回的每个 LDAP DN，mongod 都会在 admin 数据库中为授权用户分配相应的角色。如果 admin 数据库上的角色与 DN 完全匹配，mongod 将向用户授予该角色以及分配给该角色的权限。有关创建角色的信息，请参阅 db.createRole() 方法，了解创建角色的更多信息。

例子

此 LDAP 查询返回 LDAP 用户对象的 memberOf 属性中列出的所有群组。

"{USER}?memberOf?base"

您的 LDAP 配置可能不包含 memberOf 属性作为用户架构的一部分，可能具有不同的属性来报告组成员身份，或者可能无法通过属性跟踪组成员身份。根据您自己独特的 LDAP 配置来配置您的查询。

如果未设置，mongod 将无法使用 LDAP 对用户进行授权。

可以在运行中的 mongod 上配置此设置，但需使用 setParameter 数据库命令。

注意

对 RFC4515、 RFC4516 或 LDAP 查询的解释超出了 MongoDB 文档的范围。请直接查看 RFC 或使用您首选的 LDAP 资源。

security.ldap.validateLDAPServerConfig

类型：布尔值

默认值：true

在 MongoDB Enterprise 中可用

一个标志，用于确定 mongod 或 mongos 实例是否在启动时检查 LDAP server(s) 的可用性：

• 如果为 true，mongod 或 mongos 实例会执行可用性检查，并且仅在 LDAP 服务器可用时才会继续启动。

• 如果为 false，mongod 或 mongos 实例将跳过可用性检查；也就是说，即使 LDAP 服务器不可用，实例也会启动。

LDAP Parameters

setParameter.ldapUserCacheInvalidationInterval

类型：int

默认值：30

用于与使用自管理部署上的 LDAP 授权的 mongod 服务器一起使用。

mongod 在外部用户缓存刷新之间的等待间隔（以秒为单位）。mongod 刷新外部用户缓存后，下次获得 LDAP 授权的用户发出操作时，MongoDB 会从 LDAP 服务器重新获取授权数据。

增加指定的值会增加 mongod 和 LDAP 服务器不同步的时间，但会减少 LDAP 服务器上的负载。相反，减少指定的值会缩短 mongod 和 LDAP 服务器不同步的时间，但会增加 LDAP 服务器上的负载。

setParameter:
   ldapUserCacheInvalidationInterval: <int>

storage.wiredTiger 选项

storage:
   wiredTiger:
      engineConfig:
         cacheSizeGB: <number>
         journalCompressor: <string>
         directoryForIndexes: <boolean>
         maxCacheOverflowFileSizeGB: <number>
      collectionConfig:
         blockCompressor: <string>
      indexConfig:
         prefixCompression: <boolean>

storage.wiredTiger.engineConfig.cacheSizeGB

类型：浮点

定义 WiredTiger 用于所有数据的内部缓存的最大大小。索引构建消耗的内存（请参阅 maxIndexBuildMemoryUsageMegabytes）与 WiredTiger 缓存内存是分开的。

取值范围可以从 0.25 GB 到 10000 GB 不等。

默认 WiredTiger 内部缓存大小为以下两者中的较大者：

• （RAM 大小 - 1 GB）的 50%，或

• 256 MB.

例如，在总 RAM 为 4GB 的系统上，WiredTiger 缓存使用 1.5GB RAM (0.5 * (4 GB - 1 GB) = 1.5 GB)。相反，在总 RAM 为 1.25GB 的系统上，WiredTiger 为 WiredTiger 缓存分配了 256 MB，因为这大于总 RAM 的一半减去 1 GB (0.5 * (1.25 GB - 1 GB) = 128 MB < 256 MB)。

注意

在某些情况下，比如在容器中运行时，数据库的内存约束可以低于系统总内存。在此类情况下，将此内存限制而非系统总内存用作最大可用 RAM。

如需查看内存限制，请参阅 hostInfo.system.memLimitMB。

避免将 WiredTiger 内部缓存大小增加到超过其默认值。

借助 WiredTiger，MongoDB 可同时利用 WiredTiger 内部缓存和文件系统缓存。

借助文件系统缓存，MongoDB 会自动使用 WiredTiger 缓存或其他进程未使用的所有空闲内存。

注意

storage.wiredTiger.engineConfig.cacheSizeGB 限制了 WiredTiger 内部缓存的大小。操作系统使用可用的空闲内存进行文件系统缓存，这允许压缩的 MongoDB 数据文件保留在内存中。此外，操作系统使用任何空闲 RAM 来缓冲文件系统块和文件系统缓存。

为了容纳额外的 RAM 用户，您可能必须减少 WiredTiger 的内部缓存大小。

默认 WiredTiger 内部缓存大小值假设每台计算机有一个 mongod 实例。如果一台机器包含多个 MongoDB 实例，则应减少该设置以容纳其他 mongod 实例。

如果您在某一容器（例如，lxc、cgroups、Docker 等）中运行 mongod，而这一容器无权访问系统中的全部可用 RAM，请将 storage.wiredTiger.engineConfig.cacheSizeGB 的值设置为小于容器中可用 RAM 数量的值。确切的数量取决于容器中运行的其他进程。请参阅 memLimitMB。

storage.wiredTiger.engineConfig.journalCompressor

默认值：snappy

指定用于压缩 WiredTiger 日志数据的压缩类型。

可用的压缩类型有：

• none

• snappy

• zlib

• zstd

storage.wiredTiger.engineConfig.directoryForIndexes

类型：布尔值

默认：false

当 storage.wiredTiger.engineConfig.directoryForIndexes 为 true 时，mongod 将索引和集合存储在数据（即 storage.dbPath）目录下单独的子目录中。具体来说，mongod 将索引存储在名为 index 的子目录中，并将集合数据存储在名为 collection 的子目录中。

您可以使用符号链接，为索引指定不同的位置。具体而言，当 mongod 实例未运行时，将 index 子目录移至目标并在数据目录下创建一个名为 index 的符号链接，指向新目标。

storage.wiredTiger.engineConfig.zstdCompressionLevel

类型：整型

默认：6

指定使用 zstd 压缩器时的压缩级别。

数值范围从 1 到 22。

zstdCompressionLevel 的指定值越高，应用的压缩率就越高。

仅当 blockCompressor 设置为 zstd 时适用。

从 MongoDB 5.0 开始提供

storage.wiredTiger.collectionConfig.blockCompressor

默认值：snappy

指定集合数据的默认压缩类型。创建集合时，您可以针对每个集合覆盖此设置。

可用的压缩类型有：

• none

• snappy

• zlib

• zstd

storage.wiredTiger.collectionConfig.blockCompressor 会影响创建的所有集合。如果在现有 MongoDB 部署上更改 storage.wiredTiger.collectionConfig.blockCompressor 的值，则所有新集合都将使用指定的压缩程序。现有集合继续使用创建时的指定压缩程序，或当时的默认压缩程序。

storage.wiredTiger.indexConfig.prefixCompression

默认值：true

为索引数据启用或禁用前缀压缩。

为 storage.wiredTiger.indexConfig.prefixCompression 指定 true 可对索引数据启用前缀压缩，指定 false 可为索引数据禁用前缀压缩。

storage.wiredTiger.indexConfig.prefixCompression 设置会影响创建的所有索引。如果在现有 MongoDB 部署上更改 storage.wiredTiger.indexConfig.prefixCompression 的值，则所有新索引都将使用前缀压缩。现有索引不受影响。

storage.inmemory 选项

storage:
   inMemory:
      engineConfig:
         inMemorySizeGB: <number>

storage.inMemory.engineConfig.inMemorySizeGB

类型：浮点

默认值：物理 RAM 的 50% 减去 1 GB

值的范围可以从 256 MB 到 10 TB，并且可以是浮点数。

为内存存储引擎数据分配的最大内存量，包括索引、oplog（如果 mongod 是副本集的一部分）、副本集或分片集群元数据等。

默认情况下，内存存储引擎使用物理 RAM 大小减去 1 GB 后的 50%。

注意

Enterprise 版功能

仅在 MongoDB Enterprise 中可用。