Skip to content

Commit

Permalink
Merge #475: Update docs: system package dep libssl-dev needed on lI…
Browse files Browse the repository at this point in the history
…mnux

5f7608e docs: [#463] system package dep: libssl-dev (Jose Celano)

Pull request description:

  Since we are using native TLS support you need to install `libssl-dev` on Linux:

  ```console
  sudo apt-get install libssl-dev
  ```

ACKs for top commit:
  josecelano:
    ACK 5f7608e

Tree-SHA512: bb289975947f0047ce7a48f100521f63bd8dc1871c8dfc6932c8a51f3d1e372dc6577305edb6254a82f638ce6b74724af80df4d549b7094c948f49f691e602d1
  • Loading branch information
josecelano committed Feb 8, 2024
2 parents e80b18f + 5f7608e commit e9c0642
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
1 change: 1 addition & 0 deletions project-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ rowid
RUSTDOCFLAGS
RUSTFLAGS
rustfmt
rustls
rustversion
serde
sgxj
Expand Down
12 changes: 11 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
//! ## Prerequisites
//!
//! In order the run the index you will need a running torrust tracker. In the
//! configuration you need to fill the `index` section with the following:
//! configuration you need to fill the `tracker` section with the following:
//!
//! ```toml
//! [tracker]
Expand All @@ -70,6 +70,16 @@
//! or you can use the docker to run both the tracker and the index. Refer to the
//! [Run with docker](#run-with-docker) section for more information.
//!
//! You will also need to install this dependency:
//!
//! ```text
//! sudo apt-get install libssl-dev
//! ```
//!
//! We needed because we are using native TLS support instead of [rustls](https://github.com/rustls/rustls).
//!
//! More info: <https://github.com/torrust/torrust-index/issues/463>.
//!
//! If you are using `SQLite3` as database driver, you will need to install the
//! following dependency:
//!
Expand Down

0 comments on commit e9c0642

Please sign in to comment.