From 78f295bebf9ffbe1c4617f080fc69d0f7665ca6e Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Tue, 21 Mar 2023 11:53:54 +0000 Subject: [PATCH] docs: [#253] crate docs for app.rs --- src/app.rs | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/app.rs b/src/app.rs index 5f75449c..3fc790a2 100644 --- a/src/app.rs +++ b/src/app.rs @@ -1,3 +1,22 @@ +//! Torrust Tracker application. +//! +//! The tracker application has a global configuration for multiple jobs. +//! It's basically a container for other services. +//! It also check constraint and dependencies between services. For example: +//! It's not safe to run a UDP tracker on top of a core public tracker, as UDP trackers +//! do not allow private access to the tracker data. +//! +//! The application is responsible for: +//! +//! - Loading data from the database when it's needed. +//! - Starting some jobs depending on the configuration. +//! +//! The started jobs may be: +//! +//! - Torrent cleaner: it removes inactive peers and (optionally) peerless torrents. +//! - UDP trackers: the user can enable multiple UDP tracker on several ports. +//! - HTTP trackers: the user can enable multiple HTTP tracker on several ports. +//! - Tracker REST API: the tracker API can be enabled/disabled. use std::sync::Arc; use log::warn;