diff options
author | Sam Roberts <vieuxtech@gmail.com> | 2018-11-07 13:25:52 -0800 |
---|---|---|
committer | Sam Roberts <vieuxtech@gmail.com> | 2018-11-09 16:22:18 -0800 |
commit | 27cdb36b103be1b7045bdbc77237d9f3dd8b0a33 (patch) | |
tree | 3d698cce38a5d16622fbc284b1c056856084cbe3 /doc | |
parent | 426ca0837a41501e5477cd381ec562349e010a3f (diff) | |
download | android-node-v8-27cdb36b103be1b7045bdbc77237d9f3dd8b0a33.tar.gz android-node-v8-27cdb36b103be1b7045bdbc77237d9f3dd8b0a33.tar.bz2 android-node-v8-27cdb36b103be1b7045bdbc77237d9f3dd8b0a33.zip |
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 <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/tls.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index ec36b4e571..b562c11b36 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -906,7 +906,10 @@ changes: 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 |