From 31441f42c43d2459f68c94bc7be2f7920d1789ee Mon Sep 17 00:00:00 2001 From: Sam Roberts Date: Wed, 7 Nov 2018 13:25:52 -0800 Subject: [PATCH] doc: describe what tls servername is for Docs should describe the purpose of the option. PR-URL: https://github.com/nodejs/node/pull/24236 Reviewed-By: Anna Henningsen Reviewed-By: Colin Ihrig --- doc/api/tls.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/api/tls.md b/doc/api/tls.md index 12ed2cf16aa8d2..12786e111b7ce6 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -892,7 +892,10 @@ changes: first byte is the length of the next protocol name. Passing an array is usually much simpler, e.g. `['hello', 'world']`. * `servername`: {string} Server name for the SNI (Server Name Indication) TLS - extension. It must be a host name, and not an IP address. + extension. It is the name of the host being connected to, and must be a host + name, and not an IP address. It can be used by a multi-homed server to + choose the correct certificate to present to the client, see the + `SNICallback` option to [`tls.createServer()`][]. * `checkServerIdentity(servername, cert)` {Function} A callback function to be used (instead of the builtin `tls.checkServerIdentity()` function) when checking the server's hostname (or the provided `servername` when