Skip to content

Commit 31441f4

Browse files
sam-githubMylesBorins
authored andcommitted
doc: describe what tls servername is for
Docs should describe the purpose of the option. PR-URL: #24236 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 0c206e0 commit 31441f4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/api/tls.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -892,7 +892,10 @@ changes:
892892
first byte is the length of the next protocol name. Passing an array is
893893
usually much simpler, e.g. `['hello', 'world']`.
894894
* `servername`: {string} Server name for the SNI (Server Name Indication) TLS
895-
extension. It must be a host name, and not an IP address.
895+
extension. It is the name of the host being connected to, and must be a host
896+
name, and not an IP address. It can be used by a multi-homed server to
897+
choose the correct certificate to present to the client, see the
898+
`SNICallback` option to [`tls.createServer()`][].
896899
* `checkServerIdentity(servername, cert)` {Function} A callback function
897900
to be used (instead of the builtin `tls.checkServerIdentity()` function)
898901
when checking the server's hostname (or the provided `servername` when

0 commit comments

Comments
 (0)