diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/BUILD_TLS.adoc | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/BUILD_TLS.adoc b/docs/BUILD_TLS.adoc index 0ffa9c9d..80a843dd 100644 --- a/docs/BUILD_TLS.adoc +++ b/docs/BUILD_TLS.adoc @@ -2,42 +2,42 @@ ifdef::env-github[] :important-caption: :heavy_exclamation_mark: endif::[] -= Building for TLSv1.2 Support += Building for TLS Support If you want to include support for Transport Layer Security (tls+tcp:// and wss:// URLs) you should follow these directions. -At this time, TLS support depends on the mbedTLS library. -See https://tls.mbed.org/ for details. +At this time, TLS support depends on the https://tls.mbed.org/[Mbed TLS] +library. -IMPORTANT: mbedTLS is licensed under different terms than NNG. +IMPORTANT: Mbed TLS is licensed under different terms than NNG. You are responsible for reading those license terms, and ensuring that your use conforms to them. On many distributions you may be able to install a pre-packaged version -of mbedTLS. We recommend doing so if this is an option for you. +of Mbed TLS. We recommend doing so if this is an option for you. For example, Ubuntu users can install the `libmbedtls-dev` package. -You can also build mbedTLS from source; if you choose to do so, +You can also build Mbed TLS from source; if you choose to do so, please make sure you also *install* it somewhere (even a temporary staging directory). -== Configuring NNG with mbedTLS +== Configuring NNG with Mbed TLS TLS support is not enabled by default, but can be enabled by configuring with the CMake option `NNG_ENABLE_TLS=ON`. -By default NNG searches for an installed copy of mbedTLS in `/usr/local`, +By default NNG searches for an installed copy of Mbed TLS in `/usr/local`, as well as the normal installation directories for libraries on your system. -If you have installed mbedTLS elsewhere, you can direct the NNG configuration +If you have installed Mbed TLS elsewhere, you can direct the NNG configuration to it by setting the `MBEDTLS_ROOT_DIR` CMake variable. == Example The following example would work on either Linux or macOS, and assumes that we have checked out github source trees into `$HOME/work`. -It also assumes that mbedTLS is already installed in /usr/local or +It also assumes that Mbed TLS is already installed in /usr/local or a standard search path. [source, sh] |