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

docs: mtu: fix reference to faq entry, add mtu diagram locally

Browse Source
This commit is contained in:
Martin Weinelt 2017-10-14 19:51:10 +02:00 committed by Andreas Ziegler
parent e4ef421711
commit 1992d4fd29
3 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/user/faq.rst
View File

@ -16,6 +16,7 @@ on *batman-adv*. If your mesh does not have global IPv6 connectivity, you can se
your *radvd* not to announce a default route by setting the *default lifetime* to 0; your *radvd* not to announce a default route by setting the *default lifetime* to 0;
in this case, the *radvd* is only used to announce the DNS server. in this case, the *radvd* is only used to announce the DNS server.
.. _faq-mtu:
What is a good MTU on the mesh-vpn What is a good MTU on the mesh-vpn
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -31,7 +32,7 @@ Consider these key values:
- and configure `MSS clamping`_ accordingly, - and configure `MSS clamping`_ accordingly,
- and announce your link MTU via Router Advertisments and DHCP - and announce your link MTU via Router Advertisments and DHCP
.. MSS clamping: http://www.tldp.org/HOWTO/Adv-Routing-HOWTO/lartc.cookbook.mtu-mss.html .. _MSS clamping: http://www.tldp.org/HOWTO/Adv-Routing-HOWTO/lartc.cookbook.mtu-mss.html
- Encapsulation: Account for the overhead created by the configured mesh protocol - Encapsulation: Account for the overhead created by the configured mesh protocol
encapsulating the payload, which is encapsulating the payload, which is
@ -42,7 +43,7 @@ Consider these key values:
For reference, the complete MTU stack looks like this: For reference, the complete MTU stack looks like this:
.. image:: https://cloud.hamburg.freifunk.net/thumbnail/de738ee3ac/1024/MTU%20within%20a%20batman-adv%20network%20v5.png .. image:: mtu-diagram_v5.png
Minimum MTU Minimum MTU
----------- -----------

BIN
docs/user/mtu-diagram_v5.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 208 KiB

4
docs/user/site.rst
View File

@ -196,9 +196,7 @@ mesh_vpn
The `enabled` option can be set to true to enable the VPN by default. `mtu` The `enabled` option can be set to true to enable the VPN by default. `mtu`
defines the MTU of the VPN interface, determining a proper MTU value is described defines the MTU of the VPN interface, determining a proper MTU value is described
in the FAQ entry `"What is a good MTU on the mesh-vpn?"`_. in the :ref:`FAQ <faq-mtu>`.
.. _"What is a good MTU on the mesh-vpn?": faq.rst
The `fastd` section configures settings specific to the *fastd* VPN The `fastd` section configures settings specific to the *fastd* VPN
implementation. implementation.