From c66d9c0f740e746af8537d04d00f87dab5a30859 Mon Sep 17 00:00:00 2001 From: cinnamonstic Date: Wed, 17 Dec 2025 22:45:16 -0500 Subject: [PATCH] docs: add example for a wireguard connection example --- nmrs/src/api/builders/mod.rs | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/nmrs/src/api/builders/mod.rs b/nmrs/src/api/builders/mod.rs index 40a867a4..5c18c357 100644 --- a/nmrs/src/api/builders/mod.rs +++ b/nmrs/src/api/builders/mod.rs @@ -38,6 +38,30 @@ //! // Build Ethernet connection settings //! let eth_settings = build_ethernet_connection("eth0", &opts); //! ``` +//! // Build WireGuard VPN connection settings +//! let creds = VpnCredentials { +//! vpn_type: VpnType::WireGuard, +//! name: "MyVPN".into(), +//! gateway: "vpn.example.com:51820".into(), +//! private_key: "PRIVATE-KEY".into(), +//! address: "10.0.0.2/24".into(), +//! peers: vec![WireGuardPeer { +//! public_key: "PUBLIC-KEY".into(), +//! gateway: "vpn.example.com:51820".into(), +//! allowed_ips: vec!["0.0.0.0/0".into()], +//! preshared_key: None, +//! persistent_keepalive: Some(25), +//! }], +//! dns: None, +//! mtu: None, +//! uuid: None, +//! }; +//! +//! let vpn_settings = build_wireguard_connection(&creds, &opts).unwrap(); +//! ``` +//! +//! These settings can then be passed to NetworkManager’s +//! `AddConnection` or `AddAndActivateConnection` D-Bus methods. pub mod vpn; pub mod wifi;