diff --git a/doc/rippled-example.cfg b/doc/rippled-example.cfg index 385a8af95f..0df531b158 100644 --- a/doc/rippled-example.cfg +++ b/doc/rippled-example.cfg @@ -133,7 +133,7 @@ # protocol=http # # When rippled is used as a command line client (for example, issuing a -# server stop command), the first port advertising the http or https +# server stop command), the first port advertising the http or https # protocol will be used to make the connection. # # @@ -149,7 +149,7 @@ # to. To bind to all available interfaces, uses 0.0.0.0 # # port = -# +v# # Required. Sets the port number to use for this port. # # protocol = [ http, https, peer ] @@ -163,7 +163,7 @@ # peer Peer Protocol # # Restrictions: -# +# # Only one port may be configured to support the peer protocol. # A port cannot have websocket and non websocket protocols at the # same time. It is possible have both Websockets and Secure Websockets @@ -256,7 +256,7 @@ # The amount of time to wait in seconds, before sending a websocket 'ping' # message. Ping messages are used to determine if the remote end of the # connection is no longer available. -# +# # # #------------------------------------------------------------------------------- @@ -556,7 +556,7 @@ # # 0. HTTPS client connections will not verify certificates. # 1. Certificates will be checked for HTTPS client connections. -# +# # If not specified, this parameter defaults to 1. # # @@ -590,50 +590,66 @@ # rippled creates 4 SQLite database to hold bookkeeping information # about transactions, local credentials, and various other things. # It also creates the NodeDB, which holds all the objects that -# make up the current and historical ledgers. The size of the NodeDB -# grows in proportion to the amount of new data and the amount of -# historical data (a configurable setting). +# make up the current and historical ledgers. # -# The performance of the underlying storage media where the NodeDB -# is placed can affect the performance of the server. Some virtual -# hosting providers offer high speed secondary storage, with the -# caveat that the data is not persisted across launches. If rippled -# runs in such an environment, it can be beneficial to configure the -# temp_db setting, which activates a secondary "look-aside" cache -# that can speed up the server. Some testing is suggested to determine -# if the temp_db setting is an improvement for your environment +# The size of the NodeDB grows in proportion to the amount of new data and the +# amount of historical data (a configurable setting) so the performance of the +# underlying storage media where the NodeDB is placed can significantly affect +# the performance of the server. # # Partial pathnames will be considered relative to the location of # the rippled.cfg file. # -# [node_db] Settings for the NodeDB (required) -# [temp_db] Settings for the look-aside temporary db (optional) -# [import_db] Settings for performing a one-time import (optional) +# [node_db] Settings for the Node Database (required) # # Format (without spaces): -# One or more lines of key / value pairs: +# One or more lines of case-insensitive key / value pairs: # '=' # ... # -# Examples: -# type=rocksdb -# path=db/rocksdb +# Example: +# type=nudb +# path=db/nudb +# +# The "type" field must be present and controls the choice of backend: +# +# type = NuDB +# +# NuDB is a high-performance database written by Ripple Labs and optimized +# for rippled and solid-state drives. +# +# NuDB maintains its high speed regardless of the amount of history +# stored. Online delete may be selected, but is not required. NuDB is +# available on all platforms that rippled runs on. +# +# type = RocksDB +# +# RocksDB is an open-source, general-purpose key/value store - see +# http://rocksdb.org/ for more details. +# +# RocksDB is an alternative backend for systems that don't use solid-state +# drives. Because RocksDB's performance degrades as it stores more data, +# keeping full history is not advised, and using online delete is +# recommended. RocksDB is not available on Windows. +# +# The RocksDB backend also provides these optional parameters: +# +# compression 0 for none, 1 for Snappy compression +# # -# Choices for 'type' (not case-sensitive) -# RocksDB Use Facebook's RocksDB database (preferred) -# NuDB Use Ripple Labs' NuDB (Windows preferred) -# SQLite (Deprecated) -# none (No backend) # # Required keys: # path Location to store the database (all types) # # Optional keys: -# compression 0 for none, 1 for Snappy compression +# +# These keys are possible for any type of backend: +# # online_delete Minimum value of 256. Enable automatic purging # of older ledger information. Maintain at least this # number of ledger records online. Must be greater # than or equal to ledger_history. +# # advisory_delete 0 for disabled, 1 for enabled. If set, then # require administrative RPC call "can_delete" # to enable online deletion of ledger records. @@ -641,23 +657,22 @@ # Notes: # The 'node_db' entry configures the primary, persistent storage. # -# The 'temp_db' configures a look-aside cache for high volume storage -# which doesn't necessarily persist between server launches. This -# is an optional configuration parameter. If it is left out then -# no look-aside database is created or used. -# # The 'import_db' is used with the '--import' command line option to # migrate the specified database into the current database given # in the [node_db] section. # +# [temp_db] Settings for the look-aside temporary db (optional) +# [import_db] Settings for performing a one-time import (optional) # [database_path] Path to the book-keeping databases. # -# There are 4 book-keeping SQLite database that the server creates and +# There are 4 bookkeeping SQLite database that the server creates and # maintains. If you omit this configuration setting, it will default to # creating a directory called "db" located in the same place as your # rippled.cfg file. Partial pathnames will be considered relative to # the location of the rippled executable. # +# The [temp_db] configuration setting is deprecated and should be avoided. +# # # #------------------------------------------------------------------------------- @@ -715,7 +730,7 @@ # server=statsd # address=192.168.0.95:4201 # prefix=my_validator -# +# #------------------------------------------------------------------------------- # # 7. Voting @@ -742,7 +757,7 @@ # # Example: # reference_fee = 10 # 10 drops -# +# # account_reserve = # # The account reserve requirement is specified in drops. The portion of an @@ -803,7 +818,7 @@ # "wss_public" # # Guest level API commands over Secure Websockets, open to everyone. -# +# # For HTTPS and Secure Websockets ports, if no certificate and key file # are specified then a self-signed certificate will be generated on startup. # If you have a certificate and key file, uncomment the corresponding lines @@ -885,8 +900,10 @@ pool.ntp.org [ips] r.ripple.com 51235 -# The latest validators can be obtained from -# https://ripple.com/ripple.txt +# Public keys of the validators that this rippled instance trusts. The latest +# list of validators can be obtained from https://ripple.com/ripple.txt +# +# See also https://wiki.ripple.com/Ripple.txt # [validators] n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7 RL1 @@ -895,7 +912,8 @@ n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C RL3 n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS RL4 n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA RL5 -# Ditto. +# The number of validators rippled needs to accept a consensus. +# Don't change this unless you know what you're doing. [validation_quorum] 3 @@ -904,7 +922,8 @@ n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA RL5 [rpc_startup] { "command": "log_level", "severity": "warning" } -# Defaults to 1 ("yes") so that certificates will be validated. To allow the use -# of self-signed certificates for development or internal use, set to 0 ("no"). -#[ssl_verify] -#0 +# If ssl_verify is 1, certificates will be validated. +# To allow the use of self-signed certificates for development or internal use, +# set to ssl_verify to 0. +[ssl_verify] +1