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