Skip to content

Commit

Permalink
docs: Minor touches to README and BUILD docs
Browse files Browse the repository at this point in the history
Signed-off-by: David Sommerseth <davids@openvpn.net>
  • Loading branch information
dsommers committed Oct 6, 2023
1 parent 8881bf3 commit edf113b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 19 deletions.
10 changes: 5 additions & 5 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -55,15 +55,15 @@ 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

* libuuid 2.23.2 or newer

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

* polkit 0.105 or newer
* polkit 0.112 or newer

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

Expand All @@ -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
Expand Down
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
------------

Expand Down

0 comments on commit edf113b

Please sign in to comment.