Skip to content

Commit edc0d69

Browse files
committed
NATS docs update.
1 parent 56d2a3b commit edc0d69

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

Diff for: docs/adapters/nats.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -647,10 +647,11 @@ If a Password is configured then the Username must be configured as well.
647647

648648
---
649649
### Tls
650-
While authentication restricts the number of clients that can connect, TLS can be employed to encrypt traffic between the client and server, verifying the server's identity. Furthermore, in the most secure version of TLS (NATS), the server can be configured to verify the client's identity, thereby authenticating it. Upon initiating TLS mode, a nats-server will mandate that all clients connect using TLS.
651-
Additionally, if configured to utilize TLS, client libraries will fail to establish connections to servers without TLS.
652650

653-
**Type**: [CertificateConfiguration](../core/certificate-configuration.md)
651+
From the [NATS-docs](
652+
): *While authentication limits which clients can connect, TLS can be used to encrypt traffic between client/server and check the server's identity. Additionally - in the most secure version of TLS with NATS - the server can be configured to verify the client's identity, thus authenticating it. When started in TLS mode, a nats-server will require all clients to connect with TLS. Moreover, if configured to connect with TLS, client libraries will fail to connect to a server without TLS.*
653+
654+
**Type**: [TlsConfiguration](../core/certificate-configuration.md)
654655

655656

656657
https://docs.nats.io/using-nats/developer/connecting/tls
@@ -669,12 +670,12 @@ https://docs.nats.io/using-nats/developer/connecting/token
669670

670671
---
671672
### Url
672-
Server url
673+
Server URL(s) for connecting to the NATS server.
673674

674675
**Type**: String
675676

676-
The schema for the url can be "nats://", "tls://" or "tls://". If the scheme is "tls:" then
677-
the "Tls" property for the serer must be set to specify the required key and certificates.
677+
The schema for the url can be `nats://` or `tls://`. If the scheme is "tls:" then
678+
the "Tls" property for the server **could** also be set to specify the required key and certificates - for establishing `mTLS` secured auth.
678679

679680
Multiple urls can be configured for known all known servers as a comma separated list.
680681

Diff for: docs/targets/nats.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -374,9 +374,10 @@ If a Password is configured then the [Username](#username) must be configured as
374374
### Tls
375375
TLS configuration settings for secure communication with the NATS server.
376376

377-
While authentication limits which clients can connect, TLS can be used to encrypt traffic between client/server and check the server's identity. Additionally - in the most secure version of TLS with NATS - the server can be configured to verify the client's identity, thus authenticating it. When started in TLS mode, a nats-server will require all clients to connect with TLS. Moreover, if configured to connect with TLS, client libraries will fail to connect to a server without TLS.
377+
From the [NATS-docs](
378+
): *While authentication limits which clients can connect, TLS can be used to encrypt traffic between client/server and check the server's identity. Additionally - in the most secure version of TLS with NATS - the server can be configured to verify the client's identity, thus authenticating it. When started in TLS mode, a nats-server will require all clients to connect with TLS. Moreover, if configured to connect with TLS, client libraries will fail to connect to a server without TLS.*
378379

379-
**Type**: [TlsConfiguration](../core/transformation-operator-configuration.md)
380+
**Type**: [TlsConfiguration](../core/certificate-configuration.md)
380381

381382

382383
https://docs.nats.io/using-nats/developer/connecting/tls
@@ -400,8 +401,8 @@ https://docs.nats.io/using-nats/developer/connecting/token
400401
### Url
401402
Server URL(s) for connecting to the NATS server.
402403

403-
Supports "nats://", "tls://" schemes. When using "tls://" scheme, the Tls property must be configured with required certificates and keys.
404-
**Usage** : Can specify multiple server URLs as a comma-separated list for connecting to multiple known servers.
404+
The schema for the url can be `nats://` or `tls://`. If the scheme is "tls:" then
405+
the "Tls" property for the server **could** also be set to specify the required key and certificates - for establishing `mTLS` secured auth.
405406

406407

407408

0 commit comments

Comments
 (0)