Skip to content

Commit 1b81b34

Browse files
sam-githubBridgeAR
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 104b076 commit 1b81b34

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
@@ -906,7 +906,10 @@ changes:
906906
protocol name. Passing an array is usually much simpler, e.g.
907907
`['hello', 'world']`.
908908
* `servername`: {string} Server name for the SNI (Server Name Indication) TLS
909-
extension. It must be a host name, and not an IP address.
909+
extension. It is the name of the host being connected to, and must be a host
910+
name, and not an IP address. It can be used by a multi-homed server to
911+
choose the correct certificate to present to the client, see the
912+
`SNICallback` option to [`tls.createServer()`][].
910913
* `checkServerIdentity(servername, cert)` {Function} A callback function
911914
to be used (instead of the builtin `tls.checkServerIdentity()` function)
912915
when checking the server's hostname (or the provided `servername` when

0 commit comments

Comments
 (0)