YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-03-31 09:45:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation around IPv4/IPv6 address binding

Browse source
This commit is contained in:
Joakim Frostegård 2025-01-12 23:09:05 +01:00
parent 0157ce5c86
commit 24897dd73d
3 changed files with 57 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
crates/http/src/config.rs
View file

@ -71,6 +71,25 @@ impl aquatic_common::cli::Config for Config {
#[serde(default, deny_unknown_fields)] #[serde(default, deny_unknown_fields)]
pub struct NetworkConfig { pub struct NetworkConfig {
/// Bind to this address /// Bind to this address
///
/// When providing an IPv4 style address, only IPv4 traffic will be
/// handled. Examples:
/// - "0.0.0.0:3000" binds to port 3000 on all network interfaces
/// - "127.0.0.1:3000" binds to port 3000 on the loopback interface
/// (localhost)
///
/// When it comes to IPv6-style addresses, behaviour differs between
/// operating systems. On Linux or macOS, by default, both IPv4 and IPv6
/// traffic is received. For instance:
/// - "[::]:3000" binds on all interfaces on port 3000, with both IPv4 and
/// IPv6 traffic being accepted
/// - "[::1]:3000" binds on the loopback interface (localhost) on port
/// 3000, with both IPv4 and IPv6 traffic being accepted
///
/// In this case, to only accept traffic over IPv6, use an IPv6-style
/// address, and additionally set "only_ipv6" below.
///
/// For other operating systems, please refer to their documentation.
pub address: SocketAddr, pub address: SocketAddr,
/// Only allow access over IPv6 /// Only allow access over IPv6
pub only_ipv6: bool, pub only_ipv6: bool,

19
crates/udp/src/config.rs
View file

@ -55,6 +55,25 @@ impl aquatic_common::cli::Config for Config {
#[serde(default, deny_unknown_fields)] #[serde(default, deny_unknown_fields)]
pub struct NetworkConfig { pub struct NetworkConfig {
/// Bind to this address /// Bind to this address
///
/// When providing an IPv4 style address, only IPv4 traffic will be
/// handled. Examples:
/// - "0.0.0.0:3000" binds to port 3000 on all network interfaces
/// - "127.0.0.1:3000" binds to port 3000 on the loopback interface
/// (localhost)
///
/// When it comes to IPv6-style addresses, behaviour differs between
/// operating systems. On Linux or macOS, by default, both IPv4 and IPv6
/// traffic is received. For instance:
/// - "[::]:3000" binds on all interfaces on port 3000, with both IPv4 and
/// IPv6 traffic being accepted
/// - "[::1]:3000" binds on the loopback interface (localhost) on port
/// 3000, with both IPv4 and IPv6 traffic being accepted
///
/// In this case, to only accept traffic over IPv6, use an IPv6-style
/// address, and additionally set "only_ipv6" below.
///
/// For other operating systems, please refer to their documentation.
pub address: SocketAddr, pub address: SocketAddr,
/// Only allow access over IPv6 /// Only allow access over IPv6
pub only_ipv6: bool, pub only_ipv6: bool,

19
crates/ws/src/config.rs
View file

@ -75,6 +75,25 @@ impl aquatic_common::cli::Config for Config {
#[serde(default, deny_unknown_fields)] #[serde(default, deny_unknown_fields)]
pub struct NetworkConfig { pub struct NetworkConfig {
/// Bind to this address /// Bind to this address
///
/// When providing an IPv4 style address, only IPv4 traffic will be
/// handled. Examples:
/// - "0.0.0.0:3000" binds to port 3000 on all network interfaces
/// - "127.0.0.1:3000" binds to port 3000 on the loopback interface
/// (localhost)
///
/// When it comes to IPv6-style addresses, behaviour differs between
/// operating systems. On Linux or macOS, by default, both IPv4 and IPv6
/// traffic is received. For instance:
/// - "[::]:3000" binds on all interfaces on port 3000, with both IPv4 and
/// IPv6 traffic being accepted
/// - "[::1]:3000" binds on the loopback interface (localhost) on port
/// 3000, with both IPv4 and IPv6 traffic being accepted
///
/// In this case, to only accept traffic over IPv6, use an IPv6-style
/// address, and additionally set "only_ipv6" below.
///
/// For other operating systems, please refer to their documentation.
pub address: SocketAddr, pub address: SocketAddr,
/// Only allow access over IPv6 /// Only allow access over IPv6
pub only_ipv6: bool, pub only_ipv6: bool,