Skip to content

Commit

Permalink
gluon-radv-filterd: Move readme to docs/package/
Browse files Browse the repository at this point in the history
  • Loading branch information
jplitza committed Jan 3, 2018
1 parent f6f1ae9 commit f1a9196
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand All @@ -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

0 comments on commit f1a9196

Please sign in to comment.