Label: Core Server
Pages about the XRP Ledger's core server implementation, rippled.
Concepts
-
Introduction
Software Ecosystem
Get an overview of what XRP Ledger software is out there and how it fits together.
-
XRP Ledger Servers
rippled Server Modes
Learn about rippled server modes, including stock servers, validator servers, and rippled servers run in stand-alone mode.
-
XRP Ledger Servers
Clustering
Run rippled servers in a cluster to share the load of cryptography between them.
-
XRP Ledger Servers
Ledger History
rippled servers store a variable amount of transaction and state history locally.
-
Ledger History
Online Deletion
Online deletion purges outdated transaction and state history.
-
Ledger History
History Sharding
History sharding divides the work of keeping historical ledger data among rippled servers.
-
XRP Ledger Servers
Peer Protocol
The peer protocol specifies the language rippled servers speak to each other.
Tutorials
-
Get Started
Public Servers
Use these public servers to access the XRP Ledger without needing your own infrastructure.
-
Install rippled
System Requirements
Hardware and software requirements for running rippled.
-
Install rippled
Install on CentOS/Red Hat with yum
Install a precompiled rippled binary on CentOS or Red Hat Enterprise Linux.
-
Install rippled
Install on Ubuntu or Debian Linux
Install a precompiled rippled binary on Ubuntu Linux.
-
Install rippled
Update Automatically on Linux
Set up automatic updates for rippled on Linux.
-
Install rippled
Update Manually on CentOS/Red Hat
Manually update rippled on CentOS or Red Hat Enterprise Linux.
-
Install rippled
Update Manually on Ubuntu or Debian
Manually update rippled on Ubuntu Linux.
-
Install rippled
Build and Run rippled on Ubuntu
Compile rippled yourself on Ubuntu Linux.
-
Install rippled
Build and Run rippled on macOS
Compile rippled yourself on macOS.
-
Install rippled
Build and Run rippled in Reporting Mode
Build and run a special operating mode of rippled that handles remote procedure calls (RPC) for validated data.
-
Install rippled
Capacity Planning
Plan system specs and tune configuration for rippled in production environments.
-
Configure rippled
Run rippled as a Validator
Have your server vote on the consensus ledger.
-
Configure rippled
Run rippled as a Stock Server
A multipurpose configuration for anyone integrating XRP.
-
Configure rippled
Configure Amendment Voting
Set your server's votes on protocol amendments.
-
Configure rippled
Configure StatsD
Monitor your rippled server with StatsD metrics.
-
Configure rippled
Connect Your rippled to a Parallel Network
Connect your rippled server to the test net to try out new features or test functionality with fake money.
-
Configure rippled
Configure Online Deletion
Configure how far back your server should store transaction history.
-
Configure rippled
Configure Advisory Deletion
Use advisory deletion to delete older ledger history on a schedule rather than as new history becomes available.
-
Configure rippled
Configure History Sharding
Set up a server to contribute to preserving shards of historical XRP Ledger data.
-
Configure rippled
Configure Full History
Full history servers provide a record of every transaction ever to occur in the XRP Ledger, although they are expensive to run.
-
Configure rippled
Configure gRPC
Enable and configure the gRPC API.
-
Configure rippled
Enable Public Signing
Allow others to use your server to sign transactions. (Not recommended)
-
Manage the rippled Server
Configure Peering
Configure how your server connects to the peer-to-peer network.
-
Configure Peering
Cluster rippled Servers
Set up a group of servers that share work for higher efficiency.
-
Configure Peering
Configure a Private Server
Set up a server to connect only to specific, trusted peers.
-
Configure Peering
Configure the Peer Crawler
Configure how much information your rippled server reports publicly about its status and peers.
-
Configure Peering
Enable Link Compression
Save bandwidth by compressing peer-to-peer communications.
-
Configure Peering
Forward Ports for Peering
Configure your firewall to allow incoming peers to your rippled server.
-
Configure Peering
Manually Connect to a Specific Peer
Connect your rippled server to a specific peer.
-
Configure Peering
Set Maximum Number of Peers
Set the maximum number of peers your rippled server connects to.
-
Configure Peering
Use a Peer Reservation
Set up a more reliable connection to a specific peer using a peer reservation.
-
Test rippled Functionality in Stand-Alone Mode
Start a New Genesis Ledger in Stand-Alone Mode
Start from a fresh genesis ledger in stand-alone mode.
-
Test rippled Functionality in Stand-Alone Mode
Load a Saved Ledger in Stand-Alone Mode
Start in stand-alone mode from a specific saved ledger to test or replay transactions.
-
Test rippled Functionality in Stand-Alone Mode
Advance the Ledger in Stand-Alone Mode
Make progress in stand-alone mode by manually closing the ledger.
-
Troubleshooting
Diagnosing Problems with rippled
Collect information to identify the cause of problems.
-
Troubleshooting
Health Check Interventions
Use the rippled server's health check as part of automated infrastructure monitoring.
-
Troubleshooting
Understanding Log Messages
Interpret and respond to warning and error messages in the debug log.
-
Troubleshooting
rippled Server Doesn't Sync
Troubleshoot problems that make a rippled server unable to sync with the rest of the XRP Ledger.
-
Troubleshooting
rippled Server is Amendment Blocked
Troubleshoot a server that can't implement amendment changes.
-
Troubleshooting
rippled Server Won't Start
A collection of problems that would cause a rippled server not to start, and how to fix them.
References
-
API Conventions
Rate Limiting
Information on how public APIs limit clients from making too many requests.
-
API Conventions
rippled Server States
Definitions of state information reported in some API methods.
-
HTTP / WebSocket APIs
Public API Methods
Get data from the XRP Ledger and submit transactions using these public API methods.
-
Server Info Methods
server_info (rippled)
Retrieve status of the server in human-readable format.
-
Server Info Methods
server_state
Retrieve status of the server in machine-readable format.
-
Clio Server Methods
server_info
Retrieve status of the Clio server in human-readable format.
-
Utility Methods
json
Pass JSON through the commandline.
-
Utility Methods
ping
Confirm connectivity with the server.
-
Utility Methods
random
Generate a random number.
-
HTTP / WebSocket APIs
Admin API Methods
Administer an XRP Ledger server with these API methods.
-
Key Generation Methods
validation_create
Generate keys for a rippled server to identify itself to the network.
-
Server Control Methods
ledger_accept
Close and advance the ledger in stand-alone mode.
-
Server Control Methods
stop
Shut down the rippled server.
-
Server Control Methods
validation_seed
(Obsolete) Temporarily set key to be used for validating.
-
Peer Management Methods
connect
Force the rippled server to connect to a specific peer.
-
Peer Management Methods
peer_reservations_add
Add a reserved slot for a specific peer server.
-
Peer Management Methods
peer_reservations_del
Remove a reserved slot for a specific peer server.
-
Peer Management Methods
peer_reservations_list
List reserved slots for specific peer servers.
-
Peer Management Methods
peers
Get information about the peer servers connected.
-
Status and Debugging Methods
consensus_info
Get information about the state of consensus as it happens.
-
Status and Debugging Methods
feature
Get information about protocol amendments.
-
Status and Debugging Methods
fetch_info
Get information about the server's sync with the network.
-
Status and Debugging Methods
get_counts
Get statistics about the server's internals and memory usage.
-
Status and Debugging Methods
print
Get information about internal subsystems.
-
Status and Debugging Methods
validator_list_sites
Get information about sites that publish validator lists.
-
Status and Debugging Methods
validators
Get information about the current validators.
-
HTTP / WebSocket APIs
rippled Commandline Usage Reference
Commandline usage options for the rippled server.
-
Peer Port Methods
Health Check
Special API method for reporting server health.
-
Peer Port Methods
Peer Crawler
Special API method for sharing network topology and status metrics.
-
Peer Port Methods
Validator List Method
Special API method for sharing recommended validator lists.