add vendored-openssl feature to allow embed openssl statically

freedelity · Feb 2, 2024 · 5d1e5b4 · 5d1e5b4
1 parent 99f0bd2
commit 5d1e5b4
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,6 +5,9 @@ edition = "2021"
 authors = ["Nicolas Dusart <[email protected]>", "Freedelity"]
 license = "MIT"
 
+[features]
+vendored-openssl = ["ssh2/vendored-openssl"]
+
 [dependencies]
 anyhow = "1.0"
 clap = { version = "4.4", default-features = false, features = ["derive", "std", "help", "usage"] }

diff --git a/README.md b/README.md
@@ -64,6 +64,12 @@ You can simply build this with the **Rust** toolchain (using **cargo** package m
 cargo build --release
 ```
 
+This build will be linked against the OpenSSL library of your system. If this makes an issue to deploy it on a machine with an incompatible version of OpenSSL, you can statically link OpenSSL in your binary by enabling the `vendored-openssl` feature (this will add ~4MB to the final binary):
+
+```sh
+cargo build --release --feature vendored-openssl
+```
+
 ## License
 
 This project is licensed under the [MIT license].