From f1a9196deb313b895eb6b5a1578b6584dadd0716 Mon Sep 17 00:00:00 2001 From: Jan-Philipp Litza Date: Wed, 3 Jan 2018 23:11:58 +0100 Subject: [PATCH] gluon-radv-filterd: Move readme to docs/package/ --- docs/index.rst | 1 + .../package/gluon-radv-filterd.rst | 22 ++++++++++--------- 2 files changed, 13 insertions(+), 10 deletions(-) rename package/gluon-radv-filterd/README.md => docs/package/gluon-radv-filterd.rst (64%) diff --git a/docs/index.rst b/docs/index.rst index a1b93c9d..29c57bbf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -60,6 +60,7 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre package/gluon-ebtables-filter-ra-dhcp package/gluon-ebtables-segment-mld package/gluon-ebtables-source-filter + package/gluon-radv-filterd package/gluon-web-admin .. toctree:: diff --git a/package/gluon-radv-filterd/README.md b/docs/package/gluon-radv-filterd.rst similarity index 64% rename from package/gluon-radv-filterd/README.md rename to docs/package/gluon-radv-filterd.rst index b2623e6d..f5083bf4 100644 --- a/package/gluon-radv-filterd/README.md +++ b/docs/package/gluon-radv-filterd.rst @@ -1,5 +1,6 @@ gluon-radv-filterd ================== + This package drops all incoming router advertisements except for the default router with the best metric according to B.A.T.M.A.N. advanced. @@ -8,6 +9,7 @@ via gluon-radvd) are not affected and considered at all. "Best" router ------------- + The best router is determined by the TQ that is reported for its originator by B.A.T.M.A.N. advanced. If, for some reason, another gateway with a better TQ appears or an existing gateway increases its TQ above that of the chosen @@ -19,20 +21,20 @@ B.A.T.M.A.N. advanced). "Local" routers --------------- + The package has functionality to assign "local" routers, i.e. those connected via cable or WLAN instead of via the mesh (technically: appearing in the -`transtable_local`), a fake TQ of 512 so that they are always preferred. -However, if used together with the `gluon-ebtables-filter-ra-dhcp` package, -these router advertisements are filtered anyway and reach neither the node nor -any other client. You currently have to disable the package or insert custom -ebtables rules in order to use local routers. +``transtable_local``), a fake TQ of 512 so that they are always preferred. +However, if used together with the :doc:`package/gluon-ebtables-filter-ra-dhcp` +package, these router advertisements are filtered anyway and reach neither the +node nor any other client. You currently have to disable the package or insert +custom ebtables rules in order to use local routers. respondd module --------------- -This package also contains a module for [respondd] that announces the currently -selected router via the `statistics.gateway6` property using its interface MAC -address. Note that this is different from the `statistics.gateway` property, + +This package also contains a module for respondd that announces the currently +selected router via the ``statistics.gateway6`` property using its interface MAC +address. Note that this is different from the ``statistics.gateway`` property, which contains the MAC address of the main B.A.T.M.A.N. adv slave interface of the selected IPv4 gateway. - -[respondd]: https://github.com/freifunk-gluon/packages/tree/master/net/respondd