Skip to content

Commit

Permalink
docs: fix grpc_tunnel value to true
Browse files Browse the repository at this point in the history 
grpc_tunnel is described as being enabled by using the value yes in the docs, but it should be true.

Signed-off-by: Simon-Boyer <si.boyer@hotmail.ca>
Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
  • Loading branch information
@Simon-Boyer @smira
Simon-Boyer authored and smira committed May 7, 2024
1 parent b7b8a8d commit be510f9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions website/content/v1.7/talos-guides/network/siderolink.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ SideroLink is a foundation building block of [Sidero Omni](https://www.siderolab

SideroLink is configured by providing the SideroLink API server address, either via kernel command line argument `siderolink.api` or as a [config document]({{< relref "../../reference/configuration/siderolink/siderolinkconfig" >}}).

SideroLink API URL: `https://siderolink.api/?jointoken=token&grpc_tunnel=yes`.
SideroLink API URL: `https://siderolink.api/?jointoken=token&grpc_tunnel=true`.
If URL scheme is `grpc://`, the connection will be established without TLS, otherwise, the connection will be established with TLS.
If specified, join token `token` will be sent to the SideroLink server.
If `grpc_tunnel` is set to `yes`, the Wireguard traffic will be tunneled over the same SideroLink API gRPC connection instead of using plain UDP.
If `grpc_tunnel` is set to `true`, the Wireguard traffic will be tunneled over the same SideroLink API gRPC connection instead of using plain UDP.

## Connection Flow

Expand Down
4 changes: 2 additions & 2 deletions website/content/v1.8/talos-guides/network/siderolink.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ SideroLink is a foundation building block of [Sidero Omni](https://www.siderolab

SideroLink is configured by providing the SideroLink API server address, either via kernel command line argument `siderolink.api` or as a [config document]({{< relref "../../reference/configuration/siderolink/siderolinkconfig" >}}).

SideroLink API URL: `https://siderolink.api/?jointoken=token&grpc_tunnel=yes`.
SideroLink API URL: `https://siderolink.api/?jointoken=token&grpc_tunnel=true`.
If URL scheme is `grpc://`, the connection will be established without TLS, otherwise, the connection will be established with TLS.
If specified, join token `token` will be sent to the SideroLink server.
If `grpc_tunnel` is set to `yes`, the Wireguard traffic will be tunneled over the same SideroLink API gRPC connection instead of using plain UDP.
If `grpc_tunnel` is set to `true`, the Wireguard traffic will be tunneled over the same SideroLink API gRPC connection instead of using plain UDP.

## Connection Flow

Expand Down

0 comments on commit be510f9

Please sign in to comment.