snooty.toml

name = "docs"
title = "MongoDB Manual"

sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"

intersphinx = [
    "https://pymongo.readthedocs.io/en/stable/objects.inv",
    "https://motor.readthedocs.io/en/stable/objects.inv",
    "https://www.mongodb.com/docs/atlas/objects.inv",
    "https://www.mongodb.com/docs/php-library/upcoming/objects.inv",
    "https://www.mongodb.com/docs/compass/current/objects.inv",
    "https://www.mongodb.com/docs/database-tools/objects.inv",
    "https://www.mongodb.com/docs/mongodb-shell/objects.inv",
]

# toc_landing_pages are pages that have pages nested beneath them
# and **should** open when a user clicks on that page in the TOC
# (i.e. they're not drawers)
toc_landing_pages = [
   "/administration",
   "/administration/analyzing-mongodb-performance",
   "/administration/backup-sharded-clusters",
   "/administration/configuration-and-maintenance",
   "/administration/connection-pool-overview",
   "/administration/health-managers",
   "/administration/install-community",
   "/administration/install-enterprise-linux",
   "/administration/install-enterprise",
   "/administration/install-on-linux/",
   "/administration/monitoring",
   "/administration/replica-set-deployment",
   "/administration/replica-set-maintenance",
   "/administration/replica-set-member-configuration",
   "/administration/sharded-cluster-administration",
   "/administration/sharded-cluster-config-servers",
   "/administration/upgrade-community-to-enterprise",
   "/aggregation",
   "/applications/indexes",
   "/applications/replication",
   "/changeStreams",
   "/core/2d",
   "/core/2dsphere",
   "/core/aggregation-pipeline",
   "/core/auditing",
   "/core/authentication-mechanisms-enterprise",
   "/core/authentication-mechanisms",
   "/core/authentication",
   "/core/authorization",
   "/core/backups",
   "/core/crud",
   "/core/csfle",
   "/core/csfle/fundamentals/",
   "/core/csfle/reference",
   "/core/csfle/tutorials",
   "/core/databases-and-collections",
   "/core/geohaystack",
   "/core/index-creation",
   "/core/index-multikey",
   "/core/index-text",
   "/core/index-ttl",
   "/core/index-wildcard",
   "/core/journaling",
   "/core/kerberos",
   "/core/map-reduce",
   "/core/query-optimization",
   "/core/read-isolation-consistency-recency",
   "/core/read-preference",
   "/core/replica-set-architectures",
   "/core/replica-set-high-availability",
   "/core/replica-set-members",
   "/core/replica-set-secondary",
   "/core/security-encryption-at-rest",
   "/core/queryable-encryption/",
   "/core/queryable-encryption/fundamentals/",
   "/core/queryable-encryption/tutorials/",
   "/core/queryable-encryption/reference/",
   "/core/security-hardening",
   "/core/security-internal-authentication",
   "/core/security-ldap",
   "/core/security-scram",
   "/core/security-transport-encryption",
   "/core/security-users",
   "/core/security-x.509",
   "/core/sharded-cluster-components",
   "/core/sharding-change-a-shard-key",
   "/core/sharding-balancer-administration",
   "/core/sharding-data-partitioning",
   "/core/sharding-shard-key",
   "/core/storage-engines",
   "/core/timeseries-collections",
   "/core/timeseries-collections/timeseries-shard-collection",
   "/core/transactions",
   "/core/views",
   "/core/wiredtiger",
   "/core/zone-sharding",
   "/core/zone-sharding",
   "/crud",
   "/geospatial-queries",
   "/indexes",
   "/installation",
   "/introduction",
   "/mongo",
   "/reference/aggregation",
   "/reference/bson-types",
   "/reference/collation",
   "/reference/command",
   "/reference/command/nav-administration",
   "/reference/command/nav-aggregation",
   "/reference/command/nav-auditing",
   "/reference/command/nav-authentication",
   "/reference/command/nav-crud",
   "/reference/command/nav-diagnostic",
   "/reference/command/nav-free-monitoring",
   "/reference/command/nav-geospatial",
   "/reference/command/nav-plan-cache",
   "/reference/command/nav-replication",
   "/reference/command/nav-role-management",
   "/reference/command/nav-sessions",
   "/reference/command/nav-sharding",
   "/reference/command/nav-user-management",
   "/reference/configuration-options",
   "/reference/method",
   "/reference/method/js-bulk",
   "/reference/method/js-client-side-field-level-encryption",
   "/reference/method/js-collection",
   "/reference/method/js-connection",
   "/reference/method/js-constructor",
   "/reference/method/js-cursor",
   "/reference/method/js-database",
   "/reference/method/js-free-monitoring",
   "/reference/method/js-native",
   "/reference/method/js-native-legacy",
   "/reference/method/js-plan-cache",
   "/reference/method/js-replication",
   "/reference/method/js-role-management",
   "/reference/method/js-sharding",
   "/reference/method/js-user-management",
   "/reference/mongo",
   "/reference/mongodb-wire-protocol/",
   "/reference/operator/aggregation-pipeline",
   "/reference/operator/aggregation",
   "/reference/operator/query-array",
   "/reference/operator/query-bitwise",
   "/reference/operator/query-comparison",
   "/reference/operator/query-element",
   "/reference/operator/query-evaluation",
   "/reference/operator/query-geospatial",
   "/reference/operator/query-logical",
   "/reference/operator/query-miscellaneous",
   "/reference/operator/query-modifiers",
   "/reference/operator/query-projection",
   "/reference/operator/query",
   "/reference/operator/update-array",
   "/reference/operator/update-bitwise",
   "/reference/operator/update-field",
   "/reference/operator/update",
   "/reference/read-concern",
   "/reference/replication",
   "/reference/security",
   "/reference/sharding",
   "/reference/stable-api",
   "/release-notes/2.4",
   "/release-notes/2.6",
   "/release-notes/3.0",
   "/release-notes/3.2-compatibility",
   "/release-notes/3.2",
   "/release-notes/3.4-downgrade",
   "/release-notes/3.4",
   "/release-notes/3.6",
   "/release-notes/4.0",
   "/release-notes/4.2-downgrade",
   "/release-notes/4.2",
   "/release-notes/4.4-downgrade",
   "/release-notes/4.4",
   "/release-notes/5.0",
   "/release-notes/5.1",
   "/release-notes/5.2",
   "/release-notes/5.3",
   "/release-notes/6.0",
   "/replication",
   "/security",
   "/sharding",
   "/storage",
   "/text-search",
   "/tutorial/insert-documents",
   "/tutorial/install-mongodb-enterprise-on-amazon",
   "/tutorial/install-mongodb-enterprise-on-debian",
   "/tutorial/install-mongodb-enterprise-on-os-x",
   "/tutorial/install-mongodb-enterprise-on-red-hat",
   "/tutorial/install-mongodb-enterprise-on-suse",
   "/tutorial/install-mongodb-enterprise-on-ubuntu",
   "/tutorial/install-mongodb-enterprise-on-windows",
   "/tutorial/install-mongodb-on-amazon",
   "/tutorial/install-mongodb-on-debian",
   "/tutorial/install-mongodb-on-os-x",
   "/tutorial/install-mongodb-on-red-hat",
   "/tutorial/install-mongodb-on-suse",
   "/tutorial/install-mongodb-on-ubuntu",
   "/tutorial/install-mongodb-on-windows",
   "/tutorial/manage-the-database-profiler",
   "/tutorial/query-documents",
   "/tutorial/remove-documents",
   "/tutorial/update-documents",
]

[substitutions]
bi = "MongoDB Connector for BI"
compass = "MongoDB Compass"
copy = "©"
ent-build = "MongoDB Enterprise"
lts = "Major"
mdb-shell = "MongoDB Shell"
sbe = "slot-based query execution engine"
sbe-short = "slot-based engine"
sbe-title = "Slot-Based Query Execution Engine"
version = "{+version+}"
year = "2022"


[constants]
package-branch = "testing" # testing for dev rc releases
windows-dir-version = "6.0" # wizard
package-name-org = "mongodb-org"
package-name-enterprise = "mongodb-enterprise"
package-name = "mongodb"
version = "6.0"
latest-lts-version = "6.0"
release = "6.0.0"
version-dev = "6.0"
pgp-version = "{+version+}"
rsa-key = "4B7C549A058F8B6B"
pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F  718D 4B7C 549A 058F 8B6B"
pgp-short-fingerprint = "0x4B7C549A058F8B6B"
windows-sha256 = "C777DF7816BB8C9A760FDEA782113949408B6F39D72BE29A2551FA51E2FE0473"
source-available = ":github:`source available and free to use <mongodb/mongo>`"
csfle = "Client-Side Field Level Encryption"
csfle-abbrev = "CSFLE"
kms-long = "Key Management System"
kms-abbr = ":abbr:`KMS ({+kms-long+})`"
km-service-long = "Key Management Service"
cmk-long = "Customer Master Key"
cmk-abbr = ":abbr:`CMK ({+cmk-long+})`"
dek-long = "Data Encryption Key"
dek-abbr = ":abbr:`DEK ({+dek-long+})`"
dek-abbr-no-hover = "DEK"
key-vault-long = "Key Vault collection"
key-vault-long-title = "Key Vault Collection"
java-driver-version = "4.6"
java-driver-api = "https://mongodb.github.io/mongo-java-driver/{+java-driver-version+}/apidocs"
aws-abbr = ":abbr:`AWS (Amazon Web Services)`"
aws-iam-abbr = ":abbr:`IAM (Identity and Access Management)`"
aws-arn-abbr = ":abbr:`ARN (Amazon Resource Name)`"
aws-long = "Amazon Web Services"
azure-kv = "Azure Key Vault"
gcp-kms = "Google Cloud Key Management Service"
gcp-kms-abbr = "Google Cloud KMS"
manual-enc = "manual encryption"
manual-enc-title = "Manual Encryption"
manual-enc-first = "Manual encryption"
kmip-hover = ":abbr:`KMIP (Key Management Interoperability Protocol)`"
kmip-kms-no-hover = "KMIP-compliant Key Management System"
kmip-kms = "{+kmip-hover+}-compliant {+kms-abbr+}"
csfle-code-snippets-gen-keys = "https://github.com/mongodb/docs/tree/master/source/includes/quick-start/generate-master-key"
libmongocrypt-version = "1.4"
sample-app-url-csfle = "https://github.com/mongodb/docs/tree/master/source/includes/sample_apps/csfle/build/"
sample-app-url-qe = "https://github.com/mongodb/docs/tree/master/source/includes/sample_apps/csfle/build/"
qe = "Queryable Encryption"
qe-abbr = ":abbr:`QE (Queryable Encryption)`"
enc-fields-map = "encrypted fields map"
enc-fields-map-title = "Encrypted Fields Map"
shared-library = "Automatic Encryption Shared Library"
shared-library-package = "``crypt_shared``"
efm = "``encryptedFieldsMap``"
auto-encrypt-options = "autoEncryptionOpts"
title-auto-encrypt-options = "AutoEncryptionOpts"


[[banners]]
targets = [
    "core/queryable-encryption.txt",
    "core/queryable-encryption/*.txt",
    "core/queryable-encryption/*/*.txt",
]

variant = "danger"
value = """
    Queryable Encryption is in Public Preview and available for \
    evaluation purposes. Public Preview is not recommended for \
    production deployments as breaking changes may be introduced. \
    To learn more about the Preview please see the \
    `Queryable Encryption Preview <https://www.mongodb.com/blog/post/mongodb-releases-queryable-encryption-preview/>`__ \
    blog post.
    """

[[banners]]
targets = ["core/csfle.txt", "core/csfle/*.txt", "core/csfle/*/*.txt"]

variant = "tip"
value = """
    The next-generation Queryable Encryption feature is now in Public Preview. \
    To learn more about Queryable Encryption, see :ref:`qe-manual-feature-qe`.
    """

[bundle]
manpages = "manpages.tar.gz"

[manpages.mongokerberos]
file = "reference/program/mongokerberos.txt"
title = "mongokerberos"
section = 1

[manpages.mongoreplay]
file = "reference/program/mongoreplay.txt"
title = "mongoreplay"
section = 1

[manpages.mongos]
file = "reference/program/mongos.txt"
title = "mongos"
section = 1

[manpages.mongod]
file = "reference/program/mongod.txt"
title = "mongod"
section = 1

[manpages.mongoldap]
file = "reference/program/mongoldap.txt"
title = "mongoldap"
section = 1

[manpages.mongo]
file = "reference/program/mongo.txt"
title = "mongo"
section = 1

[manpages.mongodb-parameters]
file = "reference/parameters.txt"
title = "MongoDB setParameter Options"
section = 5