MyNixOS website logo
option

services.yggdrasil.settings

Configuration for yggdrasil, as a Nix attribute set.

Warning: this is stored in the WORLD-READABLE Nix store! Therefore, it is not appropriate for private keys. If you wish to specify the keys, use configFile.

If the persistentKeys is enabled then the keys that are generated during activation will override those in settings or configFile.

If no keys are specified then ephemeral keys are generated and the Yggdrasil interface will have a random IPv6 address each time the service is started. This is the default.

If both configFile and settings are supplied, they will be combined, with values from configFile taking precedence.

You can use the command nix-shell -p yggdrasil --run "yggdrasil -genconf" to generate default configuration values with documentation.

Declarations
Type
JSON value
Default
{ }
Example
{
  Listen = [
    "tcp://0.0.0.0:xxxxx"
  ];
  Peers = [
    "tcp://aa.bb.cc.dd:eeeee"
    "tcp://[aaaa:bbbb:cccc:dddd::eeee]:fffff"
  ];
}