From 5f13636b49a1873e179cf5683ab066ef9205bdc7 Mon Sep 17 00:00:00 2001 From: Paolo Barbolini Date: Sat, 1 Feb 2025 22:14:14 +0100 Subject: [PATCH] docs: document OpenSSL system dependencies (#1030) --- src/lib.rs | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 604ca42..345e942 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -34,13 +34,25 @@ //! //! _Secure SMTP connections using TLS from the `native-tls` crate_ //! -//! Uses schannel on Windows, Security-Framework on macOS, and OpenSSL on Linux. +//! Uses schannel on Windows, Security-Framework on macOS, and OpenSSL +//! on all other platforms. //! //! * **native-tls** 📫: TLS support for the synchronous version of the API //! * **tokio1-native-tls**: TLS support for the `tokio1` async version of the API //! //! NOTE: native-tls isn't supported with `async-std` //! +//! ##### Building lettre with OpenSSL +//! +//! When building lettre with native-tls on a system that makes +//! use of OpenSSL, the following packages will need to be installed +//! in order for the build and the compiled program to run properly. +//! +//! | Distro | Build-time packages | Runtime packages | +//! | ------------ | -------------------------- | ---------------------------- | +//! | Debian | `pkg-config`, `libssl-dev` | `libssl3`, `ca-certificates` | +//! | Alpine Linux | `pkgconf`, `openssl-dev` | `libssl3`, `ca-certificates` | +//! //! #### SMTP over TLS via the boring crate (Boring TLS) //! //! _Secure SMTP connections using TLS from the `boring-tls` crate_