mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 03:35:51 +00:00
Update install instructions per reviews
This commit is contained in:
mDuo13
@@ -10,7 +10,7 @@ This tutorial assumes your server meets the following prerequisites:
|
||||
|
||||
- The `rippled` server is already [installed](install-rippled.html) and [online deletion](online-deletion.html) is enabled.
|
||||
|
||||
The default configuration file enables online deletion after 2000 ledger versions.
|
||||
The default config file enables online deletion after 2000 ledger versions.
|
||||
|
||||
- A `cron` daemon is installed and running.
|
||||
|
||||
|
||||
@@ -82,7 +82,7 @@ For development purposes Ripple recommends running `rippled` as your own user, n
|
||||
|
||||
$ ./rippled --unittest
|
||||
|
||||
0. `rippled` requires the `rippled.cfg` configuration file to run. You can find an example config file, `rippled-example.cfg` in `rippled/cfg`. Make a copy and save it as `rippled.cfg` in a location that enables you to run `rippled` as a non-root user. Access the `rippled` directory and run:
|
||||
0. `rippled` requires the `rippled.cfg` config file to run. You can find an example config file, `rippled-example.cfg` in `rippled/cfg`. Make a copy and save it as `rippled.cfg` in a location that enables you to run `rippled` as a non-root user. Access the `rippled` directory and run:
|
||||
|
||||
$ mkdir -p $HOME/.config/ripple
|
||||
$ cp cfg/rippled-example.cfg $HOME/.config/ripple/rippled.cfg
|
||||
|
||||
@@ -8,7 +8,7 @@ This section describes configuration, network, and hardware recommendations that
|
||||
|
||||
Ripple recommends using these configuration guidelines to optimize resource utilization and performance of your `rippled` server.
|
||||
|
||||
You can set the following parameters in the `rippled.cfg` file used for your `rippled` server. You can access an example configuration file, `rippled-example.cfg`, in the [`cfg` directory](https://github.com/ripple/rippled/blob/develop/cfg/rippled-example.cfg) in the `rippled` GitHub repo.
|
||||
You can set the following parameters in the `rippled.cfg` file used for your `rippled` server. You can access an example config file, `rippled-example.cfg`, in the [`cfg` directory](https://github.com/ripple/rippled/blob/develop/cfg/rippled-example.cfg) in the `rippled` GitHub repo.
|
||||
|
||||
|
||||
### Node Size
|
||||
|
||||
@@ -32,7 +32,7 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
|
||||
|
||||
$ sudo yum install rippled
|
||||
|
||||
Version 1.3.0 does not require any changes to your configuration files (`rippled.cfg` and `validators.txt`). This update procedure leaves your existing config files in place.
|
||||
Version 1.3.0 does not require any changes to your config files (`rippled.cfg` and `validators.txt`). This update procedure leaves your existing config files in place.
|
||||
|
||||
4. Reload systemd unit files:
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# 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](https://help.ubuntu.com/lts/serverguide/apt.html) utility. [Updated in: rippled 1.3.0][New in: rippled 1.3.0]
|
||||
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`](https://help.ubuntu.com/lts/serverguide/apt.html) utility. [Updated in: rippled 1.3.0][New in: rippled 1.3.0]
|
||||
|
||||
These instructions install a binary that has been compiled by Ripple.
|
||||
|
||||
@@ -12,7 +12,7 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
|
||||
|
||||
## Installation Steps
|
||||
|
||||
1. Update apt repositories:
|
||||
1. Update repositories:
|
||||
|
||||
$ sudo apt -y update
|
||||
|
||||
@@ -31,12 +31,12 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
|
||||
|
||||
The output should include an entry for Ripple such as the following:
|
||||
|
||||
pub rsa3072 2019-02-14 [SC] [expires: 2012-02-13]
|
||||
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`.)
|
||||
In particular, make sure that the fingerprint matches. (In the above example, the fingerprint is on the second line, starting with `C001`.)
|
||||
|
||||
4. Add the appropriate Ripple repository for your operating system version:
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# rippled v1.3.0 Migration Instructions
|
||||
|
||||
This document describes the migration process for upgrading from `rippled` 1.2.4 or earlier to `rippled` v1.3.0 or later. This is necessary because the `rippled` install process has changed as of version 1.3.0.
|
||||
This document describes the migration process for upgrading from `rippled` 1.2.4 or earlier to `rippled` v1.3.0 or later. This migration process is necessary because the `rippled` install process has changed as of version 1.3.0.
|
||||
|
||||
This document provides migration steps for upgrading on supported platforms:
|
||||
|
||||
@@ -18,7 +18,11 @@ Ripple's official RPM repository and instructions for using it have changed. To
|
||||
|
||||
$ sudo systemctl stop rippled.service
|
||||
|
||||
2. Replace Ripple's old yum repo file with the new one:
|
||||
2. Remove the old Ripple repository package.
|
||||
|
||||
$ sudo rpm -e ripple-repo
|
||||
|
||||
3. Add Ripple's new yum repository:
|
||||
|
||||
$ cat << REPOFILE | sudo tee /etc/yum.repos.d/ripple.repo
|
||||
[ripple-stable]
|
||||
@@ -30,15 +34,11 @@ Ripple's official RPM repository and instructions for using it have changed. To
|
||||
repo_gpgcheck=1
|
||||
REPOFILE
|
||||
|
||||
3. Fetch the latest repo updates:
|
||||
|
||||
$ sudo yum -y update
|
||||
|
||||
4. Install the new `rippled` package:
|
||||
|
||||
$ sudo yum install rippled
|
||||
|
||||
Version 1.3.0 does not require any changes to your configuration files (`rippled.cfg` and `validators.txt`). This update procedure leaves your existing config files in place.
|
||||
Version 1.3.0 does not require any changes to your config files (`rippled.cfg` and `validators.txt`). This update procedure leaves your existing config files in place.
|
||||
|
||||
5. Reload systemd unit files:
|
||||
|
||||
|
||||
@@ -14,4 +14,4 @@ To set up automatic updates, complete the following steps:
|
||||
|
||||
$ sudo ln -s /opt/ripple/etc/update-rippled-cron /etc/cron.d/
|
||||
|
||||
This cron configuration runs a script to update installed `rippled` package within an hour of each new release. To reduce the chance of outages from all servers updating simultaneously, the script delays the update for a random number of minutes, up to 59.
|
||||
This cron configuration runs a script to update the installed `rippled` package within an hour of each new release. To reduce the chance of outages from all servers updating simultaneously, the script delays the update for a random number of minutes, up to 59.
|
||||
|
||||
@@ -8,7 +8,7 @@ This page describes how to update manually to the latest release of `rippled` on
|
||||
|
||||
To update manually, complete the following steps:
|
||||
|
||||
1. Update apt repositories:
|
||||
1. Update repositories:
|
||||
|
||||
$ sudo apt -y update
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ In a genesis ledger, the [genesis address](accounts.html#special-addresses) hold
|
||||
|
||||
In a new genesis ledger, the hard-coded default [Reserve](reserves.html) is **200 XRP** minimum for funding a new address, with an increment of **50 XRP** per object in the ledger. These values are higher than the current reserve requirements of the production network. (See also: [Fee Voting](fee-voting.html))
|
||||
|
||||
By default, a new genesis ledger has no [amendments](amendments.html) enabled. If you start a new genesis ledger with `--start`, the genesis ledger contains an [EnableAmendment pseudo-transaction](enableamendment.html) to turn on all amendments natively supported by the `rippled` server, except for amendments that you explicitly disable in the configuration file. The effects of those amendments are available starting from the very next ledger version. (Reminder: in stand-alone mode, you must [advance the ledger manually](advance-the-ledger-in-stand-alone-mode.html).) [New in: rippled 0.50.0][]
|
||||
By default, a new genesis ledger has no [amendments](amendments.html) enabled. If you start a new genesis ledger with `--start`, the genesis ledger contains an [EnableAmendment pseudo-transaction](enableamendment.html) to turn on all amendments natively supported by the `rippled` server, except for amendments that you explicitly disable in the config file. The effects of those amendments are available starting from the very next ledger version. (Reminder: in stand-alone mode, you must [advance the ledger manually](advance-the-ledger-in-stand-alone-mode.html).) [New in: rippled 0.50.0][]
|
||||
|
||||
<!--{# common link defs #}-->
|
||||
{% include '_snippets/rippled-api-links.md' %}
|
||||
|
||||
@@ -60,7 +60,7 @@ This generally indicates one of several problems:
|
||||
|
||||
## Check the server log
|
||||
|
||||
[By default,](https://github.com/ripple/rippled/blob/master/cfg/rippled-example.cfg#L1139-L1142) `rippled` writes the server's debug log to the file `/var/log/rippled/debug.log`. The location of the debug log can differ based on your server's configuration file. If you start the `rippled` service directly (instead of using `systemctl` or `service` to start it), it also prints log messages to the console by default.
|
||||
[By default,](https://github.com/ripple/rippled/blob/master/cfg/rippled-example.cfg#L1139-L1142) `rippled` writes the server's debug log to the file `/var/log/rippled/debug.log`. The location of the debug log can differ based on your server's config file. If you start the `rippled` service directly (instead of using `systemctl` or `service` to start it), it also prints log messages to the console by default.
|
||||
|
||||
The default config file sets the log level to severity "warning" for all categories of log messages by internally using the [log_level method][] during startup. You can control the verbosity of the debug log [using the `--silent` commandline option during startup](commandline-usage.html#verbosity-options) and with the [log_level method][] while the server is running. (See the `[rpc_startup]` stanza of the config file for settings.)
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ If your server is vulnerable to this problem, you can detect it two ways:
|
||||
|
||||
In both cases, detection of the problem requires access to `rippled`'s server logs.
|
||||
|
||||
**Tip:** The location of the debug log depends on your `rippled` server's configuration file. The [default configuration](https://github.com/ripple/rippled/blob/master/cfg/rippled-example.cfg#L1139-L1142) writes the server's debug log to the file `/var/log/rippled/debug.log`.
|
||||
**Tip:** The location of the debug log depends on your `rippled` server's config file. The [default configuration](https://github.com/ripple/rippled/blob/master/cfg/rippled-example.cfg#L1139-L1142) writes the server's debug log to the file `/var/log/rippled/debug.log`.
|
||||
|
||||
### Proactive Detection
|
||||
|
||||
|
||||
@@ -94,7 +94,7 @@ Terminating thread rippled: main: unhandled St13runtime_error 'Can not create "/
|
||||
Aborted (core dumped)
|
||||
```
|
||||
|
||||
The paths to the configuration file (`/home/rippled/.config/ripple/rippled.cfg`) and the database path (`/var/lib/rippled/db`) may vary depending on your system.
|
||||
The paths to the config file (`/home/rippled/.config/ripple/rippled.cfg`) and the database path (`/var/lib/rippled/db`) may vary depending on your system.
|
||||
|
||||
Possible solutions:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user