[PATCH] documentation: add explanation for wireguard keep-alive setting

  • Done
  • quality assurance status badge
Details
2 participants
  • Guillaume Le Vaillant
  • Solene Rapenne
Owner
unassigned
Submitted by
Solene Rapenne
Severity
normal

Debbugs page

Solene Rapenne wrote 4 years ago
(address . guix-patches@gnu.org)
20210523131342.15fb478c@perso.pw
---
doc/guix.texi | 5 +++++
1 file changed, 5 insertions(+)

Toggle diff (18 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index e8b0485f78..1d2d14d332 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -27104,6 +27104,11 @@ the file does not exist.
The authorized peers on this interface. This is a list of
@var{wireguard-peer} records.
+@item @code{keep-alive} (default: @code{#f})
+The seconds between keepalive packets, may be required to keep the VPN
+alive behind a NAT. When set to @code{#f} there is no keepalive and
+the VPN is fully stateless.
+
@end table
@end deftp
--
2.31.1
Guillaume Le Vaillant wrote 4 years ago
(name . Solene Rapenne)(address . solene@perso.pw)(address . 48607@debbugs.gnu.org)
87o8d1bfcb.fsf@kitej
Solene Rapenne <solene@perso.pw> skribis:

Toggle quote (20 lines)
> ---
> doc/guix.texi | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index e8b0485f78..1d2d14d332 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -27104,6 +27104,11 @@ the file does not exist.
> The authorized peers on this interface. This is a list of
> @var{wireguard-peer} records.
>
> +@item @code{keep-alive} (default: @code{#f})
> +The seconds between keepalive packets, may be required to keep the VPN
> +alive behind a NAT. When set to @code{#f} there is no keepalive and
> +the VPN is fully stateless.
> +
> @end table
> @end deftp

Hi,

There's already a description for 'keep-alive' in the section about
the 'wireguard-peer' data type, around line 27128.
-----BEGIN PGP SIGNATURE-----

iIUEAREKAC0WIQTLxZxm7Ce5cXlAaz5r6CCK3yH+PwUCYKp+lA8cZ2x2QHBvc3Rl
by5uZXQACgkQa+ggit8h/j+fKgD8DDKHScLVDsjhX8yDEbkIMKXqRbewIeX4mZAO
5vgNIDUA/A55KaZuASR4zjYg84owEtNlN+OmsYbqGImnLGPi5TwM
=5/3R
-----END PGP SIGNATURE-----

Solene Rapenne wrote 4 years ago
(name . Guillaume Le Vaillant)(address . glv@posteo.net)(address . 48607@debbugs.gnu.org)
20210523183247.492fc816@perso.pw
Le Sun, 23 May 2021 16:11:00 +0000,
Guillaume Le Vaillant <glv@posteo.net> a écrit :

Toggle quote (27 lines)
> Solene Rapenne <solene@perso.pw> skribis:
>
> > ---
> > doc/guix.texi | 5 +++++
> > 1 file changed, 5 insertions(+)
> >
> > diff --git a/doc/guix.texi b/doc/guix.texi
> > index e8b0485f78..1d2d14d332 100644
> > --- a/doc/guix.texi
> > +++ b/doc/guix.texi
> > @@ -27104,6 +27104,11 @@ the file does not exist.
> > The authorized peers on this interface. This is a list of
> > @var{wireguard-peer} records.
> >
> > +@item @code{keep-alive} (default: @code{#f})
> > +The seconds between keepalive packets, may be required to keep the
> > VPN +alive behind a NAT. When set to @code{#f} there is no
> > keepalive and +the VPN is fully stateless.
> > +
> > @end table
> > @end deftp
>
> Hi,
>
> There's already a description for 'keep-alive' in the section about
> the 'wireguard-peer' data type, around line 27128.

Indeed, I missed it, but then why doesn't it appear on this url?
Guillaume Le Vaillant wrote 4 years ago
(name . Solene Rapenne)(address . solene@perso.pw)(address . 48607-done@debbugs.gnu.org)
87lf85bcj9.fsf@kitej
Solene Rapenne <solene@perso.pw> skribis:

Toggle quote (33 lines)
> Le Sun, 23 May 2021 16:11:00 +0000,
> Guillaume Le Vaillant <glv@posteo.net> a écrit :
>
>> Solene Rapenne <solene@perso.pw> skribis:
>>
>> > ---
>> > doc/guix.texi | 5 +++++
>> > 1 file changed, 5 insertions(+)
>> >
>> > diff --git a/doc/guix.texi b/doc/guix.texi
>> > index e8b0485f78..1d2d14d332 100644
>> > --- a/doc/guix.texi
>> > +++ b/doc/guix.texi
>> > @@ -27104,6 +27104,11 @@ the file does not exist.
>> > The authorized peers on this interface. This is a list of
>> > @var{wireguard-peer} records.
>> >
>> > +@item @code{keep-alive} (default: @code{#f})
>> > +The seconds between keepalive packets, may be required to keep the
>> > VPN +alive behind a NAT. When set to @code{#f} there is no
>> > keepalive and +the VPN is fully stateless.
>> > +
>> > @end table
>> > @end deftp
>>
>> Hi,
>>
>> There's already a description for 'keep-alive' in the section about
>> the 'wireguard-peer' data type, around line 27128.
>
> Indeed, I missed it, but then why doesn't it appear on this url?
> https://guix.gnu.org/manual/en/guix.html#index-wireguard_002dpeer

I guess it was added after the branch for the current stable version of
Guix was created.
It appears in the manual of the current/devel version at

I'm closing this issue then.
-----BEGIN PGP SIGNATURE-----

iIUEAREKAC0WIQTLxZxm7Ce5cXlAaz5r6CCK3yH+PwUCYKqMyg8cZ2x2QHBvc3Rl
by5uZXQACgkQa+ggit8h/j9EbgEAlmD9x3j43vGVqqBl95ND1sYo8oHEienTLFNp
noYSiu4A/2//APIVFUrVW0iPllFL5cvaRZDW2BXipNkOa/jOK63q
=mAmk
-----END PGP SIGNATURE-----

Closed
?
Your comment

This issue is archived.

To comment on this conversation send an email to 48607@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 48607
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch
You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags
mumi command -t +confirmed -t +easy
Or, remove the moreinfo tag and set the help tag
mumi command -t -moreinfo -t +help