mirror of
https://github.com/ilyakooo0/nixpkgs.git
synced 2024-09-11 07:15:54 +03:00
nixos/mycelium: description updates
- Slight rewordings and typo fixes. - Use documentation prefixes for addresses, rather than 1.2.3.4, and add IPv6 examples. - Fix description for `keyFile` (`/var/lib/mycelium/key{,.bin}`). - Some formatting by my editor
This commit is contained in:
parent
a98cfd17a8
commit
21721e4196
@ -9,17 +9,23 @@ in
|
||||
peers = lib.mkOption {
|
||||
type = lib.types.listOf lib.types.str;
|
||||
description = ''
|
||||
List of peers to connect to in the format quic://1.2.3.4:9651.
|
||||
If addHostedPublicNodes is set to true, the hosted public nodes will be added to this list.
|
||||
List of peers to connect to, in the formats:
|
||||
- `quic://[2001:0db8::1]:9651`
|
||||
- `quic://192.0.2.1:9651`
|
||||
- `tcp://[2001:0db8::1]:9651`
|
||||
- `tcp://192.0.2.1:9651`
|
||||
|
||||
If addHostedPublicNodes is set to true, the hosted public nodes will also be added.
|
||||
'';
|
||||
default = [];
|
||||
default = [ ];
|
||||
};
|
||||
keyFile = lib.mkOption {
|
||||
type = lib.types.nullOr lib.types.path;
|
||||
default = null;
|
||||
description = ''
|
||||
optional path to a keyFile, if unset the default location (/var/lib/mycelium/key) will be used
|
||||
If this key does not exist, it will be generated
|
||||
Optional path to a file containing the mycelium key material.
|
||||
If unset, the default location (`/var/lib/mycelium/key.bin`) will be used.
|
||||
If no key exist at this location, it will be generated on startup.
|
||||
'';
|
||||
};
|
||||
openFirewall = lib.mkOption {
|
||||
@ -37,7 +43,7 @@ in
|
||||
type = lib.types.bool;
|
||||
default = true;
|
||||
description = ''
|
||||
add the hosted peers from https://github.com/threefoldtech/mycelium#hosted-public-nodes
|
||||
Adds the hosted peers from https://github.com/threefoldtech/mycelium#hosted-public-nodes.
|
||||
'';
|
||||
};
|
||||
};
|
||||
@ -79,9 +85,10 @@ in
|
||||
"--key-file \${CREDENTIALS_DIRECTORY}/keyfile" else
|
||||
"--key-file %S/mycelium/key.bin"
|
||||
)
|
||||
"--tun-name" "mycelium"
|
||||
"--tun-name"
|
||||
"mycelium"
|
||||
] ++
|
||||
(lib.optional (cfg.addHostedPublicNodes || cfg.peers != []) "--peers")
|
||||
(lib.optional (cfg.addHostedPublicNodes || cfg.peers != [ ]) "--peers")
|
||||
++ cfg.peers ++ (lib.optionals cfg.addHostedPublicNodes [
|
||||
"tcp://188.40.132.242:9651" # DE 01
|
||||
"tcp://[2a01:4f8:221:1e0b::2]:9651"
|
||||
|
Loading…
Reference in New Issue
Block a user