summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias Schiffer <mschiffer@universe-factory.net>2015-01-26 04:03:16 +0100
committerMatthias Schiffer <mschiffer@universe-factory.net>2015-01-26 04:03:16 +0100
commite7be1c8c266225ee52b82318a8af02a228fec4c4 (patch)
tree34c609459127a8edd7199d78e9d8ac5cee1fb227 /doc
parent712ed55c455e2c78e9146970c10873484fa9cf04 (diff)
downloadfastd-e7be1c8c266225ee52b82318a8af02a228fec4c4.tar
fastd-e7be1c8c266225ee52b82318a8af02a228fec4c4.zip
doc: remove now unused pmtu option
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/openwrt/fastd.config3
-rw-r--r--doc/examples/openwrt/fastd.init3
-rw-r--r--doc/source/manual/config.rst13
-rw-r--r--doc/source/manual/mtu.rst4
4 files changed, 5 insertions, 18 deletions
diff --git a/doc/examples/openwrt/fastd.config b/doc/examples/openwrt/fastd.config
index 7b13fc8..b2ab205 100644
--- a/doc/examples/openwrt/fastd.config
+++ b/doc/examples/openwrt/fastd.config
@@ -82,9 +82,6 @@ config fastd sample_config
# If set to 1, the logs won't contain peers' MAC addresses
# option hide_mac_addresses '0'
- # Read the documentation about this one. Only ever useful in severly broken networks.
-# option pmtu ''
-
# command to configure IP addresses etc. after the tunnel interface is up; $1 will be the interface name (optional)
# option up ''
diff --git a/doc/examples/openwrt/fastd.init b/doc/examples/openwrt/fastd.init
index e39c4d9..c938530 100644
--- a/doc/examples/openwrt/fastd.init
+++ b/doc/examples/openwrt/fastd.init
@@ -73,7 +73,6 @@ config_string_peer_limit='peer limit $(guard_value "$value");'
config_string_user='user $(escape_string "$value");'
config_string_group='group $(escape_string "$value");'
config_string_status_socket='status socket $(escape_string "$value");'
-config_string_pmtu='pmtu $(yes_no "$value");'
config_string_forward='forward $(yes_no "$value");'
config_string_hide_ip_addresses='hide ip addresses $(yes_no "$value");'
config_string_hide_mac_addresses='hide mac addresses $(yes_no "$value");'
@@ -242,7 +241,7 @@ generate_config() {
append_options "$s" config \
config config_peer config_peer_dir bind method syslog_level mode interface mtu peer_limit \
- user group status_socket pmtu forward hide_ip_addresses hide_mac_addresses secure_handshakes packet_mark \
+ user group status_socket forward hide_ip_addresses hide_mac_addresses secure_handshakes packet_mark \
on_pre_up on_up on_down on_post_down on_connect on_establish on_disestablish on_verify
config_get mode "$s" mode
diff --git a/doc/source/manual/config.rst b/doc/source/manual/config.rst
index 5a09c6c..9f7d50c 100644
--- a/doc/source/manual/config.rst
+++ b/doc/source/manual/config.rst
@@ -230,17 +230,8 @@ Example config:
| ``pmtu yes|no|auto;``
- Enables or disables Path MTU detection for IPv4. If enabled, all packets are sent with DF set, and all
- fragmentation happens on the sending host itself. If disabled, routers may fragment the packets themselves,
- possibly leading to multiple fragmentation. In general, disabling this should not be necessary, but in some
- networks ICMP MTU Too Big packets are lost, so PMTU detection doesn't work correctly.
-
- If possible, fastd's mtu setting should be adjusted so the packets aren't fragmented at all instead of
- relying on this option.
-
- The default is auto, which uses the system default as specified in /proc/sys/net/ipv4/ip_no_pmtu_disc.
-
- The pmtu option is available on Linux platforms only.
+ Does nothing; the ``pmtu`` option is only supported for compatiblity
+ with older versions of fastd.
| ``protocol "<protocol>";``
diff --git a/doc/source/manual/mtu.rst b/doc/source/manual/mtu.rst
index 68731e0..804404d 100644
--- a/doc/source/manual/mtu.rst
+++ b/doc/source/manual/mtu.rst
@@ -2,8 +2,8 @@ MTU configuration
=================
The default MTU of fastd is 1500. This allows briding the fastd interface in TAP
mode with other interface with the same MTU, but will usually cause fastd's UDP
-packets to be fragmented (see also the option :ref:`pmtu <option-pmtu>`). Fragmentation can lower the
-performance or even cause connectivty problems when broken routers filter ICMP packets,
+packets to be fragmented. Fragmentation can lower the
+performance or even cause connectivity problems when broken routers filter ICMP packets,
so if possible the MTU should be chosed small enough so that IP fragmentation can be avoided.
Unlike OpenVPN, fastd doesn't support fragmentation itself, but relies on the IP stack to fragment packets when necessary.