Skip to content

Commit

Permalink
doc: Update generated Doxygen docs. (#313)
Browse files Browse the repository at this point in the history
Signed-off-by: Matthieu Baerts (NGI0) <[email protected]>
  • Loading branch information
matttbe committed Nov 20, 2024
1 parent c03a218 commit 65d4e06
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The Multipath TCP Daemon - <code>mptcpd</code> - is a daemon for Linux based operating systems that performs <a href="https://www.rfc-editor.org/rfc/rfc8684.html">multipath TCP</a> <a href="https://www.rfc-editor.org/rfc/rfc8684.html#section-3.4">path management</a> related operations in the user space. It interacts with the Linux kernel through a generic netlink connection to track per-connection information (e.g. available remote addresses), available network interfaces, request new MPTCP subflows, handle requests for subflows, etc.</p>
<dl class="section see"><dt>See also</dt><dd>Additional higher level documentation is available in the <a href="https://github.com/multipath-tcp/mptcpd/wiki"><code>mptcpd</code> Wiki</a>. </dd></dl>
<p>By default, this daemon will load the <code>addr_adv</code> plugin, which will add MPTCP endpoints with the <code>subflow</code> flag ("client" mode) for the default in-kernel path-manager. Note that this is something <a href="https://networkmanager.dev/blog/networkmanager-1-40/#mptcp-support">NetworkManager 1.40 or newer</a> does by default. Having several daemons configuring the MPTCP endpoints at the same time should be avoided. This daemon is usually recommended when NetworkManager 1.40 or newer is not available, or when advanced per-connection path management is needed, using the userspace path-manager and a custom made <a href="https://github.com/multipath-tcp/mptcpd/wiki/Plugins">plugin</a> using the C API that is described here.</p>
<p>To change this behavior, with NetworkManager, look for the <code>connection.mptcp-flags</code> option in the <a href="https://networkmanager.dev/docs/api/latest/nm-settings-nmcli.html#nm-settings-nmcli.property.connection.mptcp-flags">settings</a>, while for <code>mptcpd</code>, look at the <code>/etc/mptcpd/mptcpd.conf</code> config file, or disable the service if it is not needed. Make sure not to have both NetworkManager and <code>mptcpd</code> conflicting to configure the MPTCP endpoints.</p>
<dl class="section see"><dt>See also</dt><dd>Additional higher level documentation is available in the <a href="https://github.com/multipath-tcp/mptcpd/wiki/Plugins"><code>mptcpd</code> Wiki</a>. </dd></dl>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
Expand Down

0 comments on commit 65d4e06

Please sign in to comment.