Deuxfleurs/wgautomesh
16
1
Fork 1
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Alex 2023-03-09 17:27:39 +01:00
parent 8792b40061
commit c7dbb05be2
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -13,10 +13,16 @@ Features:
- does not assume all nodes are publicly reachable
- configuration very similar to `wg-quick`: each node needs a list of the credentials of all other nodes in the mesh
- `wgautomesh` does not create a wireguard interface, it assumes it exists and merely configures the peers attached to it
- ultra simple encrypted gossip protocol over UDP (bincode encoding + xsalsa20poly1305 symmetric encryption)
- automatic discovery of nodes in a same LAN using UDP broadcast (if enabled, nodes will prefer connecting to one another using their LAN IP addresses when available)
- can automatically open ports in your router using IGD/UPnP
- saves to disk known addresses of peers so that they can be reused on restart (usefull if all addresses have changed and the ones in the config file are no longer relevant)
**`wgautomesh` only tries to establish connectivity to the peers specified in its config file**,
Remarks/limitations:
- `wgautomesh` does not create a wireguard interface, it assumes it exists and merely configures the peers attached to it
- `wgautomesh` only tries to establish connectivity to the peers specified in its config file,
it does not provide facilities for dynamically adding more peers like many wireguard configuration tools do.
`wgautomesh` was built for Deuxfleurs to integrate with our automated NixOS-based configuration management system.
A preliminary NixOS module for `wgautomesh` can be found [here](https://git.deuxfleurs.fr/Deuxfleurs/nixcfg/src/branch/wgautomesh/nix/wgautomesh.nix)