[Openvpn-devel,24/25] dco-win: add documentation to README.dco.md

Message ID 20220624083809.23487-25-a@unstable.cc
State Changes Requested
Headers show
Series ovpn-dco: introduce data-channel offload support | expand

Commit Message

Antonio Quartulli June 23, 2022, 10:38 p.m. UTC
Signed-off-by: Arne Schwabe <arne@rfc2549.org>
Signed-off-by: Lev Stipakov <lev@openvpn.net>
Signed-off-by: Antonio Quartulli <a@unstable.cc>
---
 README.dco.md | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Heiko Hund July 5, 2022, 2:32 a.m. UTC | #1
On Freitag, 24. Juni 2022 10:38:08 CEST Antonio Quartulli wrote:
> +Getting started (Windows)
> +-------------------------
> +Getting started under windows is currently for brave people having
> experience 
> +with windows development. You need to compile openvpn yourself
> and also need 
> +to get the test driver installed on your system.

Not so brave anymore, maybe rephrase with more concrete steps to perform.

Patch

diff --git a/README.dco.md b/README.dco.md
index e73e0fc2..ef56f0fe 100644
--- a/README.dco.md
+++ b/README.dco.md
@@ -58,6 +58,13 @@  see a message like
 in your log.
 
 
+Getting started (Windows)
+-------------------------
+Getting started under windows is currently for brave people having experience
+with windows development. You need to compile openvpn yourself and also need
+to get the test driver installed on your system.
+
+
 DCO and P2P mode
 ----------------
 DCO is also available when running OpenVPN in P2P mode without --pull/--client option.
@@ -109,6 +116,8 @@  Limitations by design
 - topology subnet is the only supported `--topology` for servers
 - iroute directives install routes on the host operating system, see also
   Routing with ovpn-dco
+- (ovpn-dco-win) client and p2p mode only
+- (ovpn-dco-win) Chacha20-Poly1305 support available starting with Windows 11
 
 
 Current implementation limitations