Install on Ubuntu or Debian Linux
This page describes the recommended instructions for installing the latest stable version of rippled
on Ubuntu Linux 16.04 or higher or Debian 9 (Stretch), using the apt
utility.
These instructions install a binary that has been compiled by Ripple.
Prerequisites
Before you install rippled
, you must meet the System Requirements.
Installation Steps
-
Update repositories:
$ sudo apt -y update
-
Install utilities:
$ sudo apt -y install apt-transport-https ca-certificates wget gnupg
-
Add Ripple's package-signing GPG key to your list of trusted keys:
$ wget -q -O - "https://repos.ripple.com/repos/api/gpg/key/public" | \ sudo apt-key add -
-
Check the fingerprint of the newly-added key:
$ apt-key finger
The output should include an entry for Ripple such as the following:
pub rsa3072 2019-02-14 [SC] [expires: 2021-02-13] C001 0EC2 05B3 5A33 10DC 90DE 395F 97FF CCAF D9A2 uid [ unknown] TechOps Team at Ripple <techops+rippled@ripple.com> sub rsa3072 2019-02-14 [E] [expires: 2021-02-13]
In particular, make sure that the fingerprint matches. (In the above example, the fingerprint is on the second line, starting with
C001
.) -
Add the appropriate Ripple repository for your operating system version:
$ echo "deb https://repos.ripple.com/repos/rippled-deb bionic stable" | \ sudo tee -a /etc/apt/sources.list.d/ripple.list
The above example is appropriate for Ubuntu 18.04 Bionic Beaver. For other operating systems, replace the word
bionic
with one of the following:xenial
for Ubuntu 16.04 Xenial Xerusstretch
for Debian 9 Stretch
If you want access to development or pre-release versions of
rippled
, use one of the following instead ofstable
:unstable
- Pre-release builds (release
branch )nightly
- Experimental/development builds (develop
branch )
Warning: Unstable and nightly builds may be broken at any time. Do not use these builds for production servers.
-
Fetch the Ripple repository.
$ sudo apt -y update
-
Install the
rippled
software package:$ sudo apt -y install rippled
-
Check the status of the
rippled
service:$ systemctl status rippled.service
The
rippled
service should start automatically. If not, you can start it manually:$ sudo systemctl start rippled.service
To configure it to start automatically on boot:
$ sudo systemctl enable rippled.service
Next Steps
It can take several minutes for rippled
to sync with the rest of the network, during which time it outputs warnings about missing ledgers.
For information about rippled
log messages, see Understanding Log Messages.
After your rippled
has synchronized with the rest of the network, you have a fully functional stock rippled
server that you can use for local signing and API access to the XRP Ledger. Use rippled
server states to tell whether your rippled
server has synchronized with the network. You can use the rippled
commandline interface to test this quickly:
$ /opt/ripple/bin/rippled server_info
For more information about communicating with your rippled
server using the rippled APIs, see the rippled API reference.
Once you have your stock rippled
server running, you may want to consider running it as a validating server. For information about validating servers and why you might want to run one, see Run rippled as a Validator.
Having trouble getting your rippled
server started? See rippled Server Won't Start.
Additional Configuration
rippled
should connect to the XRP Ledger with the default configuration. However, you can change your settings by editing the rippled.cfg
file. For recommendations about configuration settings, see Capacity Planning.
The recommended installation uses the config file /etc/opt/ripple/rippled.cfg
by default. Other places you can put a config file include $HOME/.config/ripple/rippled.cfg
(where $HOME
is the home directory of the user running rippled
), $HOME/.local/ripple/rippled.cfg
, or the current working directory from where you start rippled
.
See the rippled
GitHub repository for a description of all configuration options.
You must restart rippled
for any configuration changes to take effect:
$ sudo systemctl restart rippled.service
If you change the [debug_logfile]
or [database_path]
sections, you may need to grant ownership of the new configured path to the user you run rippled
as.
Updates
You must update rippled
regularly to remain synced with the rest of the XRP Ledger network. You can subscribe to the rippled Google Group to receive notifications of new rippled
releases.
The rippled
package includes a script you can use to enable automatic updates on Linux. On other platforms, you must update manually.