nils/gluon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

gluon-radv-filterd: Move readme to docs/package/

Browse Source
This commit is contained in:
Jan-Philipp Litza 2018-01-03 23:11:58 +01:00
parent f6f1ae9c4f
commit f1a9196deb
No known key found for this signature in database
GPG Key ID: 1FB658053CE27196
2 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.rst
View File

@ -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-filter-ra-dhcp
package/gluon-ebtables-segment-mld package/gluon-ebtables-segment-mld
package/gluon-ebtables-source-filter package/gluon-ebtables-source-filter
package/gluon-radv-filterd
package/gluon-web-admin package/gluon-web-admin
.. toctree:: .. toctree::

22
package/gluon-radv-filterd/README.md → docs/package/gluon-radv-filterd.rst
View File

@ -1,5 +1,6 @@
gluon-radv-filterd gluon-radv-filterd
================== ==================
This package drops all incoming router advertisements except for the 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. 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 "Best" router
------------- -------------
The best router is determined by the TQ that is reported for its originator by 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 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 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 "Local" routers
--------------- ---------------
The package has functionality to assign "local" routers, i.e. those connected 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 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. ``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, However, if used together with the :doc:`package/gluon-ebtables-filter-ra-dhcp`
these router advertisements are filtered anyway and reach neither the node nor package, these router advertisements are filtered anyway and reach neither the
any other client. You currently have to disable the package or insert custom node nor any other client. You currently have to disable the package or insert
ebtables rules in order to use local routers. custom ebtables rules in order to use local routers.
respondd module 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 This package also contains a module for respondd that announces the currently
address. Note that this is different from the `statistics.gateway` property, 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 which contains the MAC address of the main B.A.T.M.A.N. adv slave interface of
the selected IPv4 gateway. the selected IPv4 gateway.
[respondd]: https://github.com/freifunk-gluon/packages/tree/master/net/respondd