Install / Build failure for openssl-sys - Included Resolution

[jmb12686]

When following the install instructions, I received the following error during the cargo install:

johnbelisle@JOHN-SURFACEP3:~/tools/monolith$ cargo install --path .                                                                                                             Installing monolith v2.0.8 (/home/johnbelisle/tools/monolith)                                                                                                                   Updating crates.io index                                                                                                                                                     Compiling openssl-sys v0.9.49                                                                                                                                                 Compiling rand_pcg v0.1.2                                                                                                                                                     Compiling rand_chacha v0.1.1                                                                                                                                                  Compiling memoffset v0.5.1                                                                                                                                                 error: failed to run custom build command for `openssl-sys v0.9.49`                                                                                                                                                                                                                                                                                         Caused by:                                                                                                                                                                      process didn't exit successfully: `/home/johnbelisle/tools/monolith/target/release/build/openssl-sys-acc6cf0f5e926ccc/build-script-main` (exit code: 101)                   --- stdout                                                                                                                                                                    cargo:rustc-cfg=const_fn                                                                                                                                                      cargo:rerun-if-env-changed=X86_64_UNKNOWN_LINUX_GNU_OPENSSL_LIB_DIR                                                                                                           X86_64_UNKNOWN_LINUX_GNU_OPENSSL_LIB_DIR unset                                                                                                                                cargo:rerun-if-env-changed=OPENSSL_LIB_DIR                                                                                                                                    OPENSSL_LIB_DIR unset                                                                                                                                                         cargo:rerun-if-env-changed=X86_64_UNKNOWN_LINUX_GNU_OPENSSL_INCLUDE_DIR                                                                                                       X86_64_UNKNOWN_LINUX_GNU_OPENSSL_INCLUDE_DIR unset                                                                                                                            cargo:rerun-if-env-changed=OPENSSL_INCLUDE_DIR                                                                                                                                OPENSSL_INCLUDE_DIR unset                                                                                                                                                     cargo:rerun-if-env-changed=X86_64_UNKNOWN_LINUX_GNU_OPENSSL_DIR
X86_64_UNKNOWN_LINUX_GNU_OPENSSL_DIR unset
cargo:rerun-if-env-changed=OPENSSL_DIR
OPENSSL_DIR unset
run pkg_config fail: "`\"pkg-config\" \"--libs\" \"--cflags\" \"openssl\"` did not exit successfully: exit code: 1\n--- stderr\nPackage openssl was not found in the pkg-config search path.\nPerhaps you should add the directory containing `openssl.pc\'\nto the PKG_CONFIG_PATH environment variable\nNo package \'openssl\' found\n"

--- stderr
thread 'main' panicked at '

Could not find directory of OpenSSL installation, and this `-sys` crate cannot
                                                                                                                                                                              Caused by:                                                                                                                                                                      build failed                                                                                                                                                               

I was able to resolve by installing libssl-dev on my Ubuntu env (Win10 WSL Ubuntu 18 LTS to be exact):

sudo apt install libssl-dev 

Install was successful after this. I'm a newb with respect to Rust and the ecosystem, but this documentation may help others experiencing the same issue. Maybe it would be a good idea to consider including this as a pre-requisite or part of some install step? Ideally it would be a pre-check during cargo install time?

Thanks!

[einarpersson]

I stumbled upon this as well. I recommend to just add a brief note about it in the README.

Thanks for this project btw!

[snshn]

@einarpersson glad it's useful! Currently there's "Dependency: libssl" in the README under "From source code" section, please let me know if you think it's sufficient, or if it can be done in a clearer way, that is cross-platform. Thank you for the feedback!

[einarpersson]

@einarpersson glad it's useful! Currently there's "Dependency: libssl" in the README under "From source code" section, please let me know if you think it's sufficient, or if it can be done in a clearer way, that is cross-platform. Thank you for the feedback!

Isn't the issue here that the "Dependency: libssl" is only in the "build from source"-section, whereas me and the OP used cargo install. I'm not too experienced with rust, so maybe this is in fact building from source, but as a newcomer it is easy to expect it to not realize this.

Suggestions:

1. Add a notice to the installation methods which require libssl (and maybe give an example of how to install it on common platforms)
2. If all methods require it, bring the pre-requisite before installation methods and maybe with a clearer header eg. "Before you start"

This is not a big issue, but it might save some headache for some people:)