clerie/nixfiles
1
0
Fork 0
Code Activity

profiles/dn42-router: Automatically generate peering documentation

Browse Source
This commit is contained in:
clerie
2025-12-03 20:23:44 +01:00
parent b768bf6deb
commit 7403159730
2 changed files with 95 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
profiles/dn42-router/default.nix
View File

@@ -11,6 +11,9 @@ let
bgp6Table = 2342; bgp6Table = 2342;
in { in {
imports = [
./documentation.nix
];
options.profiles.clerie.dn42-router = { options.profiles.clerie.dn42-router = {
enable = mkEnableOption "DN42 router base config"; enable = mkEnableOption "DN42 router base config";
@@ -93,6 +96,10 @@ in {
type = types.str; type = types.str;
default = ""; default = "";
}; };
htmlDocumentation = mkOption {
type = types.str;
description = "This option is set by the module itself and contains the documentation for this router setup";
};
}; };
config = mkIf config.profiles.clerie.dn42-router.enable { config = mkIf config.profiles.clerie.dn42-router.enable {

88
profiles/dn42-router/documentation.nix Normal file
View File

@@ -0,0 +1,88 @@
{ config, lib, ... }:
with lib;
let
cfg = config.profiles.clerie.dn42-router;
in {
profiles.clerie.dn42-router.htmlDocumentation = ''
<!DOCTYPE html>
<html lang="en">
<head>
</head>
<body>
<h1>${config.networking.fqdn}</h1>
<p>This is a router in the <a href="https://wiki.dn42.us/">experimental decentralized network dn42</a>.</p>
<p>If you like to peer, please drop me an email to <a href="mailto:dn42@clerie.de">dn42@clerie.de</a>.</p>
<p>Happy peering!</p>
<h2>Router Information</h2>
<ul>
<li>ASN: <code>AS4242422574</code></li>
<li>Loopback IP: <code>${cfg.loopbackIp}</code></li>
<li>Router ID: <code>${cfg.routerId}</code></li>
</ul>
<h2>Wireguard Peers</h2>
<table>
${concatMapStringsSep "\n" (peer: ''
<tr>
<td>${peer.peerName}</td>
<td><a href="https://explorer.burble.com/#/aut-num/AS${peer.remoteAsn}">AS${peer.remoteAsn}</a></td>
<td>
<details>
<summary>Peering config</summary>
<ul>
<li>Local Endpoint: <code>${config.networking.fqdn}:???</code></li>
<li>Local Address: <code>${peer.localAddress}</code></li>
<li>Local ASN: <code>AS4242422574</code></li>
</ul>
<ul>
<li>Remote Endpoint: <code>???</code></li>
<li>Remote Address: <code>${peer.remoteAddress}</code></li>
<li>Remote ASN: <code>AS${peer.remoteAsn}</code></li>
</ul>
</details>
</td>
<td><a href="https://map.iedon.net/#${peer.remoteAsn}">[Map]</a></td>
</tr>
'') cfg.wireguardPeers}
</table>
<h2>BGP Peers</h2>
<table>
${concatMapStringsSep "\n" (peer: ''
<tr>
<td>${peer.peerName}</td>
<td>AS${peer.remoteAsn}</td>
<td>
<details>
<summary>Peering config</summary>
<ul>
<li>Local Address: <code>${peer.localAddress}</code></li>
<li>Local ASN: <code>AS4242422574</code></li>
</ul>
<ul>
<li>Remote Address: <code>${peer.remoteAddress}</code></li>
<li>Remote ASN: <code>AS${peer.remoteAsn}</code></li>
</ul>
</details>
</td>
<td><a href="https://map.iedon.net/#${peer.remoteAsn}">[Map]</a></td>
</tr>
'') cfg.bgpPeers}
</table>
</body>
</html>
'';
}