rippleci/rippled repository overview

Docker images for the XRP Ledger daemon rippled published by Ripple⁠

https://github.com/XRPLF/rippled⁠

⁠Running rippled Docker containers

The rippleci/rippled image ships the rippled binary with a bundled mainnet⁠ configuration. As of the upcoming 3.2.0 release The image is also available as rippleci/rippled for backward compatibility.

The current develop image and from release 3.2.0 and onward, the image, binary, config and associated paths will be renamed to xrpld, i.e. the rippleci/xrpld image will ship the xrpld binary with a bundled xrpld.cfg at /opt/xrpld/etc/xrpld.cfg.

⁠Available tags

• <VERSION_TAG> (e.g., 2.2.0⁠, 2.2.0-rc1) — build of that tagged release.
• develop — tracks the latest development branch. Not recommended for production use.
• <full_git_sha> (e.g., 2df635693d54b8c17c428faf6ef99da2f14a9382⁠) — build of that specific commit.
• <short_git_sha> (e.g., 2df63569) — 8-character abbreviated commit SHA.

⁠Quick start

Start a container connected to mainnet⁠ using the bundled configuration:

$ container=rippled
$ docker run --detach --rm --name $container rippleci/rippled

After a few minutes, check sync progress. A range of ledgers and server_state of full indicates the node is synced:

$ docker exec $container rippled --silent server_info | jq --raw-output '.result.info | "Version: \(.build_version)\nComplete ledgers: \(.complete_ledgers)\nServer state: \(.server_state)\nUptime: \(.uptime)"'
Version: 2.2.0
Complete ledgers: 87836008-87836503
Server state: full
Uptime: 1671

⁠Provide your own configuration

Mount a directory containing your rippled.cfg and validators.txt at /etc/opt/ripple:

$ container=rippled
$ config_dir=<your_config_directory>
$ docker run --detach --rm --name $container --volume "${config_dir}:/etc/opt/ripple" rippleci/rippled

To connect to the testnet or devnet⁠, provide a configuration file for the target network.

⁠Standalone mode

Start rippled in standalone mode⁠ by passing the --standalone flag:

$ container=rippled_standalone
$ docker run --detach --name $container rippleci/rippled --standalone
$ docker exec $container rippled --silent server_info | jq --raw-output '.result.info | "Version: \(.build_version)\nComplete ledgers: \(.complete_ledgers)\nServer state: \(.server_state)\nUptime: \(.uptime)"'
Version: 2.2.0
Complete ledgers: 2
Server state: full
Uptime: 10
# Advance the ledger
$ docker exec $container rippled --silent ledger_accept
{
   "result" : {
      "ledger_current_index" : 4,
      "status" : "success"
   }
}
$ docker exec $container rippled --silent server_info | jq --raw-output '.result.info | "Ledger: \(.complete_ledgers)"'
Ledger: 2-3