Skip to content

Commit

Permalink
Merge pull request #683 from nats-io/update-readme
Browse files Browse the repository at this point in the history 
[DOC] added `handshakeFirst` tls option
[ci skip]
  • Loading branch information
@aricart
aricart committed Apr 8, 2024
2 parents 06d16f8 + f5ca307 commit ef8ada0
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
View file
Expand Up @@ -810,14 +810,15 @@ The following is the list of connection options and default values.

### TlsOptions

| Option | Default | Description |
| ---------- | ------- | ---------------------------- |
| `ca` | N/A | CA certificate |
| `caFile` | | CA certificate filepath |
| `cert` | N/A | Client certificate |
| `certFile` | N/A | Client certificate file path |
| `key` | N/A | Client key |
| `keyFile` | N/A | Client key file path |
| Option | Default | Description |
| ---------------- | ------- |---------------------------------------------------------------------------------------------------------------------------------|
| `ca` | N/A | CA certificate |
| `caFile` | | CA certificate filepath |
| `cert` | N/A | Client certificate |
| `certFile` | N/A | Client certificate file path |
| `key` | N/A | Client key |
| `keyFile` | N/A | Client key file path |
| `handshakeFirst` | false | Connects to the server directly as TLS rather than upgrade the connection. Note that the server must be configured accordingly. |

In some Node and Deno clients, having the option set to an empty option,
requires the client have a secured connection.
Expand Down

0 comments on commit ef8ada0

Please sign in to comment.