Skip to content

Commit

Permalink
doc: how to change the behaviour
Browse files Browse the repository at this point in the history
While describing what's being done by default, best to mention how to
adapt that.

Signed-off-by: Matthieu Baerts (NGI0) <[email protected]>
  • Loading branch information
matttbe committed Nov 18, 2024
1 parent 2c51f9b commit c002799
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ information (e.g. available remote addresses), available network
interfaces, request new MPTCP subflows, handle requests for subflows,
etc.

## Behavior
By default, this daemon will load the `addr_adv` plugin, which will
add MPTCP endpoints with the `subflow` flag ("client" mode) for the
default in-kernel path-manager. Note that this is something
Expand All @@ -28,6 +29,14 @@ userspace path-manager and a custom made
[plugin](https://github.com/multipath-tcp/mptcpd/wiki/Plugins) using
the [C API](https://mptcpd.mptcp.dev/doc/html/).

To change this behavior, with NetworkManager, look for the
`connection.mptcp-flags` option in the
[settings](https://networkmanager.dev/docs/api/latest/nm-settings-nmcli.html#nm-settings-nmcli.property.connection.mptcp-flags),
while for `mptcpd`, look at the `/etc/mptcpd/mptcpd.conf` config
file, or disable the service if it is not needed. Make sure not to
have both NetworkManager and `mptcpd` conflicting to configure the
MPTCP endpoints.

## Installing `mptcpd`
`mptcpd` is packaged in most major distributions:

Expand Down
8 changes: 8 additions & 0 deletions mptcpd.dox
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@
* [plugin](https://github.com/multipath-tcp/mptcpd/wiki/Plugins) using
* the C API that is described here.
*
* To change this behavior, with NetworkManager, look for the
* `connection.mptcp-flags` option in the
* [settings](https://networkmanager.dev/docs/api/latest/nm-settings-nmcli.html#nm-settings-nmcli.property.connection.mptcp-flags),
* while for `mptcpd`, look at the `/etc/mptcpd/mptcpd.conf` config
* file, or disable the service if it is not needed. Make sure not to
* have both NetworkManager and `mptcpd` conflicting to configure the
* MPTCP endpoints.
*
* @see Additional higher level documentation is available in the
* [`mptcpd` Wiki](https://github.com/multipath-tcp/mptcpd/wiki/Plugins).
*/
Expand Down

0 comments on commit c002799

Please sign in to comment.