cwinfo/yggdrasil-network.github.io
5
0
Fork 0
mirror of https://github.com/cwinfo/yggdrasil-network.github.io.git synced 2025-02-28 21:01:33 +00:00
Code Releases Activity

Update configuration reference

Browse Source
This commit is contained in:
Neil Alexander 2024-10-27 21:17:22 +00:00
parent aa4cfa0fe1
commit 25517962f1
No known key found for this signature in database
GPG Key ID: A02A2019A2BB0944
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
configurationref.md
View File

@ -22,10 +22,10 @@ A list of outbound peering connections to make. Peers are specified in URL forma
Additional settings can optionally be added as query-string parameters to the end of the URL: Additional settings can optionally be added as query-string parameters to the end of the URL:
* `password=PASSWORD` — set this only for peers that require a shared secret/password to connect * `password=PASSWORD` — set this only for peers that require a shared secret/password to connect, the password must match the remote side or the connection will fail
* `key=PUBLICKEY` — pin the specified public key for this peer, this will cause the connection to fail if the remote side's key does not match * `key=PUBLICKEY` — pin the specified public key for this peer, this will cause the connection to fail if the remote side's public key does not match what you expect
* `maxbackoff=DURATION` — control what the maximum backoff/retry time will be if the peering goes down, format like `30s` for seconds or `1m` for minutes * `maxbackoff=DURATION` — control what the maximum backoff/retry time will be if the peering goes down, format like `30s` for seconds or `1m` for minutes
* `sni=domainname.com` - set the Server Name Indicator (SNI) for TLS peering connections to a different name (TLS and QUIC only) * `sni=domainname.com` - set the Server Name Indication (SNI) for TLS peering connections to a different name (TLS and QUIC only)
### `InterfacePeers` ### `InterfacePeers`
@ -41,6 +41,10 @@ A list of listeners to open for accepting incoming connections. Instead of suppl
* `unix:///path/to/sock.sock` (UNIX) * `unix:///path/to/sock.sock` (UNIX)
* `ws://[::]:444` (WebSockets, Yggdrasil 0.5.7 or later only) * `ws://[::]:444` (WebSockets, Yggdrasil 0.5.7 or later only)
Additional settings can optionally be added as query-string parameters to the end of the URL:
* `password=PASSWORD` — optionally require a password to connect to this listener, the connecting node's password must match or the connection will fail
### `MulticastInterfaces` ### `MulticastInterfaces`
Controls which interfaces to enable or disable multicast peer discovery on. The default varies by platform. Controls which interfaces to enable or disable multicast peer discovery on. The default varies by platform.