Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix few typos & add SNI in connection docs #7698

Merged
merged 4 commits into from
Oct 4, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions docs/reference/connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,14 @@ for production), or rely on ``edgedb project`` (recommended for development).
such, explicitly provided parameters are given the highest priority.

In the context of the client libraries, this means passing an option
explicitly into the ``connect`` call. Here's how this looks using the
explicitly into the ``client creation`` call. Here's how this looks using the
JavaScript library:

.. code-block:: javascript

import * as edgedb from "edgedb";

const pool = await edgedb.connect({
const pool = await edgedb.createClient({
instance: "my_instance"
});

Expand Down Expand Up @@ -318,6 +318,8 @@ instance-level configuration object.
- ``--password <pass>``
* - ``EDGEDB_TLS_CA_FILE``
- ``--tls-ca-file <path>``
* - ``EDGEDB_TLS_SERVER_NAME``
- ``--tls-server-name``
* - ``EDGEDB_CLIENT_TLS_SECURITY``
- ``--tls-security``
* - ``EDGEDB_CLIENT_SECURITY``
Expand Down Expand Up @@ -373,14 +375,19 @@ instance-level configuration object.
and provide a path to its location on the filesystem. Otherwise TLS will fail
to connect.

**EDGEDB_TLS_SERVER_NAME**
Sometimes the target instance address cannot be resolved correctly
from a hostname. In those cases it is required to provide SNI for proper TLS
verification. It is also required for tenant selection in a multi-tenant environment.

**EDGEDB_CLIENT_TLS_SECURITY**
Sets the TLS security mode. Determines whether certificate and hostname
verification is enabled. Possible values:

- ``"strict"`` (**default**) — certificates and hostnames will be verified
- ``"no_host_verification"`` — verify certificates but not hostnames
- ``"insecure"`` — client libraries will trust self-signed TLS certificates.
useful for self-signed or custom certificates.
Useful for self-signed or custom certificates.

This setting defaults to ``"strict"`` unless a custom certificate is
supplied, in which case it is set to ``"no_host_verification"``.
Expand Down Expand Up @@ -419,7 +426,7 @@ modified DSN: ``edgedb://newuser:[email protected]:5656``.
Overriding across priority levels
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This override behavior only happens *same or lower priority level*. For
Override behavior can only happen at the *same or lower priority level*. For
instance:

- ``EDGEDB_PASSWORD`` **will** override the password specified in
Expand Down
Loading