[Openvpn-devel,v101,4/7] dco-win: add documentation to README.dco.md

Message ID 20220813204224.22576-4-a@unstable.cc
State Accepted
Headers show
Series [Openvpn-devel,v101,1/7] dco-win: introduce low-level code for handling ovpn-dco-win in Windows | expand

Commit Message

Antonio Quartulli Aug. 13, 2022, 10:42 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>
---
Changes from v100:
* add URL to windows installer (openvpn+dco) and modify text
---
 README.dco.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

Comments

Gert Doering Aug. 19, 2022, 12:59 a.m. UTC | #1
Hi,

this looks good to me - will apply as soon as 3/7 goes in (to avoid
having documentation that says "it's in" while it isn't).

Acked-By: Gert Doering <gert@greenie.muc.de>

On Sat, Aug 13, 2022 at 10:42:21PM +0200, Antonio Quartulli wrote:
> Signed-off-by: Arne Schwabe <arne@rfc2549.org>
> Signed-off-by: Lev Stipakov <lev@openvpn.net>
> Signed-off-by: Antonio Quartulli <a@unstable.cc>
> ---
> Changes from v100:
> * add URL to windows installer (openvpn+dco) and modify text
> ---
>  README.dco.md | 11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
> 
> diff --git a/README.dco.md b/README.dco.md
> index c38d3de3..aa93d667 100644
> --- a/README.dco.md
> +++ b/README.dco.md
> @@ -57,6 +57,13 @@ see a message like
>  in your log.
>  
>  
> +Getting started (Windows)
> +-------------------------
> +The simplest way to test DCO under Windows is to download the latest installer
> +from https://build.openvpn.net/downloads/snapshots/github-actions/openvpn2/ .
> +This installer contains the latest OpenVPN code and the ovpn-dco-win driver.
> +
> +
>  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
> -- 
> 2.35.1
> 
> 
> 
> _______________________________________________
> Openvpn-devel mailing list
> Openvpn-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/openvpn-devel
Gert Doering Aug. 25, 2022, 10:18 a.m. UTC | #2
Acked-by: Gert Doering <gert@greenie.muc.de>

Not very much to review here, anyway :-)

Your patch has been applied to the master branch.

commit a8b00c908b4b8567dcfd792b7ab1d9005bcc587b
Author: Antonio Quartulli
Date:   Sat Aug 13 22:42:21 2022 +0200

     dco-win: add documentation to README.dco.md

     Signed-off-by: Arne Schwabe <arne@rfc2549.org>
     Signed-off-by: Lev Stipakov <lev@openvpn.net>
     Signed-off-by: Antonio Quartulli <a@unstable.cc>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <20220813204224.22576-4-a@unstable.cc>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg24921.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/README.dco.md b/README.dco.md
index c38d3de3..aa93d667 100644
--- a/README.dco.md
+++ b/README.dco.md
@@ -57,6 +57,13 @@  see a message like
 in your log.
 
 
+Getting started (Windows)
+-------------------------
+The simplest way to test DCO under Windows is to download the latest installer
+from https://build.openvpn.net/downloads/snapshots/github-actions/openvpn2/ .
+This installer contains the latest OpenVPN code and the ovpn-dco-win driver.
+
+
 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