Merge pull request #967 from sfackler/vendored-docs

Add some docs to the README about the vendored feature.
This commit is contained in:
Alex Crichton 2018-07-31 07:31:56 -07:00 committed by GitHub
commit 09ce916551
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions

View File

@ -17,6 +17,21 @@ libraries and headers need to be present in the build environment before this
crate is compiled, and some instructions of how to do this are in the sections crate is compiled, and some instructions of how to do this are in the sections
below. below.
### Vendored
```toml
[dependencies]
openssl = { version = "0.10", features = ["vendored"] }
```
If the `vendored` Cargo feature is enabled, the `openssl-src` crate will be used
to compile OpenSSL from source and statically link to it. OpenSSL version 1.1.0
is currently used, but that will be upgraded to 1.1.1 at some point after it is
released *without* a major version bump to this crate.
This vendored copy will not be configured to automatically find the system's
root certificates, but the `openssl-probe` crate can be used to do that instead.
### Linux ### Linux
On Linux, you can typically install OpenSSL via your package manager. The On Linux, you can typically install OpenSSL via your package manager. The