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.md

Browse Source
This commit is contained in:
Neil Alexander 2018-05-13 21:42:48 +01:00 committed by GitHub
parent e813bf0722
commit fd0233cce6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 63 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
configuration.md
View File

@ -4,35 +4,72 @@ Yggdrasil can be run with a dynamically generated configuration, using sane-ish
In most cases, a static configuration simplifies most setups - it allows you to maintain the same IP address, configure static peers and various other options that will persist across restarts. In most cases, a static configuration simplifies most setups - it allows you to maintain the same IP address, configure static peers and various other options that will persist across restarts.
Configuration can be provided to Yggdrasil in JSON format either through `stdin` (using `yggdrasil --useconf < path/to/configuration.json`) or through a path to a configuration file (using `yggdrasil --useconffile path/to/configuration.json`). Configuration can be provided to Yggdrasil in HJSON format either through `stdin` (using `yggdrasil --useconf < path/to/configuration.json`) or through a path to a configuration file (using `yggdrasil --useconffile path/to/configuration.json`).
A new configuration file may be generated with `yggdrasil --genconf > path/to/configuration.json`, which looks something like: A new configuration file may be generated with `yggdrasil --genconf > path/to/configuration.json`, which looks something like:
```json ```{
{ # Listen address for peer connections (default is to listen for all
"Listen": "[::]:51743", # connections over IPv4 and IPv6)
"AdminListen": "[::1]:9001", Listen: "[::]:45744"
"Peers": [],
"AllowedBoxPubs": [], # Listen address for admin connections (default is to listen only
"BoxPub": "some hex string", # for local connections)
"BoxPriv": "some hex string", AdminListen: "[::1]:9001"
"SigPub": "some hex string",
"SigPriv": "some longer hex string", # List of connection strings for static peers (i.e. tcp://a.b.c.d:e)
"Multicast": true, Peers: []
"LinkLocal": "",
"IfName": "auto", # List of peer BoxPubs to allow UDP incoming TCP connections from
"IfTAPMode": false, # (if left empty/undefined then connections will be allowed by default)
"IfMTU": 65535, AllowedBoxPubs: []
"Net": {
"Tor": { # Your public encryption key (your peers may ask you for this to put
"OnionKeyfile": "", # into their AllowedBoxPubs configuration)
"ControlAddr": "", BoxPub: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
"Enabled": false
}, # Your private encryption key (do not share this with anyone!)
"I2P": { BoxPriv: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
"Keyfile": "",
"Addr": "", # Your public signing key
"Enabled": false SigPub: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# Your private signing key (do not share this with anyone!)
SigPriv: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# Enable or disable automatic peer discovery on the same LAN using multicast
Multicast: true
# Regex for which interfaces multicast peer discovery should be enabled on
LinkLocal: ""
# Local network interface name for TUN/TAP adapter, or "auto", or "none"
IfName: auto
# Set local network interface to TAP mode rather than TUN mode (if supported
# by your platform, option will be ignored if not)
IfTAPMode: false
# Maximux Transmission Unit (MTU) size for your local network interface
IfMTU: 65535
# Extended options for interoperability with other networks
Net:
{
# Experimental options for configuring peerings over Tor
Tor:
{
OnionKeyfile: ""
ControlAddr: ""
Enabled: false
}
# Experimental options for configuring peerings over I2P
I2P:
{
Keyfile: ""
Addr: ""
Enabled: false
} }
} }
} }