diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/networking/shadowsocks.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/networking/shadowsocks.nix | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/nixpkgs/nixos/modules/services/networking/shadowsocks.nix b/nixpkgs/nixos/modules/services/networking/shadowsocks.nix index 7bea269a9ed0..8eee40711a6d 100644 --- a/nixpkgs/nixos/modules/services/networking/shadowsocks.nix +++ b/nixpkgs/nixos/modules/services/networking/shadowsocks.nix @@ -34,7 +34,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run shadowsocks-libev shadowsocks server. ''; }; @@ -42,7 +42,7 @@ in localAddress = mkOption { type = types.coercedTo types.str singleton (types.listOf types.str); default = [ "[::0]" "0.0.0.0" ]; - description = '' + description = lib.mdDoc '' Local addresses to which the server binds. ''; }; @@ -50,7 +50,7 @@ in port = mkOption { type = types.int; default = 8388; - description = '' + description = lib.mdDoc '' Port which the server uses. ''; }; @@ -58,7 +58,7 @@ in password = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Password for connecting clients. ''; }; @@ -66,7 +66,7 @@ in passwordFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Password file with a password for connecting clients. ''; }; @@ -74,7 +74,7 @@ in mode = mkOption { type = types.enum [ "tcp_only" "tcp_and_udp" "udp_only" ]; default = "tcp_and_udp"; - description = '' + description = lib.mdDoc '' Relay protocols. ''; }; @@ -82,7 +82,7 @@ in fastOpen = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' use TCP fast-open ''; }; @@ -90,8 +90,8 @@ in encryptionMethod = mkOption { type = types.str; default = "chacha20-ietf-poly1305"; - description = '' - Encryption method. See <link xlink:href="https://github.com/shadowsocks/shadowsocks-org/wiki/AEAD-Ciphers"/>. + description = lib.mdDoc '' + Encryption method. See <https://github.com/shadowsocks/shadowsocks-org/wiki/AEAD-Ciphers>. ''; }; @@ -99,7 +99,7 @@ in type = types.nullOr types.str; default = null; example = literalExpression ''"''${pkgs.shadowsocks-v2ray-plugin}/bin/v2ray-plugin"''; - description = '' + description = lib.mdDoc '' SIP003 plugin for shadowsocks ''; }; @@ -108,7 +108,7 @@ in type = types.str; default = ""; example = "server;host=example.com"; - description = '' + description = lib.mdDoc '' Options to pass to the plugin if one was specified ''; }; @@ -119,13 +119,13 @@ in example = { nameserver = "8.8.8.8"; }; - description = '' + description = lib.mdDoc '' Additional configuration for shadowsocks that is not covered by the provided options. The provided attrset will be serialized to JSON and has to contain valid shadowsocks options. Unfortunately most additional options are undocumented but it's easy to find out what is available by looking into the source code of - <link xlink:href="https://github.com/shadowsocks/shadowsocks-libev/blob/master/src/jconf.c"/> + <https://github.com/shadowsocks/shadowsocks-libev/blob/master/src/jconf.c> ''; }; }; |