From c5d6840e278b636ee0d9aeeb7820677e64233f52 Mon Sep 17 00:00:00 2001 From: Baptiste Jonglez Date: Thu, 20 Feb 2025 00:40:26 +0100 Subject: [PATCH] Update README with new feature set --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ef9af1e..a772017 100644 --- a/README.md +++ b/README.md @@ -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