upstream/openvpn
1
0
Fork 0
mirror of https://github.com/OpenVPN/openvpn.git synced 2026-02-03 20:39:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

README.dco: update Linux instructions

Browse source 
Update the README.dco file by including instructions related
to the new 'ovpn' linux kernel module.

Change-Id: I22af9957b27785514d8c6d58fe4f2100d007fa5c
Signed-off-by: Antonio Quartulli <antonio@mandelbit.com>
Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
Message-Id: <20250716135430.23484-1-gert@greenie.muc.de>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg32180.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
This commit is contained in:
Antonio Quartulli 2025-07-16 15:54:25 +02:00 committed by Gert Doering
parent 074bd7451d
commit 3fdbad8435
1 changed files with 14 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.dco.md
View file

@ -14,26 +14,22 @@ Overview of current release
Getting started (Linux)
-----------------------
- Use a recent Linux kernel. Linux 5.4.0 and newer are known to work with
ovpn-dco.
The new DCO linux kernel module (namely `ovpn`) has been merged upstream
as of linux-6.16. From this kernel version onwards you directly get
the DCO module as shipped by your kernel.
NOTE: the new `ovpn` Linux kernel module is compatible only with OpenVPN
2.7 and greater.
Get the ovpn-dco module from one these urls and build it:
Alternatively, if you run an older kernel or if you want to use a more
recent DCO module than the one shipped by your kernel, you need to use
the ovpn-backports project.
* https://gitlab.com/openvpn/ovpn-dco
* https://github.com/OpenVPN/ovpn-dco
To learn how to use the ovpn-backports project and build your own DCO
kernel module, please refer to the README file available at:
e.g.
https://github.com/OpenVPN/ovpn-backports/blob/main/README.md
git clone https://github.com/OpenVPN/ovpn-dco
cd ovpn-dco
make
sudo make install
If you want to report bugs please ensure to compile ovpn-dco with
`make DEBUG=1` and include any debug message being printed by the
kernel (you can view those messages with `dmesg`).
Clone and build OpenVPN (or use OpenVPN 2.6+). For example:
Then clone and build OpenVPN (or use OpenVPN 2.7+). For example:
git clone https://github.com/openvpn/openvpn.git
cd openvpn
@ -48,8 +44,8 @@ support. If the configuration contains an option that is incompatible with
data channel offloading, OpenVPN will automatically disable DCO support and
warn the user.
Should OpenVPN be configured to use a feature that is not supported by ovpn-dco
or should the ovpn-dco kernel module not be available on the system, you will
Should OpenVPN be configured to use a feature that is not supported by ovpn
or should the ovpn kernel module not be available on the system, you will
see a message like
Note: Kernel support for ovpn-dco missing, disabling data channel offload.
@ -131,4 +127,3 @@ Current implementation limitations
- `--persist-tun` not tested;
- IPv6 mapped IPv4 addresses need Linux 5.4.189+/5.10.110+/5.12+ to work;
- some incompatible options may not properly fallback to non-dco;
- no per client statistics. Only total statistics available on the interface.