From edf113b8138a2e535657c3609eccaef9cc26f060 Mon Sep 17 00:00:00 2001 From: David Sommerseth Date: Fri, 6 Oct 2023 12:01:25 +0200 Subject: [PATCH] docs: Minor touches to README and BUILD docs Signed-off-by: David Sommerseth --- BUILD.md | 10 +++++----- README.md | 23 +++++++++-------------- 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/BUILD.md b/BUILD.md index cf5f31fa..36188de3 100644 --- a/BUILD.md +++ b/BUILD.md @@ -41,7 +41,7 @@ The following dependencies are needed: https://tls.mbed.org/ -* GLib2 2.50 or newer +* GLib2 2.56 or newer http://www.gtk.org This dependency is due to the GDBus library, which is the D-Bus @@ -55,7 +55,7 @@ The following dependencies are needed: http://people.redhat.com/sgrubb/libcap-ng -* liblz4 1.7.3 or newer +* liblz4 1.8.4 or newer https://lz4.github.io/lz4 @@ -63,7 +63,7 @@ The following dependencies are needed: https://en.wikipedia.org/wiki/Util-linux -* polkit 0.105 or newer +* polkit 0.112 or newer http://www.freedesktop.org/wiki/Software/polkit @@ -86,9 +86,9 @@ The following dependencies are needed: Only needed when building with DCO support -* (optional) Python 3.5 or newer +* (optional) Python 3.6 or newer - If Python 3.5 or newer is found, the openvpn2, openvpn3-autoload utilities + If Python 3.6 or newer is found, the openvpn2, openvpn3-autoload utilities and the openvpn3 Python module will be built and installed. * (optional) Python docutils diff --git a/README.md b/README.md index 7c094c6e..f8249dde 100644 --- a/README.md +++ b/README.md @@ -195,17 +195,10 @@ man page and [OpenVPN 3 D-Bus overview](docs/dbus/dbus-overview.md). -#### TECH PREVIEW: Kernel based Data Channel Offload (DCO) support - -**BEWARE - UNDER HEAVY DEVELOPMENT** - - This feature is under heavy development. It is NOT production - ready and the API between the kernel module and OpenVPN 3 Linux may - change in incompatible ways for the time being until the API is - considered stable. +#### Kernel based Data Channel Offload (DCO) support The Data Channel Offload support moves the processing of the OpenVPN data -channel operations from the client process to the kernel, via the ovpn-dco +channel operations from the client process to the kernel, via the ovpn-dco-v2 kernel module. This means the encryption and decryption of the tunnelled network traffic is kept entirely in kernel space instead of being send back and forth between the kernel and the OpenVPN client process. This @@ -214,17 +207,17 @@ be installed before OpenVPN 3 Linux can make use of this feature. This is shipped in the OpenVPN 3 Linux package repositories or can be built from the [source code](https://gitlab.com/openvpn/ovpn-dco/). -The ovpn-dco kernel module currently only support ***Linux kernel 5.4*** and -newer. Currently supported distributions with DCO support: +The ovpn-dco kernel module currently only support ***Linux kernel 5.4*** +and newer. Currently supported distributions with DCO support: * CentOS 8 * Fedora 36 and newer * Red Hat Enterprise Linux 8 and newer * Ubuntu 20.04 and newer -The ovpn-dco kernel module is currently not functional on RHEL/CentOS due -to the kernel version is older than 4.18. OpenVPN 3 Linux will build with -the ``--enable-dco`` feature but requires a functional ``ovpn-dco`` +The ovpn-dco-v2 kernel module is currently not functional on RHEL/CentOS +due to the kernel version is older than 4.18. OpenVPN 3 Linux will build +with the ``--enable-dco`` feature but requires a functional ``ovpn-dco`` kernel module to be fully functional. To build OpenVPN 3 Linux with this support, add ``--enable-dco`` to the @@ -299,12 +292,14 @@ Debugging For information about debugging, please see [docs/debugging.md](docs/debugging.md) + Building from source -------------------- For information about building OpenVPN 3 Linux from source, please see [BUILD.md](BUILD.md). + Contribution ------------