docs: automatic UPnP port forwarding (clearnet + StartTunnel)#93
docs: automatic UPnP port forwarding (clearnet + StartTunnel)#93helix-nine wants to merge 6 commits into
Conversation
helix-nine
requested review from
Dominion5254 and
waterplea
and removed request for
Dominion5254 and
waterplea
Companion to the DNS-injection half of Start9Labs/start-os#3306: a new 'DNS Records' page documenting how trusted devices inject records over RFC 2136 and how to view/manage them, plus the per-device 'Allow DNS injection' toggle (default off) noted on the Devices page.
|
Thanks for the review @Dominion5254! Two notes:
Still to come as their own docs once the code merges: the StartWRT side now also runs this gateway server (start-wrt#66), and the PCP HOSTNAME (SNI-demux) / PORT_SET extensions. |
Devices come in two kinds (Server = StartOS box with gateway autoconfig, Client = plain peer); document the kind selector, Server DNS-injection/auto-port-forward toggles, and promote/demote. DNS records and port forwards now split into Manual and Automatic tables. Add the device add --kind flag to the CLI reference. Companion to Start9Labs/start-os#3306.
|
Added device Client/Server kinds and the Manual/Automatic table split to the StartTunnel docs (companion to the latest on Start9Labs/start-os#3306):
|
Companion to Start9Labs/start-os#3306 net tunnel update + the gateways UI action.
…S Injection Correct the stale restriction that private domains can only be added to Ethernet/WiFi gateways. They can now be added to WireGuard (StartTunnel) gateways too: enable DNS Injection for the server in StartTunnel (StartOS publishes the record to the gateway's resolver via RFC 2136), or point the tunnel subnet's DNS at the server. Splits the DNS section by gateway type.
2 participants
Companion to Start9Labs/start-os#3306.
StartOS now attempts UPnP automatically when you enable a public address, opening the required port on the gateway (a home router or a StartTunnel) and removing it when the address is disabled/deleted. StartTunnel implements a UPnP IGD over WireGuard, with the security property that a device can only open ports to itself.
start-os/src/clearnet.md— "Configure Port Forwarding": document the automatic UPnP attempt + fallback to manual.start-tunnel/src/port-forwarding.md— note automatic, self-scoped UPnP; the manual steps are now "Add a forward manually".start-tunnel/src/architecture.md— mention StartTunnel acts as a UPnP gateway.