Update README with new feature set

This commit is contained in:
Baptiste Jonglez 2025-02-20 00:40:26 +01:00
parent 6614dfaeb6
commit c5d6840e27

View file

@ -5,9 +5,14 @@ Diplonat
## Feature set
* [X] (Re)Configure NAT via UPNP/IGD (prio: high)
* [X] (Re)Configure iptables (prio: low)
* [ ] (Re)Configure DNS via ??? (prio: low)
Diplonat performs two main tasks:
1) ensure that all services are accessible from the Internet
- it detects services by watching Consul and looking for a special "diplonat" tag (see below)
- for each service, it configures the host firewall with iptables and the router NAT with IGD
2) autodiscovery of the public IP addresses of the local node
- it uses STUN to a remote server for IPv4, and looks locally for a usable IPv6 address
- it then writes the discovered IP addresses to Consul, so that other services can use them (D53 for the DNS, Garage, Jitsi...)
## Understand scope