Hyprspace

Hyprspace Options

listenAddresses Link copied!

Type: list of multiaddr

List of addresses to listen on for libp2p traffic.

Default: [ "/ip4/0.0.0.0/tcp/8001" "/ip4/0.0.0.0/udp/8001/quic-v1" "/ip6/::/tcp/8001" "/ip6/::/udp/8001/quic-v1" ]
Declared in: listenAddresses

peers Link copied!

Type: list of (submodule)

Trusted peers in the network.

Default: [ ]
Example: 
[
  {
    id = "12D3KooWKgq4aJpZM8Simple";
  }
  {
    id = "12D3KooWQWiPeNvXFdHFRouter";
    name = "router";
    routes = [
      {
        net = "10.10.0.0/16";
      }
      {
        net = "2001:db8:1::/64";
      }
    ];
  }
]
Declared in: peers

peers.*.id Link copied!

Type: string

PeerID of this peer.

Example: "12D3KooWCcKjF5PNZ7uXTMyNode"
Declared in: peers.*.id

peers.*.name Link copied!

Type: string

Friendly name for this peer. (optional)

Default: ""
Example: "mynode"
Declared in: peers.*.name

peers.*.routes Link copied!

Type: list of (submodule)

Networks to route to this peer. (optional)

Default: [ ]
Example: 
[
  {
    net = "10.10.0.0/16";
  }
]
Declared in: peers.*.routes

peers.*.routes.*.net Link copied!

Type: IP/CIDR network

Network specification.

Declared in: peers.*.routes.*.net

privateKey Link copied!

Type: string

This node's private key.

Example: "z23jhTd4Cvo9iq9oMAweQZkCnuHLRThisIsAnInvalidExampleKey"
Declared in: privateKey

services Link copied!

Type: attribute set of (submodule)

The services this node provides via the Service Network.

Default: { }
Example: 
{
  gameserver = {
    acl = {
      enableWhitelist = true;
      whitelist = [
        "@friend1"
        "@friend2"
      ];
    };
    target = "/ip4/10.0.0.2/tcp/27015";
  };
  www-local = {
    target = "/tcp/8080";
  };
}
Declared in: services

services.<name>.acl.blacklist Link copied!

Type: list of string

List of peers that are explicitly not allowed to connect.

Default: [ ]
Example: 
[
  "12D3KooWQWiPeNvXFdHFUntrustedPeer"
  "@badpeer"
]
Declared in: services..acl.blacklist

services.<name>.acl.enableWhitelist Link copied!

Type: boolean

Whether to enable whitelist enforcement.

Default: false
Example: true
Declared in: services..acl.enableWhitelist

services.<name>.acl.whitelist Link copied!

Type: list of string

List of peers that are allowed to connect.

Default: [ ]
Example: 
[
  "12D3KooWQWiPeNvXFdHFTrustedPeer"
  "@goodpeer"
]
Declared in: services..acl.whitelist

services.<name>.target Link copied!

Type: multiaddr

Target address.

Example: "/tcp/8080"
Declared in: services..target