Skip to content

Commit 78f295b

Browse files
committed
docs: [#253] crate docs for app.rs
1 parent a58554a commit 78f295b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/app.rs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
//! Torrust Tracker application.
2+
//!
3+
//! The tracker application has a global configuration for multiple jobs.
4+
//! It's basically a container for other services.
5+
//! It also check constraint and dependencies between services. For example:
6+
//! It's not safe to run a UDP tracker on top of a core public tracker, as UDP trackers
7+
//! do not allow private access to the tracker data.
8+
//!
9+
//! The application is responsible for:
10+
//!
11+
//! - Loading data from the database when it's needed.
12+
//! - Starting some jobs depending on the configuration.
13+
//!
14+
//! The started jobs may be:
15+
//!
16+
//! - Torrent cleaner: it removes inactive peers and (optionally) peerless torrents.
17+
//! - UDP trackers: the user can enable multiple UDP tracker on several ports.
18+
//! - HTTP trackers: the user can enable multiple HTTP tracker on several ports.
19+
//! - Tracker REST API: the tracker API can be enabled/disabled.
120
use std::sync::Arc;
221

322
use log::warn;

0 commit comments

Comments
 (0)