Skip to content

Commit edf113b

Browse files
committed
docs: Minor touches to README and BUILD docs
Signed-off-by: David Sommerseth <[email protected]>
1 parent 8881bf3 commit edf113b

File tree

2 files changed

+14
-19
lines changed

2 files changed

+14
-19
lines changed

BUILD.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The following dependencies are needed:
4141

4242
https://tls.mbed.org/
4343

44-
* GLib2 2.50 or newer
44+
* GLib2 2.56 or newer
4545

4646
http://www.gtk.org
4747
This dependency is due to the GDBus library, which is the D-Bus
@@ -55,15 +55,15 @@ The following dependencies are needed:
5555

5656
http://people.redhat.com/sgrubb/libcap-ng
5757

58-
* liblz4 1.7.3 or newer
58+
* liblz4 1.8.4 or newer
5959

6060
https://lz4.github.io/lz4
6161

6262
* libuuid 2.23.2 or newer
6363

6464
https://en.wikipedia.org/wiki/Util-linux
6565

66-
* polkit 0.105 or newer
66+
* polkit 0.112 or newer
6767

6868
http://www.freedesktop.org/wiki/Software/polkit
6969

@@ -86,9 +86,9 @@ The following dependencies are needed:
8686

8787
Only needed when building with DCO support
8888

89-
* (optional) Python 3.5 or newer
89+
* (optional) Python 3.6 or newer
9090

91-
If Python 3.5 or newer is found, the openvpn2, openvpn3-autoload utilities
91+
If Python 3.6 or newer is found, the openvpn2, openvpn3-autoload utilities
9292
and the openvpn3 Python module will be built and installed.
9393

9494
* (optional) Python docutils

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -195,17 +195,10 @@ man page and [OpenVPN 3 D-Bus overview](docs/dbus/dbus-overview.md).
195195

196196

197197

198-
#### TECH PREVIEW: Kernel based Data Channel Offload (DCO) support
199-
200-
**BEWARE - UNDER HEAVY DEVELOPMENT**
201-
202-
This feature is under heavy development. It is NOT production
203-
ready and the API between the kernel module and OpenVPN 3 Linux may
204-
change in incompatible ways for the time being until the API is
205-
considered stable.
198+
#### Kernel based Data Channel Offload (DCO) support
206199

207200
The Data Channel Offload support moves the processing of the OpenVPN data
208-
channel operations from the client process to the kernel, via the ovpn-dco
201+
channel operations from the client process to the kernel, via the ovpn-dco-v2
209202
kernel module. This means the encryption and decryption of the tunnelled
210203
network traffic is kept entirely in kernel space instead of being send
211204
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
214207
shipped in the OpenVPN 3 Linux package repositories or can be built from
215208
the [source code](https://gitlab.com/openvpn/ovpn-dco/).
216209

217-
The ovpn-dco kernel module currently only support ***Linux kernel 5.4*** and
218-
newer. Currently supported distributions with DCO support:
210+
The ovpn-dco kernel module currently only support ***Linux kernel 5.4***
211+
and newer. Currently supported distributions with DCO support:
219212

220213
* CentOS 8
221214
* Fedora 36 and newer
222215
* Red Hat Enterprise Linux 8 and newer
223216
* Ubuntu 20.04 and newer
224217

225-
The ovpn-dco kernel module is currently not functional on RHEL/CentOS due
226-
to the kernel version is older than 4.18. OpenVPN 3 Linux will build with
227-
the ``--enable-dco`` feature but requires a functional ``ovpn-dco``
218+
The ovpn-dco-v2 kernel module is currently not functional on RHEL/CentOS
219+
due to the kernel version is older than 4.18. OpenVPN 3 Linux will build
220+
with the ``--enable-dco`` feature but requires a functional ``ovpn-dco``
228221
kernel module to be fully functional.
229222

230223
To build OpenVPN 3 Linux with this support, add ``--enable-dco`` to the
@@ -299,12 +292,14 @@ Debugging
299292

300293
For information about debugging, please see [docs/debugging.md](docs/debugging.md)
301294

295+
302296
Building from source
303297
--------------------
304298

305299
For information about building OpenVPN 3 Linux from source, please
306300
see [BUILD.md](BUILD.md).
307301

302+
308303
Contribution
309304
------------
310305

0 commit comments

Comments
 (0)