Skip to content

Commit

Permalink
fixup: doc fixups
Browse files Browse the repository at this point in the history
  • Loading branch information
da2ce7 committed Jul 13, 2024
1 parent 7f867d6 commit d2717ad
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion packages/configuration/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//! This module contains the configuration data structures for the
//! Torrust Tracker, which is a `BitTorrent` tracker server.
//!
//! The current version for configuration is [`v1`].
//! The current version for configuration is [`v2`].
pub mod v2;

use std::collections::HashMap;
Expand Down
12 changes: 6 additions & 6 deletions packages/configuration/src/v2/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@
//! Please refer to the documentation of each structure for more information
//! about each section.
//!
//! - [`Core configuration`](crate::v1::Configuration)
//! - [`HTTP API configuration`](crate::v1::tracker_api::HttpApi)
//! - [`HTTP Tracker configuration`](crate::v1::http_tracker::HttpTracker)
//! - [`UDP Tracker configuration`](crate::v1::udp_tracker::UdpTracker)
//! - [`Health Check API configuration`](crate::v1::health_check_api::HealthCheckApi)
//! - [`Core configuration`](crate::v2::Configuration)
//! - [`HTTP API configuration`](crate::v2::tracker_api::HttpApi)
//! - [`HTTP Tracker configuration`](crate::v2::http_tracker::HttpTracker)
//! - [`UDP Tracker configuration`](crate::v2::udp_tracker::UdpTracker)
//! - [`Health Check API configuration`](crate::v2::health_check_api::HealthCheckApi)
//!
//! ## Port binding
//!
Expand Down Expand Up @@ -78,7 +78,7 @@
//!
//! Alternatively, you could setup a reverse proxy like Nginx or Apache to
//! handle the SSL/TLS part and forward the requests to the tracker. If you do
//! that, you should set [`on_reverse_proxy`](crate::v1::core::Core::on_reverse_proxy)
//! that, you should set [`on_reverse_proxy`](crate::v2::network::Network::on_reverse_proxy)
//! to `true` in the configuration file. It's out of scope for this
//! documentation to explain in detail how to setup a reverse proxy, but the
//! configuration file should be something like this:
Expand Down

0 comments on commit d2717ad

Please sign in to comment.