diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/misc/rippled.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/misc/rippled.nix | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/nixpkgs/nixos/modules/services/misc/rippled.nix b/nixpkgs/nixos/modules/services/misc/rippled.nix index f6ec0677774b..8b6704c1be77 100644 --- a/nixpkgs/nixos/modules/services/misc/rippled.nix +++ b/nixpkgs/nixos/modules/services/misc/rippled.nix @@ -92,41 +92,41 @@ let ip = mkOption { default = "127.0.0.1"; - description = "Ip where rippled listens."; + description = lib.mdDoc "Ip where rippled listens."; type = types.str; }; port = mkOption { - description = "Port where rippled listens."; + description = lib.mdDoc "Port where rippled listens."; type = types.int; }; protocol = mkOption { - description = "Protocols expose by rippled."; + description = lib.mdDoc "Protocols expose by rippled."; type = types.listOf (types.enum ["http" "https" "ws" "wss" "peer"]); }; user = mkOption { - description = "When set, these credentials will be required on HTTP/S requests."; + description = lib.mdDoc "When set, these credentials will be required on HTTP/S requests."; type = types.str; default = ""; }; password = mkOption { - description = "When set, these credentials will be required on HTTP/S requests."; + description = lib.mdDoc "When set, these credentials will be required on HTTP/S requests."; type = types.str; default = ""; }; admin = mkOption { - description = "A comma-separated list of admin IP addresses."; + description = lib.mdDoc "A comma-separated list of admin IP addresses."; type = types.listOf types.str; default = ["127.0.0.1"]; }; ssl = { key = mkOption { - description = '' + description = lib.mdDoc '' Specifies the filename holding the SSL key in PEM format. ''; default = null; @@ -134,7 +134,7 @@ let }; cert = mkOption { - description = '' + description = lib.mdDoc '' Specifies the path to the SSL certificate file in PEM format. This is not needed if the chain includes it. ''; @@ -143,7 +143,7 @@ let }; chain = mkOption { - description = '' + description = lib.mdDoc '' If you need a certificate chain, specify the path to the certificate chain here. The chain may include the end certificate. ''; @@ -157,33 +157,33 @@ let dbOptions = { options = { type = mkOption { - description = "Rippled database type."; + description = lib.mdDoc "Rippled database type."; type = types.enum ["rocksdb" "nudb"]; default = "rocksdb"; }; path = mkOption { - description = "Location to store the database."; + description = lib.mdDoc "Location to store the database."; type = types.path; default = cfg.databasePath; defaultText = literalExpression "config.${opt.databasePath}"; }; compression = mkOption { - description = "Whether to enable snappy compression."; + description = lib.mdDoc "Whether to enable snappy compression."; type = types.nullOr types.bool; default = null; }; onlineDelete = mkOption { - description = "Enable automatic purging of older ledger information."; + description = lib.mdDoc "Enable automatic purging of older ledger information."; type = types.nullOr (types.addCheck types.int (v: v > 256)); default = cfg.ledgerHistory; defaultText = literalExpression "config.${opt.ledgerHistory}"; }; advisoryDelete = mkOption { - description = '' + description = lib.mdDoc '' If set, then require administrative RPC call "can_delete" to enable online deletion of ledger records. ''; @@ -192,7 +192,7 @@ let }; extraOpts = mkOption { - description = "Extra database options."; + description = lib.mdDoc "Extra database options."; type = types.lines; default = ""; }; @@ -210,14 +210,14 @@ in enable = mkEnableOption "rippled"; package = mkOption { - description = "Which rippled package to use."; + description = lib.mdDoc "Which rippled package to use."; type = types.package; default = pkgs.rippled; defaultText = literalExpression "pkgs.rippled"; }; ports = mkOption { - description = "Ports exposed by rippled"; + description = lib.mdDoc "Ports exposed by rippled"; type = with types; attrsOf (submodule portOptions); default = { rpc = { @@ -241,7 +241,7 @@ in }; nodeDb = mkOption { - description = "Rippled main database options."; + description = lib.mdDoc "Rippled main database options."; type = with types; nullOr (submodule dbOptions); default = { type = "rocksdb"; @@ -256,19 +256,19 @@ in }; tempDb = mkOption { - description = "Rippled temporary database options."; + description = lib.mdDoc "Rippled temporary database options."; type = with types; nullOr (submodule dbOptions); default = null; }; importDb = mkOption { - description = "Settings for performing a one-time import."; + description = lib.mdDoc "Settings for performing a one-time import."; type = with types; nullOr (submodule dbOptions); default = null; }; nodeSize = mkOption { - description = '' + description = lib.mdDoc '' Rippled size of the node you are running. "tiny", "small", "medium", "large", and "huge" ''; @@ -277,7 +277,7 @@ in }; ips = mkOption { - description = '' + description = lib.mdDoc '' List of hostnames or ips where the Ripple protocol is served. For a starter list, you can either copy entries from: https://ripple.com/ripple.txt or if you prefer you can let it @@ -292,7 +292,7 @@ in }; ipsFixed = mkOption { - description = '' + description = lib.mdDoc '' List of IP addresses or hostnames to which rippled should always attempt to maintain peer connections with. This is useful for manually forming private networks, for example to configure a @@ -306,7 +306,7 @@ in }; validators = mkOption { - description = '' + description = lib.mdDoc '' List of nodes to always accept as validators. Nodes are specified by domain or public key. ''; @@ -321,7 +321,7 @@ in }; databasePath = mkOption { - description = '' + description = lib.mdDoc '' Path to the ripple database. ''; type = types.path; @@ -329,7 +329,7 @@ in }; validationQuorum = mkOption { - description = '' + description = lib.mdDoc '' The minimum number of trusted validations a ledger must have before the server considers it fully validated. ''; @@ -338,7 +338,7 @@ in }; ledgerHistory = mkOption { - description = '' + description = lib.mdDoc '' The number of past ledgers to acquire on server startup and the minimum to maintain while running. ''; @@ -347,7 +347,7 @@ in }; fetchDepth = mkOption { - description = '' + description = lib.mdDoc '' The number of past ledgers to serve to other peers that request historical ledger data (or "full" for no limit). ''; @@ -356,7 +356,7 @@ in }; sntpServers = mkOption { - description = '' + description = lib.mdDoc '' IP address or domain of NTP servers to use for time synchronization.; ''; type = types.listOf types.str; @@ -369,7 +369,7 @@ in }; logLevel = mkOption { - description = "Logging verbosity."; + description = lib.mdDoc "Logging verbosity."; type = types.enum ["debug" "error" "info"]; default = "error"; }; @@ -378,13 +378,13 @@ in enable = mkEnableOption "statsd monitoring for rippled"; address = mkOption { - description = "The UDP address and port of the listening StatsD server."; + description = lib.mdDoc "The UDP address and port of the listening StatsD server."; default = "127.0.0.1:8125"; type = types.str; }; prefix = mkOption { - description = "A string prepended to each collected metric."; + description = lib.mdDoc "A string prepended to each collected metric."; default = ""; type = types.str; }; @@ -393,7 +393,7 @@ in extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the rippled.cfg configuration file. ''; }; |