make machine --user-mode-networking docs more clear

The docs were outdated mentioning the qemu backed for Mac and I find the
way they are written to be a bit confusing.

I think it is best to start with that this option is not supported on
all the providers except WSL.

Fixes: #26780

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
This commit is contained in:
Paul Holzinger
2025-08-08 12:35:51 +02:00
parent 9f7af81cf8
commit 5706d2a61e

View File

@ -4,18 +4,21 @@
####> are applicable to all of those. ####> are applicable to all of those.
#### **--user-mode-networking** #### **--user-mode-networking**
Indicates that this machine relays traffic from the guest through a user-space This option can only be used for the WSL provider on Windows. On all other
process running on the host. In some VPN configurations the VPN may drop platforms this option is ignored and user mode networking will always be
traffic from alternate network interfaces, including VM network devices. By `true` there because these providers always depend on gvproxy (our user
enabling user-mode networking (a setting of `true`), VPNs observe all mode networking tool for the VMs)
podman machine traffic as coming from the host, bypassing the problem.
When the qemu backend is used (Linux, Mac), user-mode networking is In contrast, The Windows/WSL backend defaults to `false`, and follows the
mandatory and the only allowed value is `true`. In contrast, The Windows/WSL standard WSL network setup.
backend defaults to `false`, and follows the standard WSL network setup.
Changing this setting to `true` on Windows/WSL informs Podman to replace Changing this setting to `true` on Windows/WSL informs Podman to replace
the WSL networking setup on start of this machine instance with a user-mode the WSL networking setup on start of this machine instance with a user-mode
networking distribution. Since WSL shares the same kernel across networking distribution. Since WSL shares the same kernel across
distributions, all other running distributions reuses this network. distributions, all other running distributions reuses this network.
Likewise, when the last machine instance with a `true` setting stops, the Likewise, when the last machine instance with a `true` setting stops, the
original networking setup is restored. original networking setup is restored.
In some VPN configurations the VPN may drop traffic from alternate network
interfaces, including VM network devices. By enabling user-mode networking
VPNs observe all podman machine traffic as coming from the host, bypassing
the problem.