qenya/birdsong
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve docs

Browse source
This commit is contained in:
Katherina Walshe-Grey 2024-07-25 12:53:52 +01:00
parent 68b9a6f1bb
commit ad6a7c9343
2 changed files with 97 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
hosts.nix
View file

@ -26,7 +26,8 @@ with lib;
The special value `roaming` will not peer with other `roaming`
hosts, but will still peer with `internet` hosts. This is to be
used for portable devices like laptops that regularly move between
networks.
networks. Also use this for non-NixOS devices that can't use the
NixOS module and therefore only peer with the subnet router.
'';
type = types.str;
};
@ -48,12 +49,22 @@ with lib;
};
ipv4 = mkOption {
example = "10.127.1.1";
description = "IPv4 address of this peer within the network";
description = ''
IPv4 address of this peer within the network.
We are currently using the range 10.127.0.0/16, divided into /24
subnets. Please try to keep this consistent.
'';
type = types.str;
};
ipv6 = mkOption {
example = "fd70:81ca:0f8f:1::1";
description = "IPv6 address of this peer within the network";
description = ''
IPv6 address of this peer within the network.
We are currently using the range fd70:81ca:0f8f::/48, divided
into /64 subnets. Please try to keep this consistent.
'';
type = types.str;
};
port = mkOption {