Correct example configuration file:

Trailing comments are not permitted in the crawl section
and can cause the lines containing them to be ignored.
This commit is contained in:
Elliot Lee
2019-02-26 13:18:09 -08:00
committed by Nik Bougalis
parent 8b97466285
commit 8023caaa97

View File

@@ -34,14 +34,13 @@
# #
# rippled.cfg # rippled.cfg
# #
# For more information on where the rippled server instance searches for # For more information on where the rippled server instance searches for the
# the file please visit the Ripple wiki. Specifically, the section explaining # file, visit:
# the --conf command line option:
# #
# https://ripple.com/wiki/Rippled#--conf.3Dpath # https://developers.ripple.com/commandline-usage.html#generic-options
# #
# This file should be named rippled.cfg. This file is UTF-8 with Dos, UNIX, # This file should be named rippled.cfg. This file is UTF-8 with DOS, UNIX,
# or Mac style end of lines. Blank lines and lines beginning with '#' are # or Mac style end of lines. Blank lines and lines beginning with '#' are
# ignored. Undefined sections are reserved. No escapes are currently defined. # ignored. Undefined sections are reserved. No escapes are currently defined.
# #
# Notation # Notation
@@ -49,8 +48,8 @@
# In this document a simple BNF notation is used. Angle brackets denote # In this document a simple BNF notation is used. Angle brackets denote
# required elements, square brackets denote optional elements, and single # required elements, square brackets denote optional elements, and single
# quotes indicate string literals. A vertical bar separating 1 or more # quotes indicate string literals. A vertical bar separating 1 or more
# elements is a logical "or"; Any one of the elements may be chosen. # elements is a logical "or"; any one of the elements may be chosen.
# Parenthesis are notational only, and used to group elements, they are not # Parentheses are notational only, and used to group elements; they are not
# part of the syntax unless they appear in quotes. White space may always # part of the syntax unless they appear in quotes. White space may always
# appear between elements, it has no effect on values. # appear between elements, it has no effect on values.
# #
@@ -126,13 +125,13 @@
# port = 80 # port = 80
# #
# [port_public] # [port_public]
# ip=0.0.0.0 # ip = 0.0.0.0
# port = 443 # port = 443
# protocol=peer,https # protocol = peer,https
# #
# [port_private] # [port_private]
# ip=127.0.0.1 # ip = 127.0.0.1
# protocol=http # protocol = http
# #
# When rippled is used as a command line client (for example, issuing a # 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
@@ -282,7 +281,7 @@
# keep rippled from connecting to other instances of rippled or # keep rippled from connecting to other instances of rippled or
# prevent RPC and WebSocket clients from connecting. # prevent RPC and WebSocket clients from connecting.
# #
# send_queue_limit = = [1..65535] # send_queue_limit = [1..65535]
# #
# A Websocket will disconnect when its send queue exceeds this limit. # A Websocket will disconnect when its send queue exceeds this limit.
# The default is 100. A larger value may help with erratic disconnects but # The default is 100. A larger value may help with erratic disconnects but
@@ -845,7 +844,7 @@
# #
# earliest_seq The default is 32570 to match the XRP ledger # earliest_seq The default is 32570 to match the XRP ledger
# network's earliest allowed sequence. Alternate # network's earliest allowed sequence. Alternate
# networks may set this value. Minimum value of 1. # networks may set this value. Minimum value of 1.
# #
# Notes: # Notes:
# The 'node_db' entry configures the primary, persistent storage. # The 'node_db' entry configures the primary, persistent storage.
@@ -1023,7 +1022,7 @@
# #
# 8. Misc Settings # 8. Misc Settings
# #
#---------- #-----------------
# #
# [signing_support] # [signing_support]
# #
@@ -1051,38 +1050,42 @@
# #
# <flag> # <flag>
# #
# Enable or disable access to /crawl requests. Default is '1' # Enable or disable access to /crawl requests. Default is '1' which
# enables access.
# #
# overlay = <flag> # overlay = <flag>
# #
# Report information about peers this server is connected to, similar # Report information about peers this server is connected to, similar
# to the "peers" RPC API. Default is '1'. # to the "peers" RPC API. Default is '1' which means to report peer
# overlay info.
# #
# server = <flag> # server = <flag>
# #
# Report information about the local server, similar to the "server_state" # Report information about the local server, similar to the "server_state"
# RPC API. Default is '1'. # RPC API. Default is '1' which means to report local server info.
# #
# counts = <flag> # counts = <flag>
# #
# Report information about the local server health counters, similar to # Report information about the local server health counters, similar to
# the "get_counts" RPC API. Default is '0'. # the "get_counts" RPC API. Default is '0' which means not to report
# server counts.
# #
# unl = <flag> # unl = <flag>
# #
# Report information about the local server's validator lists, similar to # Report information about the local server's validator lists, similar to
# the "validators" and "validator_list_sites" RPC APIs. Default is '1'. # the "validators" and "validator_list_sites" RPC APIs. Default is '1'
# which means to report server validator lists.
# #
# Example: # Examples:
# #
# [crawl] # [crawl]
# 0 # 0
# #
# [crawl] # [crawl]
# overlay = 1 # report peer overlay info # overlay = 1
# server = 1 # report local server info # server = 1
# counts = 0 # do not report server counts # counts = 0
# unl = 1 # report server validator lists # unl = 1
# #
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# #