diff --git a/rippled-example.cfg b/rippled-example.cfg index 966fe0779..94164faab 100644 --- a/rippled-example.cfg +++ b/rippled-example.cfg @@ -3,34 +3,48 @@ # # This file contains configuration information for rippled. # -# 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 +# Rippled when launched attempts to find this file. For details, refer to the +# wiki page for --conf command line option: +# https://ripple.com/wiki/Rippled#--conf.3Dpath +# +# 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 # ignored. Undefined sections are reserved. No escapes are currently defined. # -# When you launch rippled, it will attempt to find this file. For details, -# refer to the manual page for --conf command line option. -# # [debug_logfile] -# Specifies were a debug logfile is kept. By default, no debug log is kept +# Specifies were a debug logfile is kept. By default, no debug log is kept. +# Unless absolute, the path is relative the directory from which rippled is +# launched. # # Example: debug.log # -# [validators_site]: -# Specifies where to find validators.txt for UNL boostrapping and RPC command unl_network. +# [validators]: +# List of nodes to always accept as validators. Nodes are specified by domain +# or public key. # -# Example: ripple.com +# For domains, rippled will probe for https web servers at the specified +# domain in the following order: ripple.DOMAIN, www.DOMAIN, DOMAIN +# +# For public key entries, a comment may optionally be spcified after adding a +# space to the pulic key. +# +# Examples: +# ripple.com +# n9KorY8QtTdRx7TVDpwnG9NvyxsDwHUKUEeDLY3AkiGncVaSXZi5 +# n9MqiExBcoG19UXwoLjBJnhsxEhAZMuWwJDRdkyDz1EkEkwzQTNt John Doe # # [validators_file]: -# Specifies how to bootstrap the UNL list. The UNL list is based on a -# validators.txt file and is maintained in the databases. When rippled -# starts up, if the databases are missing or are obsolete due to an upgrade -# of rippled, rippled will reconstruct the UNL list as specified here. +# Path to file contain a list of nodes to always accept as validators. Use +# this to specify a file other than this file to manage your validators list. # -# If this entry is not present or empty, rippled will look for a validators.txt in the -# config directory. If not found there, it will attempt to retrieve the file -# from the Ripple foundation's web site. +# If this entry is not present or empty and no nodes from previous runs were +# found in the database, rippled will look for a validators.txt in the config +# directory. If not found there, it will attempt to retrieve the file from +# the [validators_site] web site. # -# This entry is also used by the RPC command unl_load. +# After specifying a different [validators_file] or changing the contents of +# the validators file, issue a RPC unl_load command to have rippled load the +# file. # # Specify the file by specifying its full path. # @@ -38,24 +52,19 @@ # C:/home/johndoe/ripple/validators.txt # /home/johndoe/ripple/validators.txt # -# [validators]: -# Only valid in "rippled.cfg", "ripple.txt", and the referered [validators_url]. -# List of nodes to accept as validators speficied by public key or domain. +# [validators_site]: +# Specifies where to find validators.txt for UNL boostrapping and RPC +# unl_network command. # -# For domains, rippled will probe for https web servers at the specied -# domain in the following order: ripple.DOMAIN, www.DOMAIN, DOMAIN -# -# Examples: -# ripple.com -# n9KorY8QtTdRx7TVDpwnG9NvyxsDwHUKUEeDLY3AkiGncVaSXZi5 -# n9MqiExBcoG19UXwoLjBJnhsxEhAZMuWwJDRdkyDz1EkEkwzQTNt John Doe +# Example: ripple.com # # [ips]: -# Only valid in "rippled.cfg", "ripple.txt", and the referered [ips_url]. -# List of ips where the Ripple protocol is avialable. Domain names are not -# allowed. One ipv4 or ipv6 address per line. A port may optionally be -# specified after adding a space to the address. By convention, if known, -# IPs are listed in from most to least trusted. +# List of ips where the Ripple protocol is served. For a starter list, you +# can copy entries from: https://ripple.com/ripple.txt +# +# Domain names are not allowed. One ipv4 or ipv6 address per line. A port +# may optionally be specified after adding a space to the address. By +# convention, if known, IPs are listed in from most to least trusted. # # Examples: # 192.168.0.1 @@ -63,8 +72,14 @@ # 2001:0db8:0100:f101:0210:a4ff:fee3:9566 # # [sntp_servers] -# IP address or domain of servers to use for time synchronization. -# The default time servers are suitable for servers located in the United States +# IP address or domain of NTP servers to use for time synchronization. +# +# These NTP servers are suitable for rippled servers located in the United +# States: +# time.windows.com +# time.apple.com +# time.nist.gov +# pool.ntp.org # # [peer_ip]: # IP address or domain to bind to allow external connections from peers. @@ -77,7 +92,7 @@ # # [peer_private]: # 0 or 1. -# 0: allow peers to broadcast your address. [default] +# 0: request peers to broadcast your address. [default] # 1: request peers not broadcast your address. # # [rpc_ip]: @@ -91,18 +106,28 @@ # 0 or 1. # 0: only allows RPC connections from 127.0.0.1. [default] # +# [websocket_public_ip]: +# IP address or domain to bind to allow untrusted connections from clients. +# In the future, this option will go away and the peer_ip will accept +# websocket client connections. +# +# Examples: 0.0.0.0 - Bind on all interfaces. +# 127.0.0.1 - Bind on localhost interface. Only local programs may connect. +# +# [websocket_public_port]: +# Port to bind to allow untrusted connections from clients. In the future, +# this option will go away and the peer_ip will accept websocket client +# connections. +# # [websocket_ip]: -# IP address or domain to bind to allow client connections. +# IP address or domain to bind to allow trusted ADMIN connections from backend +# applications. # # Examples: 0.0.0.0 - Bind on all interfaces. # 127.0.0.1 - Bind on localhost interface. Only local programs may connect. # # [websocket_port]: -# Port to bind to allow client connections. -# -# [websocket_ssl]: -# 0 or 1. -# Enable websocket SSL. +# Port to bind to allow trusted ADMIN connections from backend applications. # # [websocket_ssl_key]: # Specify the filename holding the SSL key in PEM format. @@ -116,17 +141,18 @@ # The chain may include the end certificate. # # [validation_seed]: -# To perform validation, this section should contain either a validation seed or key. -# The validation seed is used to generate the validation public/private key pair. -# To obtain a validation seed, use the validation_create command. +# To perform validation, this section should contain either a validation seed +# or key. The validation seed is used to generate the validation +# public/private key pair. To obtain a validation seed, use the +# validation_create command. # # Examples: RASH BUSH MILK LOOK BAD BRIM AVID GAFF BAIT ROT POD LOVE # shfArahZT9Q9ckTf3s1psJ7C7qzVN # # [node_seed]: -# To force a particular node seed or key, the key can be set here. -# The format is the same as the validation_seed field. The need is used for clustering. -# Node seeds start with an 's'. +# To force a particular node seed or key, the key can be set here. The +# format is the same as the validation_seed field. The need is used for +# clustering. Node seeds start with an 's'. # # [cluster_nodes]: # To extend full trust to other nodes, place their node public keys here. @@ -134,22 +160,41 @@ # Node public keys start with an 'n'. # # [ledger_history]: -# To serve clients, servers need historical ledger data. This sets the number of -# past ledgers to acquire on server startup and the minimum to maintain while -# running. Servers that don't need to serve clients can set this to "none". -# Servers that want complete history can set this to "full". -# The default is 256 ledgers. +# The number of past ledgers to acquire on server startup and the minimum to +# maintain while running. +# +# To serve clients, servers need historical ledger data. Servers that don't +# need to serve clients can set this to "none". Servers that want complete +# history can set this to "full". +# +# The default is: 256 # # [database_path]: # Full path of database directory. # +# Allow other peers to connect to this server. [peer_ip] 0.0.0.0 [peer_port] 51235 +# Allow untrusted clients to connect to this server. +[websocket_public_ip] +0.0.0.0 + +[websocket_public_port] +5006 + +# Provide trusted websocket ADMIN access. +[websocket_ip] +127.0.0.1 + +[websocket_port] +6006 + +# Provide trusted json-rpc ADMIN access. [rpc_ip] 127.0.0.1 @@ -159,12 +204,6 @@ [rpc_allow_remote] 0 -[websocket_ip] -0.0.0.0 - -[websocket_port] -5006 - [debug_logfile] log/debug.log @@ -174,6 +213,7 @@ time.apple.com time.nist.gov pool.ntp.org +# Where to find some other servers speaking the Ripple protocol. [ips] 23.21.167.100 51235 23.23.201.55 51235 diff --git a/validators-example.txt b/validators-example.txt index cde2a6711..033ad8c48 100644 --- a/validators-example.txt +++ b/validators-example.txt @@ -2,7 +2,7 @@ # Default validators.txt # # A list of domains to bootstrap a nodes UNLs or for clients to indirectly -# locate IPs to contact the Newcoin network. +# locate IPs to contact the Ripple network. # # This file is UTF-8 with Dos, UNIX, or Mac style end of lines. # Blank lines and lines starting with a '#' are ignored. @@ -11,7 +11,7 @@ # [validators]: # List of nodes to accept as validators specified by public key or domain. # -# For domains, newcoind will probe for https web servers at the specified +# For domains, rippled will probe for https web servers at the specified # domain in the following order: ripple.DOMAIN, www.DOMAIN, DOMAIN # # Examples: redstem.com