diff --git a/config/redirects b/config/redirects index 41ebcfd26..9bcc1f451 100644 --- a/config/redirects +++ b/config/redirects @@ -43,7 +43,7 @@ raw: ${prefix}/master -> ${base}/upcoming/ [v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/ [v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/mongoclient [v5.3-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/ diff --git a/snooty.toml b/snooty.toml index 5c13d89a4..e550a15d9 100644 --- a/snooty.toml +++ b/snooty.toml @@ -9,10 +9,12 @@ intersphinx = [ toc_landing_pages = [ "/get-started", "/connection", + "/connection/specify-connection-options", "/crud", "/crud/builders", "/data-formats", "/api-documentation", + "/security", "/security/auth" ] diff --git a/source/connection.txt b/source/connection.txt index 47d48f2ff..1f8cdbdb8 100644 --- a/source/connection.txt +++ b/source/connection.txt @@ -1,4 +1,4 @@ -.. _java-connection-guide: +.. _java-connection-uri-guide: ================ Connection Guide @@ -6,15 +6,9 @@ Connection Guide .. toctree:: - Connect to MongoDB - Connection Options - MongoClient Settings - Stable API - Connection Pools - Network Compression - JNDI Datasource + Create a MongoClient + Specify Connection Options Connection Troubleshooting - AWS Lambda .. contents:: On this page :local: @@ -29,14 +23,9 @@ Learn how to set up a connection and specify connection behavior from your application to a MongoDB deployment using the driver in the following sections: -- :ref:`Connect to MongoDB ` -- :ref:`View a List of Connection Options ` -- :ref:`Specify Connection Behavior with the MongoClient Class ` -- :ref:`Enable Network Compression ` -- :ref:`Enable TLS/SSL on a Connection ` -- :ref:`Connect to MongoDB by Using a SOCKS5 Proxy ` -- :ref:`Connect to MongoDB by Using a JNDI Datasource ` -- :atlas:`Connect to MongoDB Atlas from AWS Lambda ` +- :ref:`Create a MongoClient ` +- :ref:`Specify Connection Options ` +- :ref:`Connection Troubleshooting ` For information about authenticating with a MongoDB instance, see the :ref:`` section. diff --git a/source/connection/connection-troubleshooting.txt b/source/connection/connection-troubleshooting.txt index 79315612f..d678ae409 100644 --- a/source/connection/connection-troubleshooting.txt +++ b/source/connection/connection-troubleshooting.txt @@ -245,7 +245,7 @@ against the connected secondary node if you set the read preference to You can also specify the ``serverSelectionTimeoutMS`` connection option to adjust the amount of time in which the driver must select a server. To -learn more, see the :ref:`java-connection-options` guide. +learn more, see the :ref:`java-connection-uri-options` guide. .. _java-miscellaneous-errors: diff --git a/source/connection/connect.txt b/source/connection/mongoclient.txt similarity index 99% rename from source/connection/connect.txt rename to source/connection/mongoclient.txt index a8e4c8169..e280a1f9f 100644 --- a/source/connection/connect.txt +++ b/source/connection/mongoclient.txt @@ -1,8 +1,9 @@ .. _java-connect-to-mongodb: +.. _java-mongoclient: -================== -Connect to MongoDB -================== +==================== +Create a MongoClient +==================== .. contents:: On this page :local: diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt new file mode 100644 index 000000000..c9b63fdbc --- /dev/null +++ b/source/connection/specify-connection-options.txt @@ -0,0 +1,31 @@ +.. _java-specify-connection-options: + +========================== +Specify Connection Options +========================== + +.. toctree:: + + MongoClient Settings + Connection URI Options + Stable API + Network Compression + JNDI Datasource + AWS Lambda + Connection Security Settings + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: connection string, URI, Atlas, code example + + +- :ref:`MongoClient Settings ` +- :ref:`Connection URI Options ` +- :ref:`Stable API ` +- :ref:`Network Compression ` +- :ref:`JNDI Datasource ` +- `AWS Lambda `__ +- :ref:`Connection Security Options ` \ No newline at end of file diff --git a/source/connection/connection-options.txt b/source/connection/specify-connection-options/connection-options.txt similarity index 98% rename from source/connection/connection-options.txt rename to source/connection/specify-connection-options/connection-options.txt index d2b20c693..2c2d0e862 100644 --- a/source/connection/connection-options.txt +++ b/source/connection/specify-connection-options/connection-options.txt @@ -1,12 +1,12 @@ -.. _java-connection-options: +.. _java-connection-uri-options: .. _connection-options: -================== -Connection Options -================== +====================== +Connection URI Options +====================== This section explains MongoDB connection and authentication options -supported by the driver. You can pass the connection options as +supported by the {+driver-short+}. You can pass the connection options as parameters of the connection URI to specify the behavior of the client. .. list-table:: diff --git a/source/connection/jndi.txt b/source/connection/specify-connection-options/jndi.txt similarity index 100% rename from source/connection/jndi.txt rename to source/connection/specify-connection-options/jndi.txt diff --git a/source/connection/mongoclientsettings.txt b/source/connection/specify-connection-options/mongoclientsettings.txt similarity index 100% rename from source/connection/mongoclientsettings.txt rename to source/connection/specify-connection-options/mongoclientsettings.txt diff --git a/source/connection/network-compression.txt b/source/connection/specify-connection-options/network-compression.txt similarity index 100% rename from source/connection/network-compression.txt rename to source/connection/specify-connection-options/network-compression.txt diff --git a/source/connection/specify-connection-options/security-connection-options.txt b/source/connection/specify-connection-options/security-connection-options.txt new file mode 100644 index 000000000..22af0fdb9 --- /dev/null +++ b/source/connection/specify-connection-options/security-connection-options.txt @@ -0,0 +1,21 @@ +.. _security-connection-settings: + +============================ +Connection Security Settings +============================ + +.. facet:: + :name: genre + :values: reference + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +MongoDB supports many options for securing your data before and during +transportation. For information about security options, see our :ref:`Security +section `, which includes the following: + +.. include:: /includes/security/security-pages.rst \ No newline at end of file diff --git a/source/connection/stable-api.txt b/source/connection/specify-connection-options/stable-api.txt similarity index 100% rename from source/connection/stable-api.txt rename to source/connection/specify-connection-options/stable-api.txt diff --git a/source/includes/security/security-pages.rst b/source/includes/security/security-pages.rst new file mode 100644 index 000000000..e0e9116f1 --- /dev/null +++ b/source/includes/security/security-pages.rst @@ -0,0 +1,5 @@ +- :ref:`Authentication ` +- :ref:`In-Use Encryption ` +- :ref:`TLS/SSL ` +- :ref:`SOCKS5 Proxy ` +- :ref:`Validate Driver Artifact Signatures ` \ No newline at end of file diff --git a/source/security.txt b/source/security.txt index 96762b1a6..15a5d2a07 100644 --- a/source/security.txt +++ b/source/security.txt @@ -1,3 +1,5 @@ +.. _java-security: + ======== Security ======== @@ -13,4 +15,12 @@ Security In-Use Encryption TLS/SSL SOCKS5 Proxy - Validate Driver Artifact Signatures \ No newline at end of file + Validate Driver Artifact Signatures + +Overview +-------- + +Learn how to set up security options for your application in the following +sections: + +.. include:: /includes/security/security-pages.rst \ No newline at end of file