Add architecture and backbone networking documentation - #6
Open
oliverlorenz wants to merge 4 commits into
Open
Conversation
Documents the repository's components, how they relate to each other, and how the Freifunk backbone works on the network level (GRE, batman-adv, fastd, BGP), including explanations of Layer-2 networking and full-mesh topologies referenced throughout. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
- BIRD/bird6 are two separate binaries from the BIRD 1.x codebase, not "two instances of the same daemon" (BIRD 2.x later merged them). - batman-adv nodes do exchange OGM broadcasts and thus know of each other; the accurate property is that no node needs the full network topology, only the best next hop per destination. - Soften the claim that "practically all" Freifunk communities use this exact GRE+batman-adv+BGP layering; other communities (e.g. Freifunk Rheinland) use different tech (tinc/OSPF) for the same conceptual layers. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Link each externally-verified claim (batman-adv, alfred, fastd, gretap, BIRD/bird6, Freifunk community comparisons) to the source it was checked against, plus a "Quellen" section per document. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
- ip-adressplan.md: consolidates all IPv4/IPv6 ranges and address schemes in one place, including the previously undocumented Chemnitz/Umland regional split (already described in README.md but missing from the new docs). - sicherheitsmodell.md: documents which links are encrypted and/or access-controlled (fastd: encrypted, open access; GRE/BGP between backbone servers: neither) and the resulting trust model. - betrieb.md: operational runbook for adding a backbone server (including the GRE_PEERS-must-be-updated-on-every-existing-server gotcha), debugging a dead GRE tunnel, rotating a fastd key, and reading watchdog mails. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
oliverlorenz
requested review from
FGBxRamel,
achterin,
ambassador86 and
ronnyhartenstein
August 26, 2026 21:15
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/mit vier neuen Dokumenten hinzu:README.md(Index),architektur.md(Repo-Komponenten, Start/Stop/Watchdog-Ablauf),komponenten.md(Einzelbeschreibung jeder Software-Komponente und jedes Skripts),backbone-netzwerk.md(wie das Freifunk-Backbone auf Netzwerkebene funktioniert: GRE, batman-adv, fastd, BGP/BIRD)docs/Test plan
docs/architektur.mdunddocs/backbone-netzwerk.mdrendern korrekt#grundlagen-was-ist-ein-layer-2-netz,#grundlagen-was-ist-eine-vollvermaschung) funktionieren auf GitHub🤖 Generated with Claude Code