Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs:Update tracker-installation #845

Closed
wants to merge 1 commit into from
Closed

docs:Update tracker-installation #845

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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

Check warning on line 147 in src/lib.rs

View check run for this annotation

Codecov / codecov/patch

src/lib.rs#L147 

Added line #L147 was not covered by tests
//! 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
Expand Down
Loading