[Openvpn-devel,v100,05/10] dco-win: add documentation to README.dco.md

Message ID 20220812130657.29899-6-a@unstable.cc
State Changes Requested
Headers show
Series ovpn-dco: leftovers | expand

Commit Message

Antonio Quartulli Aug. 12, 2022, 3:06 a.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 | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

Comments

Lev Stipakov Aug. 12, 2022, 6:59 a.m. UTC | #1
Hi,

+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.
>

While I consider building openvpn and installing test-signed drivers as
common knowledge,
this is not necessarily needed to try out dco-win.

We have GHA-based automation which builds openvpn, builds MSI installers for
x86/x64/arm64 and uploads those to build.openvpn.net.

So to try out dco-win, one just needs to get installation package from

https://build.openvpn.net/downloads/snapshots/github-actions/openvpn2/

-Lev
<div dir="ltr"><div dir="ltr">Hi,</div><div dir="ltr"><br></div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
+Getting started (Windows)<br>
+-------------------------<br>
+Getting started under windows is currently for brave people having experience<br>
+with windows development. You need to compile openvpn yourself and also need<br>
+to get the test driver installed on your system.<br></blockquote><div><br></div><div>While I consider building openvpn and installing test-signed drivers as common knowledge,</div><div>this is not necessarily needed to try out dco-win.</div><div><br></div><div>We have GHA-based automation which builds openvpn, builds MSI installers for</div><div>x86/x64/arm64 and uploads those to <a href="http://build.openvpn.net">build.openvpn.net</a>.</div><div><br></div><div>So to try out dco-win, one just needs to get installation package from   </div><div><br></div><div><a href="https://build.openvpn.net/downloads/snapshots/github-actions/openvpn2/">https://build.openvpn.net/downloads/snapshots/github-actions/openvpn2/</a></div><div><br></div><div>-Lev</div></div></div>

Patch

diff --git a/README.dco.md b/README.dco.md
index c38d3de3..d67f6e7e 100644
--- a/README.dco.md
+++ b/README.dco.md
@@ -57,6 +57,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` /
@@ -111,7 +118,9 @@  Limitations by design
   - older versions are missing support for the AEAD ciphers;
 - topology subnet is the only supported `--topology` for servers;
 - iroute directives install routes on the host operating system, see also
-  Routing with ovpn-dco.
+  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