From 9aefb1417f749ecb1ea600516b1e8164d5339e12 Mon Sep 17 00:00:00 2001 From: starbirdtech383 Date: Wed, 17 Jan 2024 22:08:07 +0530 Subject: [PATCH] chore: documentation of data sources with ssl --- .../100.data-sources/020.connect-to-data-source.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md b/packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md index 0c50e8f33d..c3d3dd24ab 100644 --- a/packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md +++ b/packages/noco-docs/docs/100.data-sources/020.connect-to-data-source.md @@ -1,7 +1,7 @@ --- title: 'Connect to a Data source' description: 'Learn how to connect to an external data-source (PG/MySQL) in NocoDB.' -tags: ['Data Sources', 'Connect', 'External', 'PG', 'MySQL'] +tags: ['Data Sources', 'Connect', 'External', 'PG', 'MySQL', 'mtls', 'tls', 'ssl'] keywords: ['NocoDB data source', 'connect data source', 'external data source', 'PG data source', 'MySQL data source'] --- @@ -23,6 +23,14 @@ To connect to an external data source, follow the steps below: | Database | Name of the database to connect to | | Schema name | Name of the schema to connect to | +4a. Optionally, if the connection required is TLS/MTLS for MITM protection, follow these additional steps below: + + - Click on `SSL & Advanced Parameters`, \ + - Select `SSL Mode` and upload the client certificate, client key, and Root CA files by clicking on the file. + \ + Note: The entire connection parameters can be viewed in json form by clicking on the "Edit connection JSON" and edited as required by database server type.\ + Example: In PostgreSQL with SSL mode set to "Required-Identity," if the server certificate's common name (cname) differs from the actual DNS/IP used for connection, the connection may fail. To resolve this, add a "servername" property with the cname value under the SSL section, along with certificate information. Additional details are available in the Knex configuration options.[knex configuration options](https://knexjs.org/guide/#configuration-options) + 5. Click on `Test Database Connection` button to verify the connection 6. Wait for the connection to be verified. - After connection is successful, `Submit` button will be enabled.