mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-04 20:05:50 +00:00
562 lines
35 KiB
HTML
562 lines
35 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<meta name="viewport" content="width=device-width">
|
|
|
|
<title>rippled Setup - Ripple Developer Portal</title>
|
|
|
|
<!-- favicon -->
|
|
<link rel="icon" href="favicon.ico" type="image/x-icon">
|
|
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
|
|
|
|
<!-- jQuery -->
|
|
<script src="assets/vendor/jquery-1.11.1.min.js"></script>
|
|
|
|
<!-- Custom Stylesheets. ripple.css includes bootstrap, font stuff -->
|
|
<link href="assets/css/ripple.css" rel="stylesheet" />
|
|
<link href="assets/css/devportal.css" rel="stylesheet" />
|
|
|
|
<!-- Bootstrap JS -->
|
|
<script src="assets/vendor/bootstrap.min.js"></script>
|
|
|
|
|
|
<!-- syntax highlighting -->
|
|
<link rel="stylesheet" href="assets/vendor/docco.min.css" />
|
|
<script src="assets/vendor/highlight.min.js"></script>
|
|
|
|
<!-- syntax selection js -->
|
|
<script src="assets/js/multicodetab.js"></script>
|
|
<script>
|
|
$(document).ready(function() {
|
|
$(".multicode").minitabs();
|
|
hljs.initHighlighting();
|
|
make_code_expandable();
|
|
});
|
|
</script>
|
|
|
|
<script src="assets/js/expandcode.js"></script>
|
|
<script src="assets/js/fixsidebarscroll.js"></script>
|
|
|
|
<!-- fontawesome icons -->
|
|
<link rel="stylesheet" href="assets/vendor/fontawesome/css/font-awesome.min.css" />
|
|
|
|
</head>
|
|
|
|
<body class="page page-template page-template-template-dev-portal page-template-template-dev-portal-php sidebar-primary wpb-js-composer js-comp-ver-3.6.2 vc_responsive">
|
|
<header role="banner" class="banner navbar navbar-default navbar-fixed-top initial_header">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<a href="index.html" class="navbar-brand"><img src="assets/img/ripple-logo-color.png" class="logo"></a>
|
|
</div><!-- /.navbar-header -->
|
|
<div class="nav">
|
|
<div class="draft-warning">DRAFT PAGE</div>
|
|
</div><!-- /.nav -->
|
|
|
|
</div><!-- /.container -->
|
|
|
|
<div class="subnav dev_nav">
|
|
<div class="container">
|
|
<ul id="menu-dev-menu" class="menu">
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">References <span class="caret"></span></a>
|
|
<ul class="dropdown-menu" role="menu">
|
|
<li><a href="reference-rippleapi.html">RippleAPI</a></li>
|
|
<li><a href="reference-rippled.html">rippled</a></li>
|
|
<li><a href="reference-transaction-format.html">Transaction Format</a></li>
|
|
<li><a href="reference-ledger-format.html">Ledger Format</a></li>
|
|
<li><a href="reference-data-api.html">Ripple Data API v2</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorials <span class="caret"></span></a>
|
|
<ul class="dropdown-menu" role="menu">
|
|
<li><a href="tutorial-multisign.html">How to Multi-Sign</a></li>
|
|
<li><a href="concept-issuing-and-operational-addresses.html">Issuing and Operational Addresses</a></li>
|
|
<li><a href="tutorial-reliable-transaction-submission.html">Reliable Transaction Submission</a></li>
|
|
<li><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
|
|
<li><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
|
|
<li><a href="tutorial-gateway-guide.html">Gateway Guide</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">RCL Features <span class="caret"></span></a>
|
|
<ul class="dropdown-menu" role="menu">
|
|
<li><a href="concept-amendments.html">Amendments</a></li>
|
|
<li><a href="concept-fee-voting.html">Fee Voting</a></li>
|
|
<li><a href="concept-fees.html">Fees (Disambiguation)</a></li>
|
|
<li><a href="concept-freeze.html">Freeze</a></li>
|
|
<li><a href="concept-paths.html">Paths</a></li>
|
|
<li><a href="concept-reserves.html">Reserves</a></li>
|
|
<li><a href="concept-stand-alone-mode.html">Stand-Alone Mode</a></li>
|
|
<li><a href="concept-transaction-cost.html">Transaction Cost</a></li>
|
|
<li><a href="concept-transfer-fees.html">Transfer Fees</a></li>
|
|
<li><a href="concept-noripple.html">Understanding the NoRipple flag</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Tools <span class="caret"></span></a>
|
|
<ul class="dropdown-menu" role="menu">
|
|
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
|
|
<li><a href="data-api-v2-tool.html">Data API v2 Tool</a></li>
|
|
<li><a href="tool-jsonrpc.html">rippled JSON-RPC Tool</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <span class="caret"></span></a>
|
|
<ul class="dropdown-menu" role="menu">
|
|
<li><a href="https://forum.ripple.com/viewforum.php?f=2">Forums</a></li>
|
|
<li><a href="https://www.bountysource.com/teams/ripple/bounties">Bounties</a></li>
|
|
<li><a href="https://ripplelabs.atlassian.net/">Bug Tracking</a></li>
|
|
<li><a href="https://ripple.com/category/dev-blog/">Dev Blog</a></li>
|
|
<li><a href="https://ripple.com/press-releases/">Press Center</a></li>
|
|
<li><a href="https://ripple.com/brand-guidelines/">Brand Guidelines</a></li>
|
|
</ul>
|
|
<li><a href="https://github.com/ripple/ripple-dev-portal" title="GitHub">Site Source</a></li>
|
|
</ul><!-- /#dev-menu -->
|
|
</div><!-- /.subnav .container -->
|
|
</div><!-- /.subnav -->
|
|
</header>
|
|
|
|
|
|
<div class="wrap container" role="document">
|
|
<aside class="sidebar" role="complementary">
|
|
<div class="dev_nav_wrapper">
|
|
<div id="cont">
|
|
<h5>In this category:</h5>
|
|
<ul class="dev_nav_sidebar">
|
|
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
|
|
<li class="level-2"><a href="tutorial-multisign.html">How to Multi-Sign</a></li>
|
|
<li class="level-2"><a href="concept-issuing-and-operational-addresses.html">Issuing and Operational Addresses</a></li>
|
|
<li class="level-2"><a href="tutorial-reliable-transaction-submission.html">Reliable Transaction Submission</a></li>
|
|
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
|
|
<li class="level-2"><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
|
|
<li class="level-2"><a href="tutorial-gateway-guide.html">Gateway Guide</a></li>
|
|
</ul>
|
|
<hr />
|
|
<h5>In this page:</h5>
|
|
<ul class="dev_nav_sidebar" id="dactyl_toc_sidebar">
|
|
<li class="level-1"><a href="#operating-rippled-servers">Operating rippled Servers</a></li>
|
|
<li class="level-2"><a href="#types-of-rippled-servers">Types of rippled Servers</a></li>
|
|
<li class="level-2"><a href="#reasons-to-run-a-stock-server">Reasons to Run a Stock Server</a></li>
|
|
<li class="level-2"><a href="#reasons-to-run-a-validator">Reasons to Run a Validator</a></li>
|
|
<li class="level-3"><a href="#properties-of-a-good-validator">Properties of a Good Validator</a></li>
|
|
<li class="level-1"><a href="#installing-rippled">Installing rippled</a></li>
|
|
<li class="level-2"><a href="#system-requirements">System Requirements</a></li>
|
|
<li class="level-2"><a href="#installation-on-centosred-hat-with-yum">Installation on CentOS/Red Hat with yum</a></li>
|
|
<li class="level-2"><a href="#installation-on-ubuntu-with-alien">Installation on Ubuntu with alien</a></li>
|
|
<li class="level-2"><a href="#postinstall">Postinstall</a></li>
|
|
<li class="level-2"><a href="#updating-rippled">Updating rippled</a></li>
|
|
<li class="level-3"><a href="#automatic-update-on-centosred-hat">Automatic Update on CentOS/Red Hat</a></li>
|
|
<li class="level-3"><a href="#manual-update-on-centosred-hat">Manual Update on CentOS/Red Hat</a></li>
|
|
<li class="level-3"><a href="#manual-update-on-ubuntu">Manual Update on Ubuntu</a></li>
|
|
<li class="level-1"><a href="#running-a-validator">Running a Validator</a></li>
|
|
<li class="level-2"><a href="#validator-setup">Validator Setup</a></li>
|
|
<li class="level-2"><a href="#public-facing-server">Public-Facing Server</a></li>
|
|
<li class="level-2"><a href="#domain-verification">Domain Verification</a></li>
|
|
<li class="level-3"><a href="#rippletxt">ripple.txt </a></li>
|
|
<li class="level-3"><a href="#account-domain">Account domain</a></li>
|
|
<li class="level-1"><a href="#additional-configuration">Additional Configuration</a></li>
|
|
<li class="level-2"><a href="#parallel-networks">Parallel Networks</a></li>
|
|
<li class="level-3"><a href="#parallel-networks-and-consensus">Parallel Networks and Consensus</a></li>
|
|
<li class="level-2"><a href="#clustering">Clustering</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</aside>
|
|
<main class="main" role="main">
|
|
<div class='content'>
|
|
<h1 id="operating-rippled-servers">Operating rippled Servers</h1>
|
|
<p>The core server of the Ripple peer-to-peer network is <a href="reference-rippled.html"><code>rippled</code></a>. Anyone can run their own <code>rippled</code> server that follows the network and keeps a complete copy of the Ripple ledger. You can even have your server take part in the consensus process.</p>
|
|
<p>This page contains instructions for:</p>
|
|
<ul>
|
|
<li><a href="#installing-rippled">Installing <code>rippled</code></a></li>
|
|
<li><a href="#running-a-validator">Participating in the Consensus Process</a></li>
|
|
</ul>
|
|
<h2 id="types-of-rippled-servers">Types of rippled Servers</h2>
|
|
<p>The <code>rippled</code> server software can run in several modes depending on its configuration, including:</p>
|
|
<ul>
|
|
<li>Stock server - follows the network with a local copy of the ledger.</li>
|
|
<li>Validating server, or <em>validator</em> for short - participates in consensus.</li>
|
|
<li><code>rippled</code> server in stand-alone mode - for testing. Does not communicate to other <code>rippled</code> servers.</li>
|
|
</ul>
|
|
<p>You can also run the <code>rippled</code> executable as a client application for accessing <a href="reference-rippled.html"><code>rippled</code> APIs</a> locally. (Two instances of the same binary can run side-by-side in this case; one as a server, and the other running briefly as a client and then terminating.)</p>
|
|
<h2 id="reasons-to-run-a-stock-server">Reasons to Run a Stock Server</h2>
|
|
<p>There are lots of reasons you might want to run your own <code>rippled</code> server, but most of them can be summarized as: you can trust your own server, you have control over its workload, and you're not at the mercy of others to decide when and how you can access it. Of course, you must practice good network security to protect your server from malicious hackers.</p>
|
|
<p>You need to trust the <code>rippled</code> you use. If you connect to a malicious server, there are many ways that it can take advantage of you or cause you to lose money. For example:</p>
|
|
<ul>
|
|
<li>A malicious server could report that you were paid when no such payment was made.</li>
|
|
<li>It could selectively show or hide payment paths and currency exchange offers to guarantee its own profit while not providing you the best deal.</li>
|
|
<li>If you sent it your address's secret key, it could make arbitrary transactions on your behalf, and even transfer or destroy all the money your address holds.</li>
|
|
</ul>
|
|
<p>Additionally, running your own server gives you admin control over it, which allows you to run important admin-only and load-intensive commands. If you use a shared server, you have to worry about other users of the same server competing with you for the server's computing power. Many of the commands in the WebSocket API can put a lot of strain on the server, so <code>rippled</code> has the option to scale back its responses when it needs to. If you share a server with others, you may not always get the best results possible.</p>
|
|
<p>Finally, if you run a validating server, you can use a stock server as a proxy to the public network while keeping your validating server on a private subnet only accessible to the outside world through the stock server. This makes it more difficult to compromise the integrity of your validating server.</p>
|
|
<h2 id="reasons-to-run-a-validator">Reasons to Run a Validator</h2>
|
|
<p>The robustness of the Ripple network depends on an interconnected web of validators who each trust a few other validators <em>not to collude</em>. The more operators with different interests there are who run validators, the more certain each member of the network can be that it continues to run impartially. If you or your organization relies on the Ripple peer-to-peer network, it is in your interest to contribute to the consensus process.</p>
|
|
<p>Not all <code>rippled</code> servers need to be validators: trusting more servers from the same operator does not offer better protection against collusion. An organization might run validators in multiple regions for redundancy in case of natural disasters and other emergencies.</p>
|
|
<p>If your organization runs a validating server, you may also run one or more stock servers, to balance the computing load of API access, or as a proxy between your validation server and the outside network.</p>
|
|
<h3 id="properties-of-a-good-validator">Properties of a Good Validator</h3>
|
|
<p>There are several properties that define a good validator. The more of these properties your server embodies, the more reason others have to include your server in their list of trusted validators:</p>
|
|
<ul>
|
|
<li><strong>Availability</strong>. An ideal validator should always be running, submitting validation votes for every proposed ledger.<ul>
|
|
<li>Strive for 100% uptime.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Agreement</strong>. A validator's votes should match the outcome of the consensus process as often as possible. To do otherwise could indicate that the validator's software is outdated, buggy, or intentionally biased.<ul>
|
|
<li>Always run the latest <code>rippled</code> release without modifications.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Timeliness</strong>. A validator's votes should arrive quickly, and not after a consensus round has already finished.<ul>
|
|
<li>A fast internet connection helps with this.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Identified</strong>. It should be clear who runs the validator. Ideally, a list of trusted validators should include validators operated by different owners in multiple legal jurisdictions and geographic areas, to reduce the chance that any localized events could interfere with the validator's impartial operation.<ul>
|
|
<li>Setting up <a href="#domain-verification">Domain Verification</a> is a good start.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>At present, Ripple (the company) cannot recommend any validators aside from the 5 core validators run by Ripple (the company): these validators are included in the default <code>rippled</code> configuration. However, we are collecting data on other validators and building tools to report on their performance. For metrics on validators, see <a href="https://validators.ripple.com">validators.ripple.com</a>.</p>
|
|
<h1 id="installing-rippled">Installing rippled</h1>
|
|
<p>For development, you can <a href="https://wiki.ripple.com/Rippled_build_instructions">compile <code>rippled</code> from source</a>.</p>
|
|
<p>Production <code>rippled</code> instances can <a href="#installation-on-centosred-hat-with-yum">use Ripple's binary executable</a>, available from the Ripple <a href="https://en.wikipedia.org/wiki/Yellowdog_Updater,_Modified">yum</a> repository.</p>
|
|
<h2 id="system-requirements">System Requirements</h2>
|
|
<p>A <code>rippled</code> server should run comfortably on commodity hardware, to make it inexpensive to participate in the network. At present, we recommend the following:</p>
|
|
<ul>
|
|
<li>Operating System:<ul>
|
|
<li>Production: CentOS or RedHat Enterprise Linux (latest release) or Ubuntu (15.04+) supported</li>
|
|
<li>Development: Mac OS X, Windows (64-bit), or most Linux distributions</li>
|
|
</ul>
|
|
</li>
|
|
<li>CPU: 64-bit x86_64, 2+ cores</li>
|
|
<li>Disk: Minimum 50GB SSD recommended (500+ IOPS, more is better) for the database partition</li>
|
|
<li>RAM: 4+GB</li>
|
|
</ul>
|
|
<p>Amazon EC2's m3.large VM size may be appropriate depending on your workload. (Validating servers need more resources.)</p>
|
|
<p>Naturally, a fast network connection is preferable.</p>
|
|
<h2 id="installation-on-centosred-hat-with-yum">Installation on CentOS/Red Hat with yum</h2>
|
|
<p>This section assumes that you are using CentOS 7 or Red Hat Enterprise Linux 7.</p>
|
|
<ol>
|
|
<li>
|
|
<p>Install the Ripple rpm repository:</p>
|
|
<pre><code>$ sudo rpm -Uvh https://mirrors.ripple.com/ripple-repo-el7.rpm
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Install the <code>rippled</code> software package:</p>
|
|
<pre><code>$ sudo yum install --enablerepo=ripple-stable rippled
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Configure the <code>rippled</code> service to start on system boot:</p>
|
|
<pre><code>$ sudo systemctl enable rippled.service
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Start the <code>rippled</code> service</p>
|
|
<pre><code>$ sudo systemctl start rippled.service
|
|
</code></pre>
|
|
</li>
|
|
</ol>
|
|
<h2 id="installation-on-ubuntu-with-alien">Installation on Ubuntu with alien</h2>
|
|
<p>This section assumes that you are using Ubuntu 15.04 or later.</p>
|
|
<ol>
|
|
<li>
|
|
<p>Install yum-utils and alien:</p>
|
|
<pre><code>$ sudo apt-get update
|
|
$ sudo apt-get install yum-utils alien
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Install the Ripple rpm repository:</p>
|
|
<pre><code>$ sudo rpm -Uvh https://mirrors.ripple.com/ripple-repo-el7.rpm
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Download the <code>rippled</code> software package:</p>
|
|
<pre><code>$ yumdownloader --enablerepo=ripple-stable --releasever=el7 rippled
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Verify the signature on the <code>rippled</code> software package:</p>
|
|
<pre><code>$ sudo rpm --import https://mirrors.ripple.com/rpm/RPM-GPG-KEY-ripple-release && rpm -K rippled*.rpm
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Install the <code>rippled</code> software package:</p>
|
|
<pre><code>$ sudo alien -i --scripts rippled*.rpm && rm rippled*.rpm
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Configure the <code>rippled</code> service to start on system boot:</p>
|
|
<pre><code>$ sudo systemctl enable rippled.service
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Start the <code>rippled</code> service</p>
|
|
<pre><code>$ sudo systemctl start rippled.service
|
|
</code></pre>
|
|
</li>
|
|
</ol>
|
|
<h2 id="postinstall">Postinstall</h2>
|
|
<p>It can take several minutes for <code>rippled</code> to sync with the rest of the network, during which time it outputs warnings about missing ledgers. After that, you have a fully functional stock <code>rippled</code> server that you can use for local signing and API access to the Ripple peer-to-peer network.</p>
|
|
<p><a href="reference-rippled.html#list-of-public-commands">rippled commands</a> can be run with:</p>
|
|
<pre><code> $ /opt/ripple/bin/rippled <command>
|
|
</code></pre>
|
|
<h2 id="updating-rippled">Updating rippled</h2>
|
|
<p>You can subscribe to the <a href="https://groups.google.com/forum/#!forum/ripple-server">rippled Google Group</a> to receive notifications of new <code>rippled</code> releases.</p>
|
|
<h3 id="automatic-update-on-centosred-hat">Automatic Update on CentOS/Red Hat</h3>
|
|
<p>Automatic rippled updates can be enabled with a one-time Cron configuration:</p>
|
|
<ol>
|
|
<li>
|
|
<p>Check that <code>/opt/ripple/bin/update-rippled.sh</code> exists. If it does not, <a href="#manual-update-on-centosred-hat">update manually</a>.</p>
|
|
</li>
|
|
<li>
|
|
<p>Install <code>crond</code>:</p>
|
|
<pre><code>$ sudo yum install cronie
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Open the crontab file for editing</p>
|
|
<pre><code>$ sudo crontab -e
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Add the following to the crontab file. Be sure to add a blank line at the end of the file.</p>
|
|
<pre><code>RANDOM_DELAY=59
|
|
0 * * * * /opt/ripple/bin/update-rippled.sh
|
|
</code></pre>
|
|
</li>
|
|
</ol>
|
|
<p>The script updates the installed <code>rippled</code> package within an hour of each new release.</p>
|
|
<h3 id="manual-update-on-centosred-hat">Manual Update on CentOS/Red Hat</h3>
|
|
<p>Run the following commands to update to the latest release of <code>rippled</code>:</p>
|
|
<pre><code> $ sudo rpm -Uvh --replacepkgs https://mirrors.ripple.com/ripple-repo-el7.rpm
|
|
$ sudo yum update --enablerepo=ripple-stable rippled
|
|
$ sudo systemctl daemon-reload
|
|
$ sudo service rippled restart
|
|
</code></pre>
|
|
<h3 id="manual-update-on-ubuntu">Manual Update on Ubuntu</h3>
|
|
<p>Run the following commands to update to the latest release of <code>rippled</code>:</p>
|
|
<pre><code> $ sudo rpm -Uvh --replacepkgs https://mirrors.ripple.com/ripple-repo-el7.rpm
|
|
$ yumdownloader --enablerepo=ripple-stable --releasever=el7 rippled
|
|
$ rpm -K rippled*.rpm
|
|
$ sudo alien -i --scripts rippled*.rpm
|
|
$ sudo systemctl daemon-reload
|
|
$ sudo service rippled restart
|
|
</code></pre>
|
|
<h1 id="running-a-validator">Running a Validator</h1>
|
|
<p>Running a <code>rippled</code> validator that participates in the Consensus process is simple:</p>
|
|
<ol>
|
|
<li><a href="#validator-setup">Enable validation</a> on your <code>rippled</code> server.<ul>
|
|
<li>At first, your server is an <em>untrusted validator</em>. Others can see the validations your server issues, but they disregard them in the consensus process.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Share the public key with the public, especially other <code>rippled</code> operators.</li>
|
|
<li>When other <code>rippled</code> operators add your public key to their list of trusted servers, you have become a <em>trusted validator</em>.<ul>
|
|
<li>Also see <a href="#properties-of-a-good-validator">Properties of a Good Validator</a> for best practices.</li>
|
|
</ul>
|
|
</li>
|
|
</ol>
|
|
<h2 id="validator-setup">Validator Setup</h2>
|
|
<ol>
|
|
<li>
|
|
<p><a href="#installing-rippled">Install a <code>rippled</code> server.</a></p>
|
|
</li>
|
|
<li>
|
|
<p>Start <code>rippled</code>:</p>
|
|
<pre><code>$ sudo service rippled start
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Generate a validation public key and seed, and save the output to a secure place:</p>
|
|
<pre><code>$ /opt/ripple/bin/rippled -q validation_create
|
|
{
|
|
"status" : "success",
|
|
"validation_key" : "FOLD WERE CHOW WIT SWIM RANK WED DAN LAIN TRIO MURK NELL",
|
|
"validation_public_key" : "n9KHn8NfbBsZV5q8bLfS72XyGqwFt5mgoPbcTV4c6qKiuPTAtXYk",
|
|
"validation_seed" : "ssdecohJMDPFuUPDkmG1w4objZyp4"
|
|
}
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Add the generated validator signing key from above to your <code>rippled.cfg</code>:</p>
|
|
<pre><code>[validation_seed]
|
|
ssdecohJMDPFuUPDkmG1w4objZyp4
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Restart <code>rippled</code> validator:</p>
|
|
<pre><code>$ sudo service rippled restart
|
|
</code></pre>
|
|
</li>
|
|
</ol>
|
|
<h2 id="public-facing-server">Public-Facing Server</h2>
|
|
<p>To protect a production validator from <a href="https://en.wikipedia.org/wiki/Denial-of-service_attack">DDoS</a> attacks, you can use a stock <code>rippled</code> server as a proxy between the validator and the outside network.</p>
|
|
<ol>
|
|
<li>
|
|
<p><a href="#validator-setup">Set up the <code>rippled</code> validator.</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="#installing-rippled">Set up one or more stock <code>rippled</code> servers.</a></p>
|
|
</li>
|
|
<li>
|
|
<p>Configure the validator and stock <code>rippled</code> servers to be <a href="#clustering">clustered</a> with each other.</p>
|
|
</li>
|
|
<li>
|
|
<p>Make the following configuration changes to your validator:</p>
|
|
<ul>
|
|
<li>Copy the <code>[ips_fixed]</code> list and paste it under <code>[ips]</code>. These fields should contain only the IP addresses and ports of the public-facing rippled(s). The validator connects to only these peers.</li>
|
|
<li>Change <code>[peer_private]</code> to <code>1</code> to prevent its IP address from being forwarded.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p>Configure the validator host machine's firewall to only accept inbound connections from its public-facing rippled(s).</p>
|
|
</li>
|
|
</ol>
|
|
<p>Remember to restart <code>rippled</code> for config changes to take effect.</p>
|
|
<p>Take care not to publish the IP address of your validator.</p>
|
|
<h2 id="domain-verification">Domain Verification</h2>
|
|
<p>Network participants are unlikely to trust validators without knowing who is operating them. To address this concern, validator operators can associate their validator with a web domain that they control. <a href="#ripple-txt">Publishing a ripple.txt</a> and <a href="#account-domain">setting the validator's account domain</a> allows services like <a href="https://validators.ripple.com">validators.ripple.com</a> to detect the domain associated with the validator.</p>
|
|
<h3 id="rippletxt">ripple.txt <a name="ripple-txt"></a></h3>
|
|
<p>Publish a <a href="https://wiki.ripple.com/Ripple.txt">ripple.txt</a> page at your domain with a signed SSL certificate.</p>
|
|
<p>List the validator's <code>validation_public_key</code> (generated <a href="#validator-setup">above</a> in step 3) in the <code>[validation_public_key]</code> section.</p>
|
|
<h3 id="account-domain">Account domain</h3>
|
|
<p>A master seed can be used to generate both a validation public key and a Ripple account address. Since the same secret key is used for both, whoever operates the validator also controls the account with the corresponding address. (The validator's public key and the account address both represent the public key for the same keypair.)</p>
|
|
<p>The steps below describe how to set the domain field of a validator's Ripple account.</p>
|
|
<ol>
|
|
<li>
|
|
<p>Get the validator's account address (<code>account_id</code>) using the <code>validation_seed</code> generated <a href="#validator-setup">above</a> in step 3:</p>
|
|
<pre><code>$ /opt/ripple/bin/rippled -q wallet_propose <your-validation-seed>
|
|
{
|
|
"result" : {
|
|
"account_id" : "rU7bM9ENDkybaxNrefAVjdLTyNLuue1KaJ",
|
|
"key_type" : "secp256k1",
|
|
"master_key" : "FOLD WERE CHOW WIT SWIM RANK WED DAN LAIN TRIO MURK NELL",
|
|
"master_seed" : "ssdecohJMDPFuUPDkmG1w4objZyp4",
|
|
"master_seed_hex" : "434256443542C27BD1A84A2BACC9B8F0",
|
|
"public_key" : "aBQzwnRdgHVZmr8gLNugihTf5NsWAUpayGdAHtz8YPk1w3L4fh6S",
|
|
"public_key_hex" : "038ED9785EE7FC687445E0D94065A74FF6CEC6506A03C7380075D81A2B9E7E8681",
|
|
"status" : "success"
|
|
}
|
|
}
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Fund the account by sending it at least 25 XRP.</p>
|
|
<ul>
|
|
<li>See <a href="https://ripple.com/knowledge_center/how-to-get-xrp/">How to Get XRP</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p>Set the <a href="reference-transaction-format.html#domain"><code>Domain</code> field</a> of the account to match the domain hosting your ripple.txt</p>
|
|
<pre><code>$ /opt/ripple/bin/rippled -q submit <your-secret-key> '{"TransactionType": "AccountSet", "Account": "<your-account-id>", "Domain": "<your-hex-encoded-domain>", "Fee": "10000"}'
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Verify that your account's domain has been set.</p>
|
|
<pre><code>$ /opt/ripple/bin/rippled -q account_info <your-account-id>
|
|
</code></pre>
|
|
</li>
|
|
</ol>
|
|
<h1 id="additional-configuration">Additional Configuration</h1>
|
|
<p><code>rippled</code> should connect to the Ripple network with the default configuration. However, you can change your settings by editing the <code>rippled.cfg</code> file (located at <code>/opt/ripple/etc/rippled.cfg</code> when installing <code>rippled</code> with yum).</p>
|
|
<p>See <a href="https://github.com/ripple/rippled/blob/develop/doc/rippled-example.cfg">the <code>rippled</code> GitHub repository</a> for a description of all configuration options.</p>
|
|
<p>Changes to the <code>[debug_logfile]</code> or <code>[database_path]</code> sections may require you to give the <code>rippled</code> user and group ownership to your new configured path:</p>
|
|
<pre><code> $ chown -R rippled:rippled <configured path>
|
|
</code></pre>
|
|
<p>Restart <code>rippled</code> for any configuration changes to take effect:</p>
|
|
<pre><code> $ sudo service rippled restart
|
|
</code></pre>
|
|
<h2 id="parallel-networks">Parallel Networks</h2>
|
|
<p>Most of the time, we describe the Ripple peer-to-peer network as one collective, singular entity -- and that's mostly true. There is one production Ripple peer-to-peer network, and all business that takes place on Ripple occurs within the production network.</p>
|
|
<p>However, sometimes you may want to do tests and experiments without interacting with the core network. That's why Ripple started the <a href="https://ripple.com/build/ripple-test-net/">Ripple Test Net</a>, an "alternate universe" network, which can act as a testing ground for applications and the <code>rippled</code> server itself, without impacting the business operations of everyday Ripple users. The Ripple Test Net (also known as the AltNet) has a separate supply of TestNet-only XRP, which Ripple <a href="https://ripple.com/build/ripple-test-net/">gives away for free</a> to parties interested in developing applications on the Test Net.</p>
|
|
<p class="devportal-callout caution"><strong>Caution:</strong> Ripple makes no guarantees about the stability of the test network. It has been and continues to be used to test various properties of server configuration, network topology, and network performance.</p>
|
|
<p>Over time, there may also be smaller, temporary test networks for specific purposes.</p>
|
|
<h3 id="parallel-networks-and-consensus">Parallel Networks and Consensus</h3>
|
|
<p>There is no <code>rippled</code> setting that defines which network it uses. Instead, it uses the consensus of validators it trusts to know which ledger to accept as the truth. When different consensus groups of <code>rippled</code> instances only trust other members of the same group, each group continues as a parallel network. Even if malicious or misbehaving computers connect to both networks, the consensus process overrides the confusion as long as the members of each network are not configured to trust members of another network in excess of their quorum settings.</p>
|
|
<h2 id="clustering">Clustering</h2>
|
|
<p>If you are running multiple <code>rippled</code> servers in a single datacenter, you can configure those servers into a cluster to maximize efficiency. Running your <code>rippled</code> servers in a cluster provides the following benefits:</p>
|
|
<ul>
|
|
<li>Clustered <code>rippled</code> servers share the work of cryptography. If one server has verified the authenticity of a message, the other servers in the cluster trust it and do not re-verify.</li>
|
|
<li>Clustered servers share information about peers and API clients that are misbehaving or abusing the network. This makes it harder to attack all servers of the cluster at once.</li>
|
|
<li>Clustered servers always propagate transactions throughout the cluster, even if the transaction does not meet the current load-based transaction fee on some of them.</li>
|
|
</ul>
|
|
<p>To enable clustering, change the following sections of your <a href="https://github.com/ripple/rippled/blob/d7def5509d8338b1e46c0adf309b5912e5168af0/doc/rippled-example.cfg#L297-L346">config file</a> for each server:</p>
|
|
<ul>
|
|
<li>
|
|
<p>List the IP address and port of each other server under the <code>[ips_fixed]</code> section. The port should be the one from the other servers' <code>protocol = peer</code> setting in their <code>rippled.cfg</code>. Example:</p>
|
|
<pre><code>[ips_fixed]
|
|
192.168.0.1 51235
|
|
192.168.0.2 51235
|
|
</code></pre>
|
|
</li>
|
|
<li>
|
|
<p>Generate a unique seed (using the <a href="reference-rippled.html#validation-seed"><code>validation_create</code> command</a>) for each of your servers, and configure it under the <code>[node_seed]</code> section. The <code>rippled</code> server uses this key to sign its messages to other servers in the peer-to-peer network.</p>
|
|
<ul>
|
|
<li class="devportal-callout note"><strong>Note:</strong> This is a different key than the validation seed <code>rippled</code> uses to sign ledger proposals for consensus, in the same format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Add the public keys (for peer communication) of each of your other servers under the <code>[cluster_nodes]</code> section.</li>
|
|
</ul>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
|
|
<footer class="content-info" role="contentinfo">
|
|
<div class="container">
|
|
<div class="row">
|
|
|
|
<section class="col-sm-3 widget nav_menu-3 widget_nav_menu">
|
|
<h4>Resources<hr></h4>
|
|
<ul id="menu-resources" class="menu">
|
|
<li class="menu-insights"><a href="https://ripple.com/insights/">Insights</a></li>
|
|
<li class="menu-press-center"><a href="https://ripple.com/press-center/">Press Center</a></li>
|
|
<li class="menu-media-resources"><a href="https://ripple.com/media-resources/">Media Resources</a></li>
|
|
<li class="menu-videos"><a href="https://ripple.com/videos/">Videos</a></li>
|
|
<li class="menu-whitepapers-reports"><a href="https://ripple.com/whitepapers-reports/">Whitepapers & Reports</a></li>
|
|
<li class="menu-xrp-portal"><a href="https://ripple.com/xrp-portal/">XRP Portal</a></li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section class="col-sm-3 widget nav_menu-5 widget_nav_menu">
|
|
<h4>Regulators<hr></h4>
|
|
<ul id="menu-compliance-regulatory-relations" class="menu"><li class="menu-compliance"><a href="https://ripple.com/compliance/">Compliance</a></li>
|
|
<li class="menu-policy-framework"><a href="https://ripple.com/policy-framework/">Policy Framework</a></li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section class="col-sm-3 widget nav_menu-4 widget_nav_menu">
|
|
<h4>Support<hr></h4>
|
|
<ul id="menu-dev-footer-menu" class="menu">
|
|
<li class="menu-contact-us"><a href="https://ripple.com/contact/">Contact Us</a></li>
|
|
<li class="active menu-developer-center"><a href="https://ripple.com/build/">Developer Center</a></li>
|
|
<li class="menu-knowledge-center"><a href="https://ripple.com/learn/">Knowledge Center</a></li>
|
|
<li class="menu-ripple-forum"><a target="_blank" href="https://forum.ripple.com/">Ripple Forum</a></li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section class="col-sm-3 widget nav_menu-2 widget_nav_menu">
|
|
<h4>About<hr></h4>
|
|
<ul id="menu-company-footer" class="menu">
|
|
<li class="menu-our-company"><a href="https://ripple.com/company/">Our Company</a></li>
|
|
<li class="menu-careers"><a href="https://ripple.com/company/careers/">Careers</a></li>
|
|
</ul>
|
|
</section>
|
|
|
|
<div class="col-sm-12 absolute_bottom_footer">
|
|
<div class="col-sm-8">
|
|
<span>© 2013-2015 Ripple Labs, Inc. All Rights Reserved.</span>
|
|
<span><a href="https://ripple.com/terms-of-use/">Terms</a></span>
|
|
<span><a href="https://ripple.com/privacy-policy/">Privacy</a></span>
|
|
</div>
|
|
</div><!-- /.absolute_bottom_footer -->
|
|
|
|
</div><!-- /.row -->
|
|
</div><!-- /.container -->
|
|
</footer>
|
|
</body>
|
|
</html>
|