cwinfo/yggdrasil-network.github.io
5
0
Fork 0
mirror of https://github.com/cwinfo/yggdrasil-network.github.io.git synced 2024-11-09 23:50:26 +00:00
Code Releases Activity

Update configuration.md

Browse Source
This commit is contained in:
Neil Alexander 2019-10-25 13:20:21 +01:00 committed by GitHub
parent 46fd84f90e
commit d2f8dafa2f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
configuration.md
View File

@ -47,7 +47,8 @@ A new configuration file has the following format. Please note that some of the
# use this section when you may connect via different interfaces. # use this section when you may connect via different interfaces.
Peers: [ Peers: [
tcp://a.b.c.d:xxxxx tcp://a.b.c.d:xxxxx
tcp://d.c.b.a:xxxxx socks://e.f.g.h:xxxxx/a.b.c.d:xxxxx
tls://a.b.c.d:xxxxx
] ]
# List of connection strings for outbound peer connections in URI format, # List of connection strings for outbound peer connections in URI format,
@ -57,7 +58,7 @@ A new configuration file has the following format. Please note that some of the
InterfacePeers: { InterfacePeers: {
"eth0": [ "eth0": [
tcp://a.b.c.d:xxxxx tcp://a.b.c.d:xxxxx
tcp://d.c.b.a:xxxxx tls://a.b.c.d:xxxxx
] ]
} }
@ -68,6 +69,7 @@ A new configuration file has the following format. Please note that some of the
# tcp://0.0.0.0:0 or tcp://[::]:0 to listen on all interfaces. # tcp://0.0.0.0:0 or tcp://[::]:0 to listen on all interfaces.
Listen: [ Listen: [
tcp://[::]:xxxxx tcp://[::]:xxxxx
tls://[::]:xxxxx
] ]
# Listen address for admin connections. Default is to listen for local # Listen address for admin connections. Default is to listen for local
@ -210,19 +212,21 @@ Note that any field not specified in the configuration will use its default valu
## Configuration Options ## Configuration Options
- `Listen` - `Listen`
- A list of strings in the form `[ "tcp://listenAddress:listenPort", ... ]`, on which to listen for (TCP) connections from peers. - A list of strings in the form `[ "tcp://listenAddress:listenPort", "tls://listenAddress:listenPort", ... ]`, on which to listen for TCP or TLS connections from peers.
- Note that, due to Go language design choices, `[::]` listens on IPv4 and IPv6 on most platforms, while an empty IP or `0.0.0.0` listens only to IPv4. - Note that, due to Go language design choices, `[::]` listens on IPv4 and IPv6 on most platforms, while an empty IP or `0.0.0.0` listens only to IPv4.
- A `tcp://` listener can only accept `tcp://` peer connections, and a `tls://` listener can only accept `tls://` peer connections
- `AdminListen` - `AdminListen`
- Port to listen on for the admin socket, specified in URI format, i.e. `tcp://localhost:9001`. - Port to listen on for the admin socket, specified in URI format, i.e. `tcp://localhost:9001`.
- On supported platforms, the admin socket can listen on a UNIX domain socket instead, i.e. `unix:///var/run/yggdrasil.sock`. - On supported platforms, the admin socket can listen on a UNIX domain socket instead, i.e. `unix:///var/run/yggdrasil.sock`.
- The default is to listen on the loopback interface (`tcp://localhost:9001`) which ensures that only local connections to the admin socket are allowed. - The default is to listen on the loopback interface (`tcp://localhost:9001`) which ensures that only local connections to the admin socket are allowed.
- Note that if you change the listen address to a non-loopback address, this may allow other hosts on the network to manage the Yggdrasil process. This probably isn't desirable. - Note that if you change the listen address to a non-loopback address, this may allow other hosts on the network to manage the Yggdrasil process. This probably isn't desirable.
- `Peers` - `Peers`
- A list of strings in the form `[ "tcp://peerAddress:peerPort", "socks://proxyAddress:proxyPort/peerAddress:peerPort", ... ]` of peers to connect to. - A list of strings in the form `[ "tcp://peerAddress:peerPort", "tls://peerAddress:peerPort", "socks://proxyAddress:proxyPort/peerAddress:peerPort", ... ]` of peers to connect to.
- Peer hostnames can be specified either using IPv4 addresses, IPv6 addresses or DNS names. - Peer hostnames can be specified either using IPv4 addresses, IPv6 addresses or DNS names.
- Each entry should begin with `tcp://` or `socks://proxyAddress:proxyPort/`. - Each entry should begin with `tcp://` or `socks://proxyAddress:proxyPort/`.
- `InterfacePeers` - `InterfacePeers`
- Like peers above, but arranged using specific interface names: `{ "eth0": [ "tcp://peerAddress:peerPort", "socks://proxyAddress:proxyPort/peerAddress:peerPort", ... ], "eth1": [], ... }` of peers to connect to. - Like peers above, but arranged using specific interface names: `{ "eth0": [ "tcp://peerAddress:peerPort", "tls://peerAddress:peerPort", "socks://proxyAddress:proxyPort/peerAddress:peerPort", ... ], "eth1": [], ... }` of peers to connect to.
- A `tcp://` peer connection can only connect to a `tcp://` listener, and a `tls://` peer connection can only connect to a `tls://` listener
- `AllowedEncryptionPublicKeys` - `AllowedEncryptionPublicKeys`
- A list of strings in the form `["key", "key", ...]`, where `key` is each node's `EncryptionPublicKey` key which you would like to allow connections from. - A list of strings in the form `["key", "key", ...]`, where `key` is each node's `EncryptionPublicKey` key which you would like to allow connections from.
- This option allows you to restrict which other nodes can connect to your Yggdrasil node as a peer. It applies to incoming TCP connections. - This option allows you to restrict which other nodes can connect to your Yggdrasil node as a peer. It applies to incoming TCP connections.