diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/networking/cjdns.nix')
-rw-r--r-- | nixpkgs/nixos/modules/services/networking/cjdns.nix | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/nixpkgs/nixos/modules/services/networking/cjdns.nix b/nixpkgs/nixos/modules/services/networking/cjdns.nix index 0d97d379e907..5a19475161fd 100644 --- a/nixpkgs/nixos/modules/services/networking/cjdns.nix +++ b/nixpkgs/nixos/modules/services/networking/cjdns.nix @@ -13,27 +13,27 @@ let { options = { password = mkOption { type = types.str; - description = "Authorized password to the opposite end of the tunnel."; + description = lib.mdDoc "Authorized password to the opposite end of the tunnel."; }; login = mkOption { default = ""; type = types.str; - description = "(optional) name your peer has for you"; + description = lib.mdDoc "(optional) name your peer has for you"; }; peerName = mkOption { default = ""; type = types.str; - description = "(optional) human-readable name for peer"; + description = lib.mdDoc "(optional) human-readable name for peer"; }; publicKey = mkOption { type = types.str; - description = "Public key at the opposite end of the tunnel."; + description = lib.mdDoc "Public key at the opposite end of the tunnel."; }; hostname = mkOption { default = ""; example = "foobar.hype"; type = types.str; - description = "Optional hostname to add to /etc/hosts; prevents reverse lookup failures."; + description = lib.mdDoc "Optional hostname to add to /etc/hosts; prevents reverse lookup failures."; }; }; }; @@ -87,7 +87,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable the cjdns network encryption and routing engine. A file at /etc/cjdns.keys will be created if it does not exist to contain a random @@ -99,7 +99,7 @@ in type = types.attrs; default = {}; example = { router.interface.tunDevice = "tun10"; }; - description = '' + description = lib.mdDoc '' Extra configuration, given as attrs, that will be merged recursively with the rest of the JSON generated by this module, at the root node. ''; @@ -109,7 +109,7 @@ in type = types.nullOr types.path; default = null; example = "/etc/cjdroute.conf"; - description = '' + description = lib.mdDoc '' Ignore all other cjdns options and load configuration from this file. ''; }; @@ -122,7 +122,7 @@ in "z9md3t4p45mfrjzdjurxn4wuj0d8swv" "49275fut6tmzu354pq70sr5b95qq0vj" ]; - description = '' + description = lib.mdDoc '' Any remote cjdns nodes that offer these passwords on connection will be allowed to route through this node. ''; @@ -132,7 +132,7 @@ in bind = mkOption { type = types.str; default = "127.0.0.1:11234"; - description = '' + description = lib.mdDoc '' Bind the administration port to this address and port. ''; }; @@ -143,7 +143,7 @@ in type = types.str; default = ""; example = "192.168.1.32:43211"; - description = '' + description = lib.mdDoc '' Address and port to bind UDP tunnels to. ''; }; @@ -159,7 +159,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Credentials for making UDP tunnels. ''; }; @@ -171,16 +171,16 @@ in default = ""; example = "eth0"; description = - '' + lib.mdDoc '' Bind to this device for native ethernet operation. - <literal>all</literal> is a pseudo-name which will try to connect to all devices. + `all` is a pseudo-name which will try to connect to all devices. ''; }; beacon = mkOption { type = types.int; default = 2; - description = '' + description = lib.mdDoc '' Auto-connect to other cjdns nodes on the same network. Options: 0: Disabled. @@ -206,7 +206,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Credentials for connecting look similar to UDP credientials except they begin with the mac address. ''; @@ -216,9 +216,9 @@ in addExtraHosts = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to add cjdns peers with an associated hostname to - <filename>/etc/hosts</filename>. Beware that enabling this + {file}`/etc/hosts`. Beware that enabling this incurs heavy eval-time costs. ''; }; |