diff options
| author | Joel Hans <joel@netdata.cloud> | 2020-05-11 08:48:23 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-11 08:48:23 -0700 |
| commit | 74fda3de8e45e4211da8a574daabbfc30c74f0a9 (patch) | |
| tree | bcb5fb2a9ce32f759ca7bb139fb6e9da70e2126e /web/server | |
| parent | 9e8a0e173e2f4402fb081950b4b25d5fc0b62492 (diff) | |
Docs: Fix internal links and remove obsolete admonitions (#8946)
* Fixed a few more links
* Remove old syntax
* Abs-relative links to files in docs folder
* Trying to fix nother doc learn link
* Fix a few more links
* Add testing doc
* Tracking down mysteries
* Cleanup
* Update broken external links
* Remove index.html that appeared from testing
* Fix remainder of links
Diffstat (limited to 'web/server')
| -rw-r--r-- | web/server/README.md | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/web/server/README.md b/web/server/README.md index 9c7e8e137f..68ba56a668 100644 --- a/web/server/README.md +++ b/web/server/README.md @@ -69,9 +69,12 @@ The API requests are serviced as follows: Since v1.16.0, Netdata supports encrypted HTTP connections to the web server, plus encryption of streaming data between a slave and its master, via the TLS protocol. -Inbound unix socket connections are unaffected, regardless of the TLS settings.\ -??? info "Differences in TLS and SSL terminology" - While Netdata uses Transport Layer Security (TLS) to encrypt communications rather than the obsolete SSL protocol, it's still common practice to refer to encrypted web connections as `SSL`. Many vendors, like Nginx and even Netdata itself, use `SSL` in configuration files, whereas documentation will always refer to encrypted communications as `TLS` or `TLS/SSL`. +Inbound unix socket connections are unaffected, regardless of the TLS settings. + +> While Netdata uses Transport Layer Security (TLS) 1.2 to encrypt communications rather than the obsolete SSL protocol, +> it's still common practice to refer to encrypted web connections as `SSL`. Many vendors, like Nginx and even Netdata +> itself, use `SSL` in configuration files, whereas documentation will always refer to encrypted communications as `TLS` +> or `TLS/SSL`. To enable TLS, provide the path to your certificate and private key in the `[web]` section of `netdata.conf`: @@ -89,12 +92,13 @@ For test purposes, you can generate self-signed certificates with the following openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out cert.pem ``` -!!! note - If you use 4096 bits for your key and the certificate, Netdata will need more CPU to process the communication. `rsa4096` can be up to 4 times slower than `rsa2048`, so we recommend using 2048 bits. You can verify the difference by running: - -```sh -openssl speed rsa2048 rsa4096 -``` +> If you use 4096 bits for your key and the certificate, Netdata will need more CPU to process the communication. +> `rsa4096` can be up to 4 times slower than `rsa2048`, so we recommend using 2048 bits. You can verify the difference +> by running: +> +> ```sh +> openssl speed rsa2048 rsa4096 +> ``` ### Select TLS version |