Skip to content

Commit 3af173d

Browse files
sam-githubtargos
authored andcommitted
doc: link and expand --tls-cipher-list docs
Link to the cli docs for --tls-cipher-list, and link to and mention that NODE_OPTIONS can also be used. PR-URL: #25174 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
1 parent 88e7386 commit 3af173d

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

doc/api/tls.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -169,12 +169,16 @@ HIGH:
169169
!CAMELLIA
170170
```
171171

172-
This default can be replaced entirely using the `--tls-cipher-list` command
173-
line switch. For instance, the following makes
174-
`ECDHE-RSA-AES128-GCM-SHA256:!RC4` the default TLS cipher suite:
172+
This default can be replaced entirely using the [`--tls-cipher-list`][] command line
173+
switch (directly, or via the [`NODE_OPTIONS`][] environment variable). For
174+
instance, the following makes `ECDHE-RSA-AES128-GCM-SHA256:!RC4` the default
175+
TLS cipher suite:
175176

176177
```sh
177-
node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"
178+
node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4" server.js
179+
180+
export NODE_OPTIONS=--tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"
181+
node server.js
178182
```
179183

180184
The default can also be replaced on a per client or server basis using the
@@ -1412,6 +1416,8 @@ where `secureSocket` has the same API as `pair.cleartext`.
14121416

14131417
[`'secureConnect'`]: #tls_event_secureconnect
14141418
[`'secureConnection'`]: #tls_event_secureconnection
1419+
[`--tls-cipher-list`]: cli.html#cli_tls_cipher_list_list
1420+
[`NODE_OPTIONS`]: cli.html#cli_node_options_options
14151421
[`SSL_CTX_set_timeout`]: https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_timeout.html
14161422
[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
14171423
[`dns.lookup()`]: dns.html#dns_dns_lookup_hostname_options_callback

0 commit comments

Comments
 (0)