diff --git a/src/lib.rs b/src/lib.rs index 064f50eb6..72018c894 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -121,11 +121,19 @@ //! //! By default the tracker uses `SQLite` and the database file name `data.db`. //! +//! We will have to have a file to save the torrust-tracker, which we will call "torrust". +//! +//! ```text +//! mkdir torrust +//! cd torrust/ +//! ``` +//! //! You only need the `tls` directory in case you are setting up SSL for the HTTP tracker or the tracker API. //! Visit [`HTTP`](crate::servers::http) or [`API`](crate::servers::apis) if you want to know how you can use HTTPS. //! //! ## Install from sources //! +//! //! ```text //! git clone https://github.com/torrust/torrust-tracker.git \ //! && cd torrust-tracker \ @@ -134,6 +142,15 @@ //! && mkdir -p ./storage/tracker/lib/tls //! ``` //! +//! To run the tracker we will have to use the command "cargo run" this will have to compile data while being executed and after being compiled it will start running the tracker. +//! +//! ```text +//! cargo run +//! ``` +//! +//! If you want to configure your tracker further, you can go to the "Configuration" section to configure it to your liking. +//! +//! //! ## Run with docker //! //! You can run the tracker with a pre-built docker image. Please refer to the