Hyprspace is configured through a simple JSON config file. This page lists the possible values in NixOS options doc style.
listenAddresses
List of addresses to listen on for libp2p traffic.
Type: list of multiaddr
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"
]peers
Trusted peers in the network.
Type: list of (submodule)
Default: [ ]
Example:
[
{
id = "12D3KooWKgq4aJpZM8Simple";
}
{
id = "12D3KooWQWiPeNvXFdHFRouter";
name = "router";
routes = [
{
net = "10.10.0.0/16";
}
{
net = "2001:db8:1::/64";
}
];
}
]peers.*.id
PeerID of this peer.
Type: string
Example: "12D3KooWCcKjF5PNZ7uXTMyNode"
peers.*.name
Friendly name for this peer. (optional)
Type: string
Default: ""
Example: "mynode"
peers.*.routes
Networks to route to this peer. (optional)
Type: list of (submodule)
Default: [ ]
Example:
[
{
net = "10.10.0.0/16";
}
]peers.*.routes.*.net
Network specification.
Type: IP/CIDR network
privateKey
This node’s private key.
Type: string
Example: "z23jhTd4Cvo9iq9oMAweQZkCnuHLRThisIsAnInvalidExampleKey"
services
The services this node provides via the Service Network.
Type: attribute set of (submodule)
Default: { }
Example:
{
gameserver = {
acl = {
enableWhitelist = true;
whitelist = [
"@friend1"
"@friend2"
];
};
target = "/ip4/10.0.0.2/tcp/27015";
};
www-local = {
target = "/tcp/8080";
};
}services.<name>.acl.enableWhitelist
Whether to enable whitelist enforcement.
Type: boolean
Default: false
Example: true
services.<name>.acl.blacklist
List of peers that are explicitly not allowed to connect.
Type: list of string
Default: [ ]
Example:
[
"12D3KooWQWiPeNvXFdHFUntrustedPeer"
"@badpeer"
]services.<name>.acl.whitelist
List of peers that are allowed to connect.
Type: list of string
Default: [ ]
Example:
[
"12D3KooWQWiPeNvXFdHFTrustedPeer"
"@goodpeer"
]services.<name>.target
Target address.
Type: multiaddr
Example: "/tcp/8080"