Skip to content

Wgautomesh

services.wgautomesh.enable

Whether to enable the wgautomesh daemon. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.enableGossipEncryption

Enable encryption of gossip traffic. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.enablePersistence

Enable persistence of Wireguard peer info between restarts. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.gossipSecretFile

File containing the gossip secret, a shared secret key to use for gossip encryption. Required if enableGossipEncryption is set. This file may contain any arbitrary-length utf8 string. To generate a new gossip secret, use a command such as openssl rand -base64 32.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.logLevel

wgautomesh log level. Type: one of "trace", "debug", "info", "warn", "error"

Default

"info"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.openFirewall

Automatically open gossip port in firewall (recommended). Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings

Configuration for wgautomesh. Type: TOML value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings.gossip_port

wgautomesh gossip port, this MUST be the same number on all nodes in the wgautomesh network.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

1666

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings.interface

Wireguard interface to manage (it is NOT created by wgautomesh, you should use another NixOS option to create it such as networking.wireguard.interfaces.wg0 = {...};).

Type: string

Example

"wg0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings.lan_discovery

Enable discovery of peers on the same LAN using UDP broadcast. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings.peers

wgautomesh peer list. Type: list of (submodule)

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings.peers.*.address

Wireguard address of this peer (a single IP address, multiple addresses or address ranges are not supported).

Type: string

Example

"10.0.0.42"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings.peers.*.endpoint

Bootstrap endpoint for connecting to this Wireguard peer if no other address is known or none are working.

Type: null or string

Default

null

Example

"wgnode.mydomain.example:51820"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings.peers.*.pubkey

Wireguard public key of this peer. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix

services.wgautomesh.settings.upnp_forward_external_port

Public port number to try to redirect to this machine's Wireguard daemon using UPnP IGD.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/wgautomesh.nix