From d36e5d5b7d8b3e1f1f13a26d61bf42c97ad19bc9 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 25 Jun 2019 16:42:30 -0700 Subject: [PATCH 01/19] Add rippled v1.3.0 release link --- content/_snippets/rippled_versions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/_snippets/rippled_versions.md b/content/_snippets/rippled_versions.md index 82f2cf4dd6..df33471f68 100644 --- a/content/_snippets/rippled_versions.md +++ b/content/_snippets/rippled_versions.md @@ -35,3 +35,4 @@ [New in: rippled 1.1.0]: https://github.com/ripple/rippled/releases/tag/1.1.0 "BADGE_BLUE" [New in: rippled 1.2.0]: https://github.com/ripple/rippled/releases/tag/1.2.0 "BADGE_BLUE" [New in: rippled 1.2.1]: https://github.com/ripple/rippled/releases/tag/1.2.1 "BADGE_BLUE" +[New in: rippled 1.3.0]: https://github.com/ripple/rippled/releases/tag/1.3.0 "BADGE_BLUE" From 852fcd13f598ed30a38eb4ef0e83359ecfab465f Mon Sep 17 00:00:00 2001 From: Alloy Networks <45832257+alloyxrp@users.noreply.github.com> Date: Thu, 27 Jun 2019 11:57:16 +0300 Subject: [PATCH 02/19] Update logrotate.md Starting with `rippled` 1.3, the `/etc/logrotate.d/rippled` script will be installed by the DEB and RPM packages. Modifications made to reflect that. --- .../logging-and-data-management-methods/logrotate.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md index 20e8259175..b8772c64c3 100644 --- a/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md +++ b/content/references/rippled-api/admin-rippled-methods/logging-and-data-management-methods/logrotate.md @@ -27,6 +27,8 @@ The following script is a sample that can be created as `/etc/logrotate.d/ripple You can configure parameters such as `minsize` and `rotate` depending on the amount of logs you keep. Use the `log_level` setting in your `rippled.cfg` file to configure how verbose your server's logs are. This sample script is based on standard `log_level` and will store approximately 2 weeks worth of logs in a compressed format. +Starting with `rippled` 1.3, the script `/etc/logrotate.d/rippled` will be automatically installed by the DEB and RPM packages. You can make modifications to this as required. Your modifications will not be overwritten on package upgrades. + **Note:** You should have only one system logrotate script per application. Please ensure that you do not have any other log rotation that handles the same directory. _The `logrotate` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._ From 317bb967ed259a708b7613ef8163557a853066a7 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 25 Jun 2019 15:23:03 -0700 Subject: [PATCH 03/19] Move Ubuntu install location --- ...-with-alien.md => install-rippled-on-ubuntu.md} | 0 dactyl-config.yml | 14 +++++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) rename content/tutorials/manage-the-rippled-server/installation/{install-rippled-on-ubuntu-with-alien.md => install-rippled-on-ubuntu.md} (100%) diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu-with-alien.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md similarity index 100% rename from content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu-with-alien.md rename to content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md diff --git a/dactyl-config.yml b/dactyl-config.yml index c85370b7cc..f19153f26c 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -1016,8 +1016,20 @@ pages: targets: - local - - md: tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu-with-alien.md + # Redirect old Alien-based install + - name: Install rippled on Ubuntu with Alien html: install-rippled-on-ubuntu-with-alien.html + template: template-redirect.html + redirect_url: install-rippled-on-ubuntu.html + funnel: Docs + doc_type: Tutorials + category: Manage the rippled Server + subcategory: Installation + targets: + - local + + - md: tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md + html: install-rippled-on-ubuntu.html funnel: Docs doc_type: Tutorials category: Manage the rippled Server From 2809632a5f422ecdb94491c1c658338d2ab04b23 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 25 Jun 2019 16:41:30 -0700 Subject: [PATCH 04/19] rippled 1.3.0 install instructions (DRAFT) --- content/_snippets/post-rippled-install.md | 4 +- .../installation/install-rippled-on-ubuntu.md | 54 +++++++++++++------ .../rippled-1-3-0-migration-instructions.md | 38 +++++++++++++ .../installation/system-requirements.md | 2 +- ...te-rippled-automatically-on-centos-rhel.md | 25 --------- .../update-rippled-automatically-on-linux.md | 15 ++++++ .../update-rippled-manually-on-centos-rhel.md | 2 + .../update-rippled-manually-on-ubuntu.md | 6 ++- dactyl-config.yml | 15 +++++- 9 files changed, 112 insertions(+), 49 deletions(-) create mode 100644 content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md delete mode 100644 content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-centos-rhel.md create mode 100644 content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md diff --git a/content/_snippets/post-rippled-install.md b/content/_snippets/post-rippled-install.md index 2f89ec7ffd..e227f11a2f 100644 --- a/content/_snippets/post-rippled-install.md +++ b/content/_snippets/post-rippled-install.md @@ -28,7 +28,7 @@ See [the `rippled` GitHub repository](https://github.com/ripple/rippled/blob/mas You must restart `rippled` for any configuration changes to take effect: -{% if currentpage.md == "tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu-with-alien.md" or +{% if currentpage.md == "tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md" or currentpage.md == "tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum" %} $ sudo systemctl restart rippled.service @@ -48,4 +48,4 @@ If you change the `[debug_logfile]` or `[database_path]` sections, you may need You must update `rippled` regularly to remain synced with the rest of the XRP Ledger network. You can subscribe to the [rippled Google Group](https://groups.google.com/forum/#!forum/ripple-server) to receive notifications of new `rippled` releases. -The `rippled` package for Red Hat Enterprise Linux and CentOS includes a script you can use to [enable automatic updates](update-rippled-automatically-on-centos-rhel.html) on those platforms. On other platforms, you must update manually. +The `rippled` package includes a script you can use to [enable automatic updates on Linux](update-rippled-automatically.html). On other platforms, you must update manually. diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md index 830c946b7b..5d9bbabb02 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md @@ -1,6 +1,6 @@ -# Install on Ubuntu with Alien +# 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**, using the [Alien](https://help.ubuntu.com/community/RPM/AlienHowto) utility to install from Ripple's [yum](https://en.wikipedia.org/wiki/Yellowdog_Updater,_Modified) repository. +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 v1.3.0][] These instructions install a binary that has been compiled by Ripple. @@ -12,34 +12,54 @@ Before you install `rippled`, you must meet the [System Requirements](system-req ## Installation Steps -1. Install yum-utils and alien: +1. Update apt repositories: - $ sudo apt-get update - $ sudo apt-get install yum-utils alien + $ sudo apt -y update -2. Install the Ripple RPM repository: +2. Install utilities: - $ sudo rpm -Uvh https://mirrors.ripple.com/ripple-repo-el7.rpm + $ sudo apt -y apt-transport-https ca-certificates wget gnupg -3. Download the `rippled` software package: +3. Add Ripple's package-signing GPG key to your list of trusted keys: - $ yumdownloader --enablerepo=ripple-stable --releasever=el7 rippled + $ wget -q -O - "https://repos.ripple.com/repos/api/gpg/key/public" | \ + sudo apt-key add - -4. Verify the signature on the `rippled` software package: + The key should match the following fingerprint: - $ sudo rpm --import https://mirrors.ripple.com/rpm/RPM-GPG-KEY-ripple-release && rpm -K rippled*.rpm + C001 0EC2 05B3 5A33 10DC 90DE 395F 97FF CCAF D9A2 -5. Install the `rippled` software package: +4. Add the appropriate Ripple repository for your operating system version: - $ sudo alien -i --scripts rippled*.rpm && rm rippled*.rpm + $ sudo echo "deb https://repos.ripple.com/repos/rippled-deb bionic stable" > \ + /etc/apt/sources.list.d/ripple.list -6. Configure the `rippled` service to start on system boot: + 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 Xerus** + - `stretch` for **Debian 9 Stretch** + +5. Fetch the Ripple repository. + + $ sudo apt -y update + +6. Install the `rippled` software package: + + $ sudo apt -y install rippled + +7. Check the status of the `rippled` service: + + $ systemctl status rippled.service + + ***TODO: confirm it starts automatically*** + 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 -7. Start the `rippled` service - - $ sudo systemctl start rippled.service ## Next Steps diff --git a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md new file mode 100644 index 0000000000..f9bd95936b --- /dev/null +++ b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md @@ -0,0 +1,38 @@ +# rippled v1.3.0 Migration Instructions + +The install and upgrade process on supported platforms has changed for `rippled` v1.3.0. If you have `rippled` v1.2.4 or lower installed, follow the instructions for upgrading on your platform: + +- [CentOS or Red Hat Enterprise Linux (RHEL)](#migration-on-centos-or-red-hat-enterprise-linux-rhel) +- [Ubuntu Linux](#migration-on-ubuntu-linux) + +For other platforms, see the updated instructions for compiling from source. + +# Migration on CentOS or Red Hat Enterprise Linux (RHEL) + +***TODO: instructions per https://github.com/ripple/ripple-dev-portal/issues/544*** + +Roughly: + +- stop rippled +- backup data & config +- uninstall package w/ `rpm -e` or `yum remove` +- install 1.3 the standard way +- stop rippled +- restore config & data files +- start rippled, check status + + +# Migration on Ubuntu Linux + +***TODO: instructions per https://github.com/ripple/ripple-dev-portal/issues/544*** + +Roughly: + +- stop rippled +- backup data & config +- uninstall package w/ alien +- install 1.3 the standard way (now w/ `apt`) +- stop rippled +- restore config & data files +- start rippled, check status +- optionally remove alien itself diff --git a/content/tutorials/manage-the-rippled-server/installation/system-requirements.md b/content/tutorials/manage-the-rippled-server/installation/system-requirements.md index 763aac2d33..7416c4fa67 100644 --- a/content/tutorials/manage-the-rippled-server/installation/system-requirements.md +++ b/content/tutorials/manage-the-rippled-server/installation/system-requirements.md @@ -5,7 +5,7 @@ A `rippled` server should run comfortably on commodity hardware, to make it inexpensive to participate in the network. At present, Ripple recommends the following minimum requirements: - Operating System: - - Production: CentOS or RedHat Enterprise Linux (latest release) or Ubuntu (16.04+) supported + - Production: CentOS or RedHat Enterprise Linux (latest release), Ubuntu (16.04+), or Debian (9.x) supported - Development: Mac OS X, Windows (64-bit), or most Linux distributions - CPU: 64-bit x86_64, 2+ cores - Disk: Minimum 50GB for the database partition. SSD strongly recommended (minimum 1000 IOPS, more is better) diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-centos-rhel.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-centos-rhel.md deleted file mode 100644 index 5bec9edc24..0000000000 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-centos-rhel.md +++ /dev/null @@ -1,25 +0,0 @@ -# Update Automatically on CentOS/Red Hat - -On CentOS and Red Hat Enterprise Linux, you can set up `rippled` to automatically upgrade to the latest version with a one-time `cron` configuration. Ripple recommends enabling automatic updates if possible. - -These instructions assume you have already [installed `rippled` from the `yum` repository](install-rippled-on-centos-rhel-with-yum.html). - -To set up automatic updates, complete the following steps: - -1. Check that `/opt/ripple/bin/update-rippled.sh` exists. If it does not, [update manually](update-rippled-manually-on-centos-rhel.html). - -2. Install `crond`: - - $ sudo yum install cronie - -3. Open the crontab file for editing - - $ sudo crontab -e - -4. Add the following to the crontab file. Be sure to add a blank line at the end of the file. - - RANDOM_DELAY=59 - 0 * * * * /opt/ripple/bin/update-rippled.sh - - -The script updates 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. diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md new file mode 100644 index 0000000000..4789ff8e8e --- /dev/null +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md @@ -0,0 +1,15 @@ +# Update Automatically on Linux + +On Linux, you can set up `rippled` to automatically upgrade to the latest version with a one-time `cron` configuration. Ripple recommends enabling automatic updates if possible. + +These instructions assume you have already installed `rippled` [from the `yum` repository (CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.html) or [using `apt`(Ubuntu/Debian)](install-rippled-on-ubuntu.html). + +**Warning:** The install and upgrade process for for `rippled` 1.3.0 has changed. If you have `rippled` v1.2.4 or lower installed, follow the [rippled 1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html) + +To set up automatic updates, complete the following steps: + +1. Check that `/opt/ripple/etc/update-rippled-cron` exists. If it does not, update manually ([CentOS/Red Hat](update-rippled-manually-on-centos-rhel.html) or [Ubuntu/Debian](update-rippled-manually-on-ubuntu.html)). + +2. Create a symlink in your `cron.d` folder + +The script updates 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. diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md index e9f6f5b172..065500b340 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md @@ -1,5 +1,7 @@ # Update Manually on CentOS/Red Hat +***TODO: update for 1.3.0*** + This page describes how to update manually to the latest release of `rippled` on CentOS or Red Hat Enterprise Linux. Ripple recommends setting up [automatic updates](update-rippled-automatically-on-centos-rhel.html) instead, where possible. These instructions assume you have already [installed `rippled` from the `yum` repository](install-rippled-on-centos-rhel-with-yum.html). diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md index cf12160fce..9383012667 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md @@ -1,5 +1,7 @@ # Update Manually on Ubuntu +***TODO: Update for 1.3.0*** + This page describes how to update manually to the latest release of `rippled` on Ubuntu Linux. These instructions assume you have already [installed `rippled` using Alien](install-rippled-on-ubuntu-with-alien.html). To update manually, complete the following steps: @@ -29,7 +31,7 @@ To update manually, complete the following steps: $ sudo service rippled restart 7. Delete the downloaded `rippled` package file: - + $ rm rippled*.rpm - + (This does not affect the installation, but prevents later updates from trying to re-install the old version.) diff --git a/dactyl-config.yml b/dactyl-config.yml index f19153f26c..f71bc87f74 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -1038,13 +1038,24 @@ pages: targets: - local - - md: tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-centos-rhel.md + - name: Update rippled Automatically on CentOS/RHEL html: update-rippled-automatically-on-centos-rhel.html + template: template-redirect.html + redirect_url: update-rippled-automatically-on-linux.html funnel: Docs doc_type: Tutorials category: Manage the rippled Server subcategory: Installation - blurb: Set up automatic updates for rippled on CentOS or Red Hat Enterprise Linux. + targets: + - local + + - md: tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md + html: update-rippled-automatically-on-linux.html + funnel: Docs + doc_type: Tutorials + category: Manage the rippled Server + subcategory: Installation + blurb: Set up automatic updates for rippled on Linux. targets: - local From 1d90706a62ea97c3f252a0200a857d94452559c3 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 27 Jun 2019 17:45:28 -0700 Subject: [PATCH 05/19] more 1.3.0 update/install/migration work --- .../installation/install-rippled-on-ubuntu.md | 25 +++++-- .../rippled-1-3-0-migration-instructions.md | 65 +++++++++++++++---- 2 files changed, 73 insertions(+), 17 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md index 5d9bbabb02..debbe1f030 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md @@ -25,20 +25,36 @@ Before you install `rippled`, you must meet the [System Requirements](system-req $ wget -q -O - "https://repos.ripple.com/repos/api/gpg/key/public" | \ sudo apt-key add - - The key should match the following fingerprint: +4. Check the fingerprint of the newly-added key: - C001 0EC2 05B3 5A33 10DC 90DE 395F 97FF CCAF D9A2 + $ apt-key finger + + The output should include an entry for Ripple such as the following: + + pub rsa3072 2019-02-14 [SC] [expires: 2012-02-13] + C001 0EC2 05B3 5A33 10DC 90DE 395F 97FF CCAF D9A2 + uid [ unknown] TechOps Team at Ripple + 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`.) 4. Add the appropriate Ripple repository for your operating system version: - $ sudo echo "deb https://repos.ripple.com/repos/rippled-deb bionic stable" > \ - /etc/apt/sources.list.d/ripple.list + $ 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 Xerus** - `stretch` for **Debian 9 Stretch** + If you want access to development or pre-release versions of `rippled`, use one of the following instead of `stable`: + + - `unstable` - Pre-release builds ([`release` branch](https://github.com/ripple/rippled/tree/release)) + - `nightly` - Experimental/development builds ([`develop` branch](https://github.com/ripple/rippled/tree/develop)) + + **Warning:** Unstable and nightly builds may be broken at any time. Do not use these builds for production servers. + 5. Fetch the Ripple repository. $ sudo apt -y update @@ -51,7 +67,6 @@ Before you install `rippled`, you must meet the [System Requirements](system-req $ systemctl status rippled.service - ***TODO: confirm it starts automatically*** The `rippled` service should start automatically. If not, you can start it manually: $ sudo systemctl start rippled.service diff --git a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md index f9bd95936b..aaac0de04d 100644 --- a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md +++ b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md @@ -1,14 +1,49 @@ # rippled v1.3.0 Migration Instructions -The install and upgrade process on supported platforms has changed for `rippled` v1.3.0. If you have `rippled` v1.2.4 or lower installed, follow the instructions for upgrading on your platform: +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 provides migration steps for upgrading on supported platforms: - [CentOS or Red Hat Enterprise Linux (RHEL)](#migration-on-centos-or-red-hat-enterprise-linux-rhel) - [Ubuntu Linux](#migration-on-ubuntu-linux) -For other platforms, see the updated instructions for compiling from source. +For other platforms, see the updated instructions for compiling from source. ([Ubuntu](build-run-rippled-ubuntu.html), [macOS](build-run-rippled-macos.html), or [Windows](https://github.com/ripple/rippled/tree/develop/Builds/VisualStudio2017)) # Migration on CentOS or Red Hat Enterprise Linux (RHEL) +***TODO: Test. Might be same as manual install steps*** + +Ripple's official RPM repository and instructions for using it have changed. To migrate from the old repository to the new one, complete the following steps: + +1. Stop the `rippled` server. + + $ sudo systemctl stop rippled.service + +2. Back up your configuration files. + + Copy your configuration files to a temporary directory. For example: + + $ mkdir ~/rippled_config_backup + $ cp /opt/ripple/etc/rippled.cfg ~/rippled_config_backup + $ cp /opt/ripple/etc/validators.txt ~/rippled_config_backup + + You may need to adjust the paths to the `rippled.cfg` and `validators.txt` files to match your configuration. + +3. Back up your data files. + + Copy your rippled server's database files to a temporary directory. For example: + + $ mkdir ~/rippled_data_backup + $ cp -r /var/lib/rippled/db/ ~/rippled_data_backup + + You may need to adjust the path to your database files to match your configuration. You should be sure to copy all database files, including SQLite databases (`.sqlite` and `.db` files), NuDB or RocksDB files for the [ledger store](ledger-history.html), and the [shard store](history-sharding.html) if you have history sharding enabled. + + This process may take a long time, depending on how much data you have stored. + + **Caution:** You can choose to skip this step if you do not need the ledger history data. Your server can download the necessary amount of ledger data from the peer-to-peer network after it comes back online. Validators and simple stock servers do not need large amounts of historical data to keep up with the progress of the XRP Ledger. + +4. Update the + ***TODO: instructions per https://github.com/ripple/ripple-dev-portal/issues/544*** Roughly: @@ -24,15 +59,21 @@ Roughly: # Migration on Ubuntu Linux -***TODO: instructions per https://github.com/ripple/ripple-dev-portal/issues/544*** +Prior to version 1.3.0, the supported way to install `rippled` on Ubuntu Linux was using Alien to install the RPM package. Starting with `rippled` v1.3.0, Ripple provides a native package for Ubuntu and Debian Linux, which is the recommended way of installing it. If you already have the RPM package installed, complete the [installation steps](install-rippled-on-ubuntu.html) to upgrade the package and switch over to the native APT (`.deb`) package. -Roughly: +If you have made any changes to your config files (`/opt/ripple/etc/rippled.cfg` and `/opt/ripple/etc/validators.txt`), `apt` may prompt you during installation asking if you want to overwrite your config files with the newest versions from the packages. Version 1.3.0 does not require any changes to the config file, so you can safely keep your existing config files unchanged. -- stop rippled -- backup data & config -- uninstall package w/ alien -- install 1.3 the standard way (now w/ `apt`) -- stop rippled -- restore config & data files -- start rippled, check status -- optionally remove alien itself +After installing the new package, if you no longer need Alien for any other packages, you may optionally uninstall it and its dependencies using the following steps: + +1. Uninstall Alien: + + $ sudo apt -y remove alien + +2. Uninstall unused dependencies: + + $ sudo apt -y autoremove + + +## Automatic Updates + +The `rippled` v1.3.0 package includes an updated auto-update script that works on Ubuntu and Debian Linux. For more information, see [Update `rippled` Automatically on Linux](update-rippled-automatically-on-linux.html). From c56a8e186902f4f8ba536fb3deab500d29dcf078 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 1 Jul 2019 16:43:21 -0700 Subject: [PATCH 06/19] v1.3.0 install/upgrade (draft done?) --- ...install-rippled-on-centos-rhel-with-yum.md | 33 ++++++++--- .../rippled-1-3-0-migration-instructions.md | 55 +++++++++---------- .../update-rippled-automatically-on-linux.md | 10 ++-- .../update-rippled-manually-on-centos-rhel.md | 16 ++---- .../update-rippled-manually-on-ubuntu.md | 34 ++++-------- 5 files changed, 73 insertions(+), 75 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md index 94d349157e..a139026d74 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md @@ -14,17 +14,35 @@ Before you install `rippled`, you must meet the [System Requirements](system-req 1. Install the Ripple RPM repository: - $ sudo rpm -Uvh https://mirrors.ripple.com/ripple-repo-el7.rpm + $ cat << REPOFILE | sudo tee /etc/yum.repos.d/ripple.repo + [ripple-stable] + name=XRP Ledger Packages + baseurl=https://repos.ripple.com/repos/rippled-rpm/stable/ + enabled=1 + gpgcheck=0 + gpgkey=https://repos.ripple.com/repos/rippled-rpm/stable/repodata/repomd.xml.key + repo_gpgcheck=1 + REPOFILE -2. Install the `rippled` software package: +2. Fetch the latest repo updates: - $ sudo yum install --enablerepo=ripple-stable rippled + $ sudo yum -y update -3. Configure the `rippled` service to start on system boot: +3. 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. + +4. Reload systemd unit files: + + $ sudo systemctl daemon-reload + +5. Configure the `rippled` service to start on boot: $ sudo systemctl enable rippled.service -4. Start the `rippled` service +6. Start the `rippled` service: $ sudo systemctl start rippled.service @@ -35,7 +53,8 @@ Before you install `rippled`, you must meet the [System Requirements](system-req ## See Also -- [Update Automatically on CentOS/Red Hat](update-rippled-automatically-on-centos-rhel.html) -- [Install rippled on Ubuntu Linux](install-rippled-on-ubuntu-with-alien.html) (Pre-built binary on Ubuntu) +- [Update Automatically on Linux](update-rippled-automatically-on-linux.html) +- [Install rippled on Ubuntu Linux](install-rippled-on-ubuntu.html) (Pre-built binary for Ubuntu or Debian) - [Build and Run `rippled` on Ubuntu](build-run-rippled-ubuntu.html) (Compile `rippled` yourself on Ubuntu) +- [Build and Run `rippled` on macOS](build-run-rippled-macos.html) (Compile `rippled` yourself on macOS) - [Compilation instructions for other platforms](https://github.com/ripple/rippled/tree/develop/Builds) diff --git a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md index aaac0de04d..ed4d95b75c 100644 --- a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md +++ b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md @@ -9,9 +9,8 @@ This document provides migration steps for upgrading on supported platforms: For other platforms, see the updated instructions for compiling from source. ([Ubuntu](build-run-rippled-ubuntu.html), [macOS](build-run-rippled-macos.html), or [Windows](https://github.com/ripple/rippled/tree/develop/Builds/VisualStudio2017)) -# Migration on CentOS or Red Hat Enterprise Linux (RHEL) -***TODO: Test. Might be same as manual install steps*** +## Migration on CentOS or Red Hat Enterprise Linux (RHEL) Ripple's official RPM repository and instructions for using it have changed. To migrate from the old repository to the new one, complete the following steps: @@ -19,45 +18,41 @@ Ripple's official RPM repository and instructions for using it have changed. To $ sudo systemctl stop rippled.service -2. Back up your configuration files. +2. Replace Ripple's old yum repo file with the new one: - Copy your configuration files to a temporary directory. For example: + $ cat << REPOFILE | sudo tee /etc/yum.repos.d/ripple.repo + [ripple-stable] + name=XRP Ledger Packages + baseurl=https://repos.ripple.com/repos/rippled-rpm/stable/ + enabled=1 + gpgcheck=0 + gpgkey=https://repos.ripple.com/repos/rippled-rpm/stable/repodata/repomd.xml.key + repo_gpgcheck=1 + REPOFILE - $ mkdir ~/rippled_config_backup - $ cp /opt/ripple/etc/rippled.cfg ~/rippled_config_backup - $ cp /opt/ripple/etc/validators.txt ~/rippled_config_backup +3. Fetch the latest repo updates: - You may need to adjust the paths to the `rippled.cfg` and `validators.txt` files to match your configuration. + $ sudo yum -y update -3. Back up your data files. +4. Install the new `rippled` package: - Copy your rippled server's database files to a temporary directory. For example: + $ sudo yum install rippled - $ mkdir ~/rippled_data_backup - $ cp -r /var/lib/rippled/db/ ~/rippled_data_backup + 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. - You may need to adjust the path to your database files to match your configuration. You should be sure to copy all database files, including SQLite databases (`.sqlite` and `.db` files), NuDB or RocksDB files for the [ledger store](ledger-history.html), and the [shard store](history-sharding.html) if you have history sharding enabled. +5. Reload systemd unit files: - This process may take a long time, depending on how much data you have stored. + $ sudo systemctl daemon-reload - **Caution:** You can choose to skip this step if you do not need the ledger history data. Your server can download the necessary amount of ledger data from the peer-to-peer network after it comes back online. Validators and simple stock servers do not need large amounts of historical data to keep up with the progress of the XRP Ledger. +6. Start the `rippled` service: -4. Update the - -***TODO: instructions per https://github.com/ripple/ripple-dev-portal/issues/544*** - -Roughly: - -- stop rippled -- backup data & config -- uninstall package w/ `rpm -e` or `yum remove` -- install 1.3 the standard way -- stop rippled -- restore config & data files -- start rippled, check status + $ sudo systemctl start rippled.service -# Migration on Ubuntu Linux +**Tip:** If you had [automatic updates](update-rippled-automatically-on-linux.html) enabled before 1.3.0, they should continue working after performing this migration process. + + +## Migration on Ubuntu Linux Prior to version 1.3.0, the supported way to install `rippled` on Ubuntu Linux was using Alien to install the RPM package. Starting with `rippled` v1.3.0, Ripple provides a native package for Ubuntu and Debian Linux, which is the recommended way of installing it. If you already have the RPM package installed, complete the [installation steps](install-rippled-on-ubuntu.html) to upgrade the package and switch over to the native APT (`.deb`) package. @@ -74,6 +69,6 @@ After installing the new package, if you no longer need Alien for any other pack $ sudo apt -y autoremove -## Automatic Updates +### Automatic Updates The `rippled` v1.3.0 package includes an updated auto-update script that works on Ubuntu and Debian Linux. For more information, see [Update `rippled` Automatically on Linux](update-rippled-automatically-on-linux.html). diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md index 4789ff8e8e..5a2eb0aa47 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md @@ -2,14 +2,16 @@ On Linux, you can set up `rippled` to automatically upgrade to the latest version with a one-time `cron` configuration. Ripple recommends enabling automatic updates if possible. -These instructions assume you have already installed `rippled` [from the `yum` repository (CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.html) or [using `apt`(Ubuntu/Debian)](install-rippled-on-ubuntu.html). +These instructions assume you have already installed `rippled` [from the `yum` repository (CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.html) or [using `apt` (Ubuntu/Debian)](install-rippled-on-ubuntu.html). -**Warning:** The install and upgrade process for for `rippled` 1.3.0 has changed. If you have `rippled` v1.2.4 or lower installed, follow the [rippled 1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html) +**Warning:** As of version 1.3.0, the install and upgrade process has changed. Automatic updates **will not** upgrade to `rippled` 1.3.0. If you have `rippled` v1.2.4 or lower installed, follow the [rippled 1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html) first. After performing the migration, automatic updates should work again. To set up automatic updates, complete the following steps: 1. Check that `/opt/ripple/etc/update-rippled-cron` exists. If it does not, update manually ([CentOS/Red Hat](update-rippled-manually-on-centos-rhel.html) or [Ubuntu/Debian](update-rippled-manually-on-ubuntu.html)). -2. Create a symlink in your `cron.d` folder +2. Create a symlink in your `cron.d` folder to the `/opt/ripple/etc/update-rippled-cron` config file: -The script updates 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. + $ 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. diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md index 065500b340..211cac8a98 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md @@ -1,25 +1,19 @@ # Update Manually on CentOS/Red Hat -***TODO: update for 1.3.0*** - -This page describes how to update manually to the latest release of `rippled` on CentOS or Red Hat Enterprise Linux. Ripple recommends setting up [automatic updates](update-rippled-automatically-on-centos-rhel.html) instead, where possible. +This page describes how to update manually to the latest release of `rippled` on CentOS or Red Hat Enterprise Linux. Ripple recommends setting up [automatic updates](update-rippled-automatically-on-linux.html) instead, where possible. These instructions assume you have already [installed `rippled` from the `yum` repository](install-rippled-on-centos-rhel-with-yum.html). To update manually, complete the following steps: -1. Update the package list from Ripple's yum repository: +1. Download and install the latest `rippled` package: - $ sudo rpm -Uvh --replacepkgs https://mirrors.ripple.com/ripple-repo-el7.rpm + $ sudo yum update rippled -2. Download and install the latest `rippled` package: - - $ sudo yum update --enablerepo=ripple-stable rippled - -3. Reload the `systemd` unit files: +2. Reload the `systemd` unit files: $ sudo systemctl daemon-reload -4. Restart the `rippled` service: +3. Restart the `rippled` service: $ sudo service rippled restart diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md index 9383012667..02a0c27397 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md @@ -1,37 +1,25 @@ -# Update Manually on Ubuntu +# Update Manually on Ubuntu or Debian -***TODO: Update for 1.3.0*** +This page describes how to update manually to the latest release of `rippled` on Ubuntu Linux. These instructions assume you have already [installed `rippled` using the native package](install-rippled-on-ubuntu.html). Ripple recommends setting up [automatic updates](update-rippled-automatically-on-linux.html) instead, where possible. -This page describes how to update manually to the latest release of `rippled` on Ubuntu Linux. These instructions assume you have already [installed `rippled` using Alien](install-rippled-on-ubuntu-with-alien.html). +**Caution:** To upgrade from `rippled` 1.2.x to 1.3.0 or higher on Ubuntu Linux, you should follow the [1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html). The following instructions assume you have already installed the native APT package provided with versions 1.3.0 and up. + +**Tip:** To perform these steps all at once, you can run the `/opt/ripple/bin/update-rippled.sh` script, which is included with the `rippled` package and is compatible with Ubuntu and Debian start with `rippled` version 1.3.0. To update manually, complete the following steps: -1. Update the package list from Ripple's yum repository: +1. Update apt repositories: - $ sudo rpm -Uvh --replacepkgs https://mirrors.ripple.com/ripple-repo-el7.rpm + $ sudo apt -y update -2. Download the latest `rippled` package: +2. Upgrade the `rippled` package: - $ yumdownloader --enablerepo=ripple-stable --releasever=el7 rippled + $ sudo apt -y upgrade rippled -3. Verify the signatures on the downloaded packages: - - $ rpm -K rippled*.rpm - -4. Use Alien to upgrade to the new `rippled` package: - - $ sudo alien -i --scripts rippled*.rpm - -5. Reload the `systemd` unit files: +3. Reload the `systemd` unit files: $ sudo systemctl daemon-reload -6. Restart the `rippled` service: +4. Restart the `rippled` service: $ sudo service rippled restart - -7. Delete the downloaded `rippled` package file: - - $ rm rippled*.rpm - - (This does not affect the installation, but prevents later updates from trying to re-install the old version.) From ece93bc51da7a7b1211fd62860857457130a5434 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 2 Jul 2019 18:11:17 -0700 Subject: [PATCH 07/19] Sidebar: hide subpages with redirect template --- tool/template-sidebar_nav.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tool/template-sidebar_nav.html b/tool/template-sidebar_nav.html index 33c8e74336..77768a57e8 100644 --- a/tool/template-sidebar_nav.html +++ b/tool/template-sidebar_nav.html @@ -100,7 +100,7 @@ {% endif %} {% for subpage in catpages|selectattr('subcategory', 'defined_and_equalto', page.subcategory) %} - {% if subpage != page %} + {% if subpage != page and subpage.template != "template-redirect.html" %} {% if subpage == currentpage %}
  • {{ subpage.name }}{% if subpage.status is defined and subpage.status == "not_enabled" %} {% include 'template-status_not_enabled.html' %}{% endif %}
    • {% else %} @@ -164,7 +164,7 @@ {% for subsubpage in category_members %} {% if subsubpage != subpage and (subsubpage.subcategory is undefined or - subsubpage == category_members|selectattr('subcategory', 'defined_and_equalto', subsubpage.subcategory)|first) %} + subsubpage == category_members|selectattr('subcategory', 'defined_and_equalto', subsubpage.subcategory)|first) and subsubpage.template != "template-redirect.html" %}
  • {{ subsubpage.name }}{% if subsubpage.status is defined and subsubpage.status == "not_enabled" %} {% include 'template-status_not_enabled.html' %}{% endif %}
    • {% endif %} {% endfor %} @@ -228,7 +228,7 @@ {% if subpage != page %} {% if subpage == currentpage %}
  • {{ subpage.name }}{% if subpage.status is defined and subpage.status == "not_enabled" %} {% include 'template-status_not_enabled.html' %}{% endif %}
    • - {% else %} + {% elif subpage.template != "template-redirect.html" %}
  • {{ subpage.name }}{% if subpage.status is defined and subpage.status == "not_enabled" %} {% include 'template-status_not_enabled.html' %}{% endif %}
    • {% endif %} {% endif %} From edda56510b966386ea68bbeb1116c3201480793b Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 2 Jul 2019 18:11:40 -0700 Subject: [PATCH 08/19] rippled v1.3.0 install/upgrade/build updates --- .../installation/build-run-rippled-macos.md | 5 +++-- .../installation/build-run-rippled-ubuntu.md | 6 ++++-- .../installation/install-rippled-on-ubuntu.md | 8 +++++++- .../installation/update-rippled-automatically-on-linux.md | 2 +- .../update-rippled-manually-on-centos-rhel.md | 2 ++ .../installation/update-rippled-manually-on-ubuntu.md | 2 +- 6 files changed, 18 insertions(+), 7 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md index 566b052e85..0c1f8020d7 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md @@ -24,7 +24,7 @@ For development purposes Ripple recommends running `rippled` as your own user, n $ brew install git cmake pkg-config protobuf openssl ninja -0. Install Boost 1.67.0. `rippled` 1.2.0 is compatible with Boost 1.67. +0. Install Boost 1.67.0 or higher. `rippled` 1.3.0 is compatible with Boost 1.67.0 and higher. The latest version of Boost available in the Homebrew repositories isn't new enough, so you must install Boost manually: 1. Download [Boost 1.67.0](https://dl.bintray.com/boostorg/release/1.67.0/source/boost_1_67_0.tar.bz2). @@ -165,6 +165,7 @@ For information about `rippled` log messages, see [Understanding Log Messages](u ## See Also -- [Install rippled on Ubuntu Linux](install-rippled-on-ubuntu-with-alien.html) (Pre-built binary on Ubuntu for production use) +- [Install rippled on Ubuntu Linux](install-rippled-on-ubuntu.html) (Pre-built binary on Ubuntu for production use) +- [Install rippled on Red Hat Enterprise Linux](install-rippled-on-centos-rhel-with-yum.html) (Pre-built binary on RHEL or CentOS for production use) - [Build and Run `rippled` on Ubuntu](build-run-rippled-ubuntu.html) (Compile `rippled` yourself on Ubuntu) - [Compilation instructions for other platforms](https://github.com/ripple/rippled/tree/develop/Builds) diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md index ed7b6e7683..ff7512cfdc 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md @@ -31,7 +31,7 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof 4. Install CMake. - Version 1.2.0 of `rippled` requires CMake 3.9.0 or higher. For the purposes of this tutorial, we used CMake 3.13.3, which was the latest version available at the time of writing. + Version 1.3.0 of `rippled` requires CMake 3.9.0 or higher. For the purposes of this tutorial, we used CMake 3.13.3, which was the latest version available at the time of writing. If you have previously installed CMake 3.9.0 or higher, you can skip these steps. @@ -44,7 +44,7 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof 5. Compile Boost. - Version 1.2.0 of `rippled` requires Boost version 1.67.0 exactly. Because Boost version 1.67.0 isn't available in the Ubuntu 16.04 software repositories, you must compile it yourself. + Version 1.3.0 of `rippled` requires Boost version 1.67.0 or higher. Because Boost version 1.67.0 or higher isn't available in the Ubuntu 18.04 (or 16.04) software repositories, you must compile it yourself. If you have previously built Boost 1.67.0 for `rippled` and configured the `BOOST_ROOT` environment variable, you can skip these steps. @@ -86,6 +86,8 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof 7. Check the commit log to be sure you're compiling the version you intend to. The most recent commit should be signed by a well-known Ripple developer and should set the version number to the latest released version. For example: + ***TODO: Add the 1.3.0 release commit*** + $ git log -1 commit 7779dcdda00ea61a976cf5f387bc1f3bb4ebbfdd diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md index debbe1f030..6455aa53a9 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md @@ -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 v1.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. @@ -80,3 +80,9 @@ Before you install `rippled`, you must meet the [System Requirements](system-req ## Next Steps {% include '_snippets/post-rippled-install.md' %} + + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md index 5a2eb0aa47..f0e3d6fb11 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md @@ -4,7 +4,7 @@ On Linux, you can set up `rippled` to automatically upgrade to the latest versio These instructions assume you have already installed `rippled` [from the `yum` repository (CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.html) or [using `apt` (Ubuntu/Debian)](install-rippled-on-ubuntu.html). -**Warning:** As of version 1.3.0, the install and upgrade process has changed. Automatic updates **will not** upgrade to `rippled` 1.3.0. If you have `rippled` v1.2.4 or lower installed, follow the [rippled 1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html) first. After performing the migration, automatic updates should work again. +**Warning:** As of version 1.3.0, the install and upgrade process has changed. Automatic updates **will not** upgrade from `rippled` 1.2.4 or lower to `rippled` 1.3.0 or higher. If you have `rippled` v1.2.4 or lower installed, follow the [rippled 1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html) first. After performing the migration, automatic updates should work again. To set up automatic updates, complete the following steps: diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md index 211cac8a98..b10ef31c96 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md @@ -4,6 +4,8 @@ This page describes how to update manually to the latest release of `rippled` on These instructions assume you have already [installed `rippled` from the `yum` repository](install-rippled-on-centos-rhel-with-yum.html). +**Tip:** To perform these steps all at once, you can run the `/opt/ripple/bin/update-rippled.sh` script, which is included with the `rippled` package. + To update manually, complete the following steps: 1. Download and install the latest `rippled` package: diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md index 02a0c27397..e258929eb2 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md @@ -4,7 +4,7 @@ This page describes how to update manually to the latest release of `rippled` on **Caution:** To upgrade from `rippled` 1.2.x to 1.3.0 or higher on Ubuntu Linux, you should follow the [1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html). The following instructions assume you have already installed the native APT package provided with versions 1.3.0 and up. -**Tip:** To perform these steps all at once, you can run the `/opt/ripple/bin/update-rippled.sh` script, which is included with the `rippled` package and is compatible with Ubuntu and Debian start with `rippled` version 1.3.0. +**Tip:** To perform these steps all at once, you can run the `/opt/ripple/bin/update-rippled.sh` script, which is included with the `rippled` package and is compatible with Ubuntu and Debian starting with `rippled` version 1.3.0. To update manually, complete the following steps: From 2fe41ecda5b462d975ab2d065f4f723f559313c9 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 8 Jul 2019 17:20:37 -0700 Subject: [PATCH 09/19] Update install instructions per reviews --- content/_snippets/post-rippled-install.md | 2 +- .../configuration/configure-advisory-deletion.md | 2 +- .../installation/build-run-rippled-macos.md | 2 +- .../installation/capacity-planning.md | 2 +- .../install-rippled-on-centos-rhel-with-yum.md | 2 +- .../installation/install-rippled-on-ubuntu.md | 8 ++++---- .../rippled-1-3-0-migration-instructions.md | 14 +++++++------- .../update-rippled-automatically-on-linux.md | 2 +- .../update-rippled-manually-on-ubuntu.md | 2 +- ...art-a-new-genesis-ledger-in-stand-alone-mode.md | 2 +- .../troubleshooting/diagnosing-problems.md | 2 +- .../fix-sqlite-tx-db-page-size-issue.md | 2 +- .../troubleshooting/server-wont-start.md | 2 +- dactyl-config.yml | 10 ++++++++++ 14 files changed, 32 insertions(+), 22 deletions(-) diff --git a/content/_snippets/post-rippled-install.md b/content/_snippets/post-rippled-install.md index e227f11a2f..90fd661fe3 100644 --- a/content/_snippets/post-rippled-install.md +++ b/content/_snippets/post-rippled-install.md @@ -48,4 +48,4 @@ If you change the `[debug_logfile]` or `[database_path]` sections, you may need You must update `rippled` regularly to remain synced with the rest of the XRP Ledger network. You can subscribe to the [rippled Google Group](https://groups.google.com/forum/#!forum/ripple-server) to receive notifications of new `rippled` releases. -The `rippled` package includes a script you can use to [enable automatic updates on Linux](update-rippled-automatically.html). On other platforms, you must update manually. +The `rippled` package includes a script you can use to [enable automatic updates on Linux](update-rippled-automatically-on-linux.html). On other platforms, you must update manually. diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.md b/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.md index 3e704ec630..726d9e823b 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-advisory-deletion.md @@ -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. diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md index 0c1f8020d7..88fb52f9ba 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md @@ -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 diff --git a/content/tutorials/manage-the-rippled-server/installation/capacity-planning.md b/content/tutorials/manage-the-rippled-server/installation/capacity-planning.md index 75fb8da721..03275ec315 100644 --- a/content/tutorials/manage-the-rippled-server/installation/capacity-planning.md +++ b/content/tutorials/manage-the-rippled-server/installation/capacity-planning.md @@ -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 diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md index a139026d74..98a668fce6 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md @@ -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: diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md index 6455aa53a9..8a51168cc4 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md @@ -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 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: diff --git a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md index ed4d95b75c..daaab03b4d 100644 --- a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md +++ b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md @@ -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: diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md index f0e3d6fb11..08ac860002 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md @@ -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. diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md index e258929eb2..8147624ea3 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md @@ -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 diff --git a/content/tutorials/manage-the-rippled-server/stand-alone-mode/start-a-new-genesis-ledger-in-stand-alone-mode.md b/content/tutorials/manage-the-rippled-server/stand-alone-mode/start-a-new-genesis-ledger-in-stand-alone-mode.md index d19b3b1f0c..67d5c01906 100644 --- a/content/tutorials/manage-the-rippled-server/stand-alone-mode/start-a-new-genesis-ledger-in-stand-alone-mode.md +++ b/content/tutorials/manage-the-rippled-server/stand-alone-mode/start-a-new-genesis-ledger-in-stand-alone-mode.md @@ -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][] {% include '_snippets/rippled-api-links.md' %} diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/diagnosing-problems.md b/content/tutorials/manage-the-rippled-server/troubleshooting/diagnosing-problems.md index bab71f2be5..03ca5b9402 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/diagnosing-problems.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/diagnosing-problems.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.) diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.md b/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.md index 513e7956fe..80870e7572 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/fix-sqlite-tx-db-page-size-issue.md @@ -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 diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md b/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md index 7b6d98eace..de5b945120 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md @@ -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: diff --git a/dactyl-config.yml b/dactyl-config.yml index f71bc87f74..3fcd1f465d 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -1109,6 +1109,16 @@ pages: targets: - local + - md: tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md + html: rippled-1-3-0-migration-instructions.html + funnel: Docs + doc_type: Tutorials + category: Manage the rippled Server + subcategory: Installation + blurb: Use these instructions to upgrade rippled packages from 1.2.x or below to 1.3.0 or higher. + targets: + - local + - name: Configure rippled html: configure-rippled.html funnel: Docs From 15d6033d1f939544b81ea475ebd44d6f723456a7 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 8 Jul 2019 17:21:34 -0700 Subject: [PATCH 10/19] =?UTF-8?q?'configuration=20file'=20=E2=86=92=20'con?= =?UTF-8?q?fig=20file'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- content/concepts/consensus-network/amendments/amendments.md | 2 +- content/concepts/the-rippled-server/peer-protocol.md | 2 +- .../rippled-api/admin-rippled-methods/admin-rippled-methods.md | 2 +- content/references/rippled-api/commandline-usage.md | 2 +- .../get-started/get-started-with-rippleapi-for-javascript.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/concepts/consensus-network/amendments/amendments.md b/content/concepts/consensus-network/amendments/amendments.md index 109e65641d..c8a87ab897 100644 --- a/content/concepts/consensus-network/amendments/amendments.md +++ b/content/concepts/consensus-network/amendments/amendments.md @@ -219,7 +219,7 @@ To look up which `rippled` version supports these features, see [Known Amendment ## Testing Amendments -If you want to see how `rippled` behaves with an amendment enabled, before that amendment gets enabled on the production network, you can run use `rippled`'s configuration file to forcibly enable a feature. This is intended for development purposes only. +If you want to see how `rippled` behaves with an amendment enabled, before that amendment gets enabled on the production network, you can run use `rippled`'s config file to forcibly enable a feature. This is intended for development purposes only. Because other members of the consensus network probably do not have the feature enabled, you should not use this feature while connecting to the production network. While testing with features forcibly enabled, you should run `rippled` in [stand-alone mode](rippled-server-modes.html#reasons-to-run-a-rippled-server-in-stand-alone-mode). diff --git a/content/concepts/the-rippled-server/peer-protocol.md b/content/concepts/the-rippled-server/peer-protocol.md index 8f151444de..fc686fefeb 100644 --- a/content/concepts/the-rippled-server/peer-protocol.md +++ b/content/concepts/the-rippled-server/peer-protocol.md @@ -15,7 +15,7 @@ To establish a peer-to-peer connection, one server connects to another via HTTPS To participate in the XRP Ledger, `rippled` servers connect to arbitrary peers using the peer protocol. (All peers are treated as untrusted, unless they are [clustered](clustering.html) with the current server.) -Ideally, the server should be able to send _and_ receive connections on the peer port. You should forward the port used for the peer protocol through your firewall to the `rippled` server. The [default `rippled` configuration file](https://github.com/ripple/rippled/blob/master/cfg/rippled-example.cfg) listens for incoming peer protocol connections on port 51235 on all network interfaces. You can change the port used by editing the appropriate stanza in your `rippled.cfg` file. +Ideally, the server should be able to send _and_ receive connections on the peer port. You should forward the port used for the peer protocol through your firewall to the `rippled` server. The [default `rippled` config file](https://github.com/ripple/rippled/blob/master/cfg/rippled-example.cfg) listens for incoming peer protocol connections on port 51235 on all network interfaces. You can change the port used by editing the appropriate stanza in your `rippled.cfg` file. Example: diff --git a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md index b1149e53f6..ae3bbb5d2c 100644 --- a/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md +++ b/content/references/rippled-api/admin-rippled-methods/admin-rippled-methods.md @@ -54,7 +54,7 @@ Use these methods to check the status of the network and server. The following admin commands are deprecated and may be removed without further notice: * `ledger_header` - Use the [ledger method][] instead. -* `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score` - Use the configuration file for UNL management instead. +* `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score` - Use the `validators.txt` config file for UNL management instead. * `wallet_seed` - Use the [wallet_propose method][] instead. diff --git a/content/references/rippled-api/commandline-usage.md b/content/references/rippled-api/commandline-usage.md index 4672d21a79..660bb24280 100644 --- a/content/references/rippled-api/commandline-usage.md +++ b/content/references/rippled-api/commandline-usage.md @@ -18,7 +18,7 @@ These options apply to most modes: | Option | Description | |:----------------|:-----------------------------------------------------------| -| `--conf {FILE}` | Use `{FILE}` as the configuration file instead of looking for config files in the default locations. If not specified, `rippled` first checks the local working directory for a `rippled.cfg` file. On Linux, if that file is not found, `rippled` next checks for `$XDG_CONFIG_HOME/ripple/ripple.cfg`. (Typically, `$XDG_CONFIG_HOME` maps to `$HOME/.config`.) | +| `--conf {FILE}` | Use `{FILE}` as the config file instead of looking for config files in the default locations. If not specified, `rippled` first checks the local working directory for a `rippled.cfg` file. On Linux, if that file is not found, `rippled` next checks for `$XDG_CONFIG_HOME/ripple/ripple.cfg`. (Typically, `$XDG_CONFIG_HOME` maps to `$HOME/.config`.) | ### Verbosity Options diff --git a/content/tutorials/get-started/get-started-with-rippleapi-for-javascript.md b/content/tutorials/get-started/get-started-with-rippleapi-for-javascript.md index 0538480d7b..e016c309c7 100644 --- a/content/tutorials/get-started/get-started-with-rippleapi-for-javascript.md +++ b/content/tutorials/get-started/get-started-with-rippleapi-for-javascript.md @@ -2,7 +2,7 @@ This tutorial guides you through the basics of building an XRP Ledger-connected application using [Node.js](http://nodejs.org/) and [RippleAPI](rippleapi-reference.html), a JavaScript API for accessing the XRP Ledger. -The scripts and configuration files used in this guide are [available in the Ripple Dev Portal GitHub Repository](https://github.com/ripple/ripple-dev-portal/tree/master/content/_code-samples/rippleapi_quickstart). +The scripts and config files used in this guide are [available in the Ripple Dev Portal GitHub Repository](https://github.com/ripple/ripple-dev-portal/tree/master/content/_code-samples/rippleapi_quickstart). From 9baf5cc3722593fb73d7217ae28fdbcac82d7a11 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 9 Jul 2019 13:12:54 -0700 Subject: [PATCH 11/19] Corrections for v1.3.0 automatic updates --- .../installation/rippled-1-3-0-migration-instructions.md | 6 ++++-- .../installation/update-rippled-automatically-on-linux.md | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md index daaab03b4d..a70fa18ec3 100644 --- a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md +++ b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md @@ -12,7 +12,7 @@ For other platforms, see the updated instructions for compiling from source. ([U ## Migration on CentOS or Red Hat Enterprise Linux (RHEL) -Ripple's official RPM repository and instructions for using it have changed. To migrate from the old repository to the new one, complete the following steps: +Ripple's official RPM repository and instructions for using it have changed. If you have [automatic updates](update-rippled-automatically-on-linux.html) enabled, your system should perform the migration automatically. To migrate manually from the old repository to the new one, complete the following steps: 1. Stop the `rippled` server. @@ -22,6 +22,8 @@ Ripple's official RPM repository and instructions for using it have changed. To $ sudo rpm -e ripple-repo + The `rippled-repo` package is **DEPRECATED** as of `rippled` version 1.3.0. The package has been updated one last time for 1.3.0. In the future, any changes to the repositories will require manual changes to your repos file. + 3. Add Ripple's new yum repository: $ cat << REPOFILE | sudo tee /etc/yum.repos.d/ripple.repo @@ -49,7 +51,7 @@ Ripple's official RPM repository and instructions for using it have changed. To $ sudo systemctl start rippled.service -**Tip:** If you had [automatic updates](update-rippled-automatically-on-linux.html) enabled before 1.3.0, they should continue working after performing this migration process. +**Warning:** If you use [automatic updates](update-rippled-automatically-on-linux.html), they should continue working after performing this migration process. However, **the `ripple-repo` package is now deprecated**. As a consequence, in the future, any changes to Ripple's repositories may require you to manually update your repos file. ## Migration on Ubuntu Linux diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md index 08ac860002..63db8fadbf 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md @@ -4,8 +4,6 @@ On Linux, you can set up `rippled` to automatically upgrade to the latest versio These instructions assume you have already installed `rippled` [from the `yum` repository (CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.html) or [using `apt` (Ubuntu/Debian)](install-rippled-on-ubuntu.html). -**Warning:** As of version 1.3.0, the install and upgrade process has changed. Automatic updates **will not** upgrade from `rippled` 1.2.4 or lower to `rippled` 1.3.0 or higher. If you have `rippled` v1.2.4 or lower installed, follow the [rippled 1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html) first. After performing the migration, automatic updates should work again. - To set up automatic updates, complete the following steps: 1. Check that `/opt/ripple/etc/update-rippled-cron` exists. If it does not, update manually ([CentOS/Red Hat](update-rippled-manually-on-centos-rhel.html) or [Ubuntu/Debian](update-rippled-manually-on-ubuntu.html)). @@ -15,3 +13,5 @@ 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 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. + +**Caution:** In the future, it is possible that changes to Ripple's repositories may require manual intervention to update the URLs where your script searches for updates. Stay tuned to the [XRP Ledger Blog](/blog/) or the [ripple-server mailing list](https://groups.google.com/forum/#!forum/ripple-server) for announcements on any required changes. From 18952d2b669f814f710887f92c460667e0f7349c Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Wed, 3 Jul 2019 17:13:53 -0700 Subject: [PATCH 12/19] Add fixMasterKeyAsRegularKey amendment details --- content/_snippets/rippled-api-links.md | 1 + .../amendments/known-amendments.md | 83 +++++++++++-------- .../transaction-types/setregularkey.md | 4 +- 3 files changed, 53 insertions(+), 35 deletions(-) diff --git a/content/_snippets/rippled-api-links.md b/content/_snippets/rippled-api-links.md index 2fc3b9c11d..56406551e9 100644 --- a/content/_snippets/rippled-api-links.md +++ b/content/_snippets/rippled-api-links.md @@ -122,6 +122,7 @@ "fix1571", "fix1578", "fix1623", + "fixMasterKeyAsRegularKey", "fixTakerDryOfferRemoval", "Flow", "FlowCross", diff --git a/content/concepts/consensus-network/amendments/known-amendments.md b/content/concepts/consensus-network/amendments/known-amendments.md index 4ddcc43f1f..de2005873b 100644 --- a/content/concepts/consensus-network/amendments/known-amendments.md +++ b/content/concepts/consensus-network/amendments/known-amendments.md @@ -5,40 +5,41 @@ The following is a comprehensive list of all known amendments and their status o | Name | Introduced | Status | |:--------------------------|:-----------|:------------------------------------| -| [CryptoConditionsSuite][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | -| [OwnerPaysFee][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | -| [SHAMapV2][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | -| [Tickets][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | -| [Checks][] | v0.90.0 | [Planned: TBD]( "BADGE_LIGHTGREY") | -| [FlowCross][] | v0.70.0 | [Planned: TBD]( "BADGE_LIGHTGREY") | -| [MultiSignReserve][] | v1.2.0 | [Enabled: 2019-04-17](https://xrpcharts.ripple.com/#/transactions/C421E1D08EFD78E6B8D06B085F52A34A681D0B51AE62A018527E1B8F54C108FB "BADGE_GREEN") | -| [fixTakerDryOfferRemoval][] | v1.2.0 | [Enabled: 2019-04-02](https://xrpcharts.ripple.com/#/transactions/C42335E95F1BD2009A2C090EA57BD7FB026AD285B4B85BE15F669BA4F70D11AF "BADGE_GREEN") | -| [fix1578][] | v1.2.0 | [Enabled: 2019-03-23](https://xrpcharts.ripple.com/#/transactions/7A80C87F59BCE6973CBDCA91E4DBDB0FC5461D3599A8BC8EAD02FA590A50005D "BADGE_GREEN") | -| [DepositPreauth][] | v1.1.0 | [Enabled: 2018-10-09](https://xrpcharts.ripple.com/#/transactions/AD27403CB840AE67CADDB084BC54249D7BD1B403885819B39CCF723DC671F927 "BADGE_GREEN") | -| [fix1515][] | v1.1.0 | [Enabled: 2018-10-09](https://xrpcharts.ripple.com/#/transactions/6DF60D9EC8AF3C39B173840F4D1C57F8A8AB51E7C6571483B4A5F1AA0A9AAEBF "BADGE_GREEN") | -| [fix1543][] | v1.0.0 | [Enabled: 2018-06-21](https://xrpcharts.ripple.com/#/transactions/EA6054C9D256657014052F1447216CEA75FFDB1C9342D45EB0F9E372C0F879E6 "BADGE_GREEN") | -| [fix1623][] | v1.0.0 | [Enabled: 2018-06-20](https://xrpcharts.ripple.com/#/transactions/4D218D86A2B33E29F17AA9C25D8DFFEE5D2559F75F7C0B1D016D3F2C2220D3EB "BADGE_GREEN") | -| [fix1571][] | v1.0.0 | [Enabled: 2018-06-19](https://xrpcharts.ripple.com/#/transactions/920AA493E57D991414B614FB3C1D1E2F863211B48129D09BC8CB74C9813C38FC "BADGE_GREEN") | -| [DepositAuth][] | v0.90.0 | [Enabled: 2018-04-06](https://xrpcharts.ripple.com/#/transactions/902C51270B918B40CD23A622E18D48B4ABB86F0FF4E84D72D9E1907BF3BD4B25 "BADGE_GREEN") | -| [fix1513][] | v0.90.0 | [Enabled: 2018-04-06](https://xrpcharts.ripple.com/#/transactions/57FE540B8B8E2F26CE8B53D1282FEC55E605257E29F5B9EB49E15EA3989FCF6B "BADGE_GREEN") | -| [fix1201][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/B1157116DDDDA9D9B1C4A95C029AC335E05DB052CECCC5CA90118A4D46C77C5E "BADGE_GREEN") | -| [fix1512][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/63F69F59BEFDC1D79DBF1E4060601E05960683AA784926FB74BC55074C4F6647 "BADGE_GREEN") | -| [fix1523][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/97FD0E35654F4B6714010D3CBBAC4038F60D64AD0292693C28A1DF4B796D8469 "BADGE_GREEN") | -| [fix1528][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/27AEE02DA4FE22B6BB479F850FBBC873FDC7A09A8594753A91B53098D726397E "BADGE_GREEN") | -| [SortedDirectories][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/6E2309C156EBF94D03B83D282A3914671BF9168FB26463CFECD068C63FFFAB29 "BADGE_GREEN") | -| [EnforceInvariants][] | v0.70.0 | [Enabled: 2017-07-07](https://xrpcharts.ripple.com/#/transactions/17593B03F7D3283966F3C0ACAF4984F26E9D884C9A202097DAED0523908E76C6 "BADGE_GREEN") | -| [fix1373][] | v0.70.0 | [Enabled: 2017-07-07](https://xrpcharts.ripple.com/#/transactions/7EBA3852D111EA19D03469F6870FAAEBF84C64F1B9BAC13B041DDD26E28CA399 "BADGE_GREEN") | -| [Escrow][] | v0.60.0 | [Enabled: 2017-03-31](https://xrpcharts.ripple.com/#/transactions/C581E0A3F3832FFFEEB13C497658F475566BD7695B0BBA531A774E6739801515 "BADGE_GREEN") | -| [fix1368][] | v0.60.0 | [Enabled: 2017-03-31](https://xrpcharts.ripple.com/#/transactions/3D20DE5CD19D5966865A7D0405FAC7902A6F623659667D6CB872DF7A94B6EF3F "BADGE_GREEN") | -| [PayChan][] | v0.33.0 | [Enabled: 2017-03-31](https://xrpcharts.ripple.com/#/transactions/16135C0B4AB2419B89D4FB4569B8C37FF76B9EF9CE0DD99CCACB5734445AFD7E "BADGE_GREEN") | -| [TickSize][] | v0.50.0 | [Enabled: 2017-02-21](https://xrpcharts.ripple.com/#/transactions/A12430E470BE5C846759EAE3C442FF03374D5D73ECE5815CF4906894B769565E "BADGE_GREEN") | -| [CryptoConditions][] | v0.50.0 | [Enabled: 2017-01-03](https://xrpcharts.ripple.com/#/transactions/8EB00131E1C3DB35EDFF45C155D941E18C3E86BC1934FF987D2DA204F4065F15 "BADGE_GREEN") | -| [Flow][] | v0.33.0 | [Enabled: 2016-10-21](https://xrpcharts.ripple.com/#/transactions/C06CE3CABA3907389E4DD296C5F31C73B1548CC20BD7B83416C78CD7D4CD38FC "BADGE_GREEN") | -| [TrustSetAuth][] | v0.30.0 | [Enabled: 2016-07-19](https://xrpcharts.ripple.com/#/transactions/0E589DE43C38AED63B64FF3DA87D349A038F1821212D370E403EB304C76D70DF "BADGE_GREEN") | -| [MultiSign][] | v0.31.0 | [Enabled: 2016-06-27](https://xrpcharts.ripple.com/#/transactions/168F8B15F643395E59B9977FC99D6310E8708111C85659A9BAF8B9222EEAC5A7 "BADGE_GREEN") | -| [FeeEscalation][] | v0.31.0 | [Enabled: 2016-05-19](https://xrpcharts.ripple.com/#/transactions/5B1F1E8E791A9C243DD728680F108FEF1F28F21BA3B202B8F66E7833CA71D3C3 "BADGE_GREEN") | -| [FlowV2][] | v0.32.1 | [Vetoed: Removed in v0.33.0](https://xrpl.org/blog/2016/flowv2-vetoed.html "BADGE_RED") | -| [SusPay][] | v0.31.0 | [Vetoed: Removed in v0.60.0](https://xrpl.org/blog/2017/ticksize-voting.html#upcoming-features "BADGE_RED") | +| [CryptoConditionsSuite][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | +| [OwnerPaysFee][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | +| [SHAMapV2][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | +| [Tickets][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | +| [fixMasterKeyAsRegularKey][] | v1.3.0 | [Planned: TBD]( "BADGE_LIGHTGREY") | +| [Checks][] | v0.90.0 | [Planned: TBD]( "BADGE_LIGHTGREY") | +| [FlowCross][] | v0.70.0 | [Planned: TBD]( "BADGE_LIGHTGREY") | +| [MultiSignReserve][] | v1.2.0 | [Enabled: 2019-04-17](https://xrpcharts.ripple.com/#/transactions/C421E1D08EFD78E6B8D06B085F52A34A681D0B51AE62A018527E1B8F54C108FB "BADGE_GREEN") | +| [fixTakerDryOfferRemoval][] | v1.2.0 | [Enabled: 2019-04-02](https://xrpcharts.ripple.com/#/transactions/C42335E95F1BD2009A2C090EA57BD7FB026AD285B4B85BE15F669BA4F70D11AF "BADGE_GREEN") | +| [fix1578][] | v1.2.0 | [Enabled: 2019-03-23](https://xrpcharts.ripple.com/#/transactions/7A80C87F59BCE6973CBDCA91E4DBDB0FC5461D3599A8BC8EAD02FA590A50005D "BADGE_GREEN") | +| [DepositPreauth][] | v1.1.0 | [Enabled: 2018-10-09](https://xrpcharts.ripple.com/#/transactions/AD27403CB840AE67CADDB084BC54249D7BD1B403885819B39CCF723DC671F927 "BADGE_GREEN") | +| [fix1515][] | v1.1.0 | [Enabled: 2018-10-09](https://xrpcharts.ripple.com/#/transactions/6DF60D9EC8AF3C39B173840F4D1C57F8A8AB51E7C6571483B4A5F1AA0A9AAEBF "BADGE_GREEN") | +| [fix1543][] | v1.0.0 | [Enabled: 2018-06-21](https://xrpcharts.ripple.com/#/transactions/EA6054C9D256657014052F1447216CEA75FFDB1C9342D45EB0F9E372C0F879E6 "BADGE_GREEN") | +| [fix1623][] | v1.0.0 | [Enabled: 2018-06-20](https://xrpcharts.ripple.com/#/transactions/4D218D86A2B33E29F17AA9C25D8DFFEE5D2559F75F7C0B1D016D3F2C2220D3EB "BADGE_GREEN") | +| [fix1571][] | v1.0.0 | [Enabled: 2018-06-19](https://xrpcharts.ripple.com/#/transactions/920AA493E57D991414B614FB3C1D1E2F863211B48129D09BC8CB74C9813C38FC "BADGE_GREEN") | +| [DepositAuth][] | v0.90.0 | [Enabled: 2018-04-06](https://xrpcharts.ripple.com/#/transactions/902C51270B918B40CD23A622E18D48B4ABB86F0FF4E84D72D9E1907BF3BD4B25 "BADGE_GREEN") | +| [fix1513][] | v0.90.0 | [Enabled: 2018-04-06](https://xrpcharts.ripple.com/#/transactions/57FE540B8B8E2F26CE8B53D1282FEC55E605257E29F5B9EB49E15EA3989FCF6B "BADGE_GREEN") | +| [fix1201][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/B1157116DDDDA9D9B1C4A95C029AC335E05DB052CECCC5CA90118A4D46C77C5E "BADGE_GREEN") | +| [fix1512][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/63F69F59BEFDC1D79DBF1E4060601E05960683AA784926FB74BC55074C4F6647 "BADGE_GREEN") | +| [fix1523][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/97FD0E35654F4B6714010D3CBBAC4038F60D64AD0292693C28A1DF4B796D8469 "BADGE_GREEN") | +| [fix1528][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/27AEE02DA4FE22B6BB479F850FBBC873FDC7A09A8594753A91B53098D726397E "BADGE_GREEN") | +| [SortedDirectories][] | v0.80.0 | [Enabled: 2017-11-14](https://xrpcharts.ripple.com/#/transactions/6E2309C156EBF94D03B83D282A3914671BF9168FB26463CFECD068C63FFFAB29 "BADGE_GREEN") | +| [EnforceInvariants][] | v0.70.0 | [Enabled: 2017-07-07](https://xrpcharts.ripple.com/#/transactions/17593B03F7D3283966F3C0ACAF4984F26E9D884C9A202097DAED0523908E76C6 "BADGE_GREEN") | +| [fix1373][] | v0.70.0 | [Enabled: 2017-07-07](https://xrpcharts.ripple.com/#/transactions/7EBA3852D111EA19D03469F6870FAAEBF84C64F1B9BAC13B041DDD26E28CA399 "BADGE_GREEN") | +| [Escrow][] | v0.60.0 | [Enabled: 2017-03-31](https://xrpcharts.ripple.com/#/transactions/C581E0A3F3832FFFEEB13C497658F475566BD7695B0BBA531A774E6739801515 "BADGE_GREEN") | +| [fix1368][] | v0.60.0 | [Enabled: 2017-03-31](https://xrpcharts.ripple.com/#/transactions/3D20DE5CD19D5966865A7D0405FAC7902A6F623659667D6CB872DF7A94B6EF3F "BADGE_GREEN") | +| [PayChan][] | v0.33.0 | [Enabled: 2017-03-31](https://xrpcharts.ripple.com/#/transactions/16135C0B4AB2419B89D4FB4569B8C37FF76B9EF9CE0DD99CCACB5734445AFD7E "BADGE_GREEN") | +| [TickSize][] | v0.50.0 | [Enabled: 2017-02-21](https://xrpcharts.ripple.com/#/transactions/A12430E470BE5C846759EAE3C442FF03374D5D73ECE5815CF4906894B769565E "BADGE_GREEN") | +| [CryptoConditions][] | v0.50.0 | [Enabled: 2017-01-03](https://xrpcharts.ripple.com/#/transactions/8EB00131E1C3DB35EDFF45C155D941E18C3E86BC1934FF987D2DA204F4065F15 "BADGE_GREEN") | +| [Flow][] | v0.33.0 | [Enabled: 2016-10-21](https://xrpcharts.ripple.com/#/transactions/C06CE3CABA3907389E4DD296C5F31C73B1548CC20BD7B83416C78CD7D4CD38FC "BADGE_GREEN") | +| [TrustSetAuth][] | v0.30.0 | [Enabled: 2016-07-19](https://xrpcharts.ripple.com/#/transactions/0E589DE43C38AED63B64FF3DA87D349A038F1821212D370E403EB304C76D70DF "BADGE_GREEN") | +| [MultiSign][] | v0.31.0 | [Enabled: 2016-06-27](https://xrpcharts.ripple.com/#/transactions/168F8B15F643395E59B9977FC99D6310E8708111C85659A9BAF8B9222EEAC5A7 "BADGE_GREEN") | +| [FeeEscalation][] | v0.31.0 | [Enabled: 2016-05-19](https://xrpcharts.ripple.com/#/transactions/5B1F1E8E791A9C243DD728680F108FEF1F28F21BA3B202B8F66E7833CA71D3C3 "BADGE_GREEN") | +| [FlowV2][] | v0.32.1 | [Vetoed: Removed in v0.33.0](https://xrpl.org/blog/2016/flowv2-vetoed.html "BADGE_RED") | +| [SusPay][] | v0.31.0 | [Vetoed: Removed in v0.60.0](https://xrpl.org/blog/2017/ticksize-voting.html#upcoming-features "BADGE_RED") | **Note:** In many cases, an incomplete version of the code for an amendment is present in previous versions of the software. The "Introduced" version in the table above is the first stable version. The value "TBD" indicates that the amendment is not yet considered stable. @@ -319,6 +320,20 @@ The fix1623 amendment has no effect on [CheckCash transactions][] for a fixed am **Caution:** In `rippled` 1.0.0, if the Checks amendment is enabled before the fix1623 amendment, the `delivered_amount` may display as "0" for variable-amount CheckCash transactions from before this amendment was enabled, even if the transaction delivered a nonzero amount. Ripple plans to enable fix1623 at the same time as the [Checks][] amendment on the production network, but this situation may be possible on [parallel networks](parallel-networks.html). +## fixMasterKeyAsRegularKey +[fixMasterKeyAsRegularKey]: #fixmasterkeyasregularkey + +| Amendment ID | Status | +|:-----------------------------------------------------------------|:----------| +| C4483A1896170C66C098DEA5B0E024309C60DC960DE5F01CD7AF986AA3D9AD37 | Planned | + +Fixes a bug where accounts can set their regular key pair to match their master key pair, but cannot send transactions signed by the key if the master key is disabled. + +Without this fix, a user can unintentionally "blackhole" their account by setting the regular key to match the master key, then disabling the master key. The network rejects transactions signed with the both-master-and-regular key pair because the code interprets them as being signed with the disabled master key before it recognizes that they are signed by the currently-enabled regular key. + +With this amendment enabled, a SetRegularKey transaction cannot set the regular key to match the master key; such a transaction results in the transaction code `temBAD_REGKEY`. Additionally, this amendment changes the signature verification code so that accounts which _already_ have their regular key set to match their master key can send transactions successfully using the key pair. + + ## fixTakerDryOfferRemoval [fixTakerDryOfferRemoval]: #fixtakerdryofferremoval diff --git a/content/references/rippled-api/transaction-formats/transaction-types/setregularkey.md b/content/references/rippled-api/transaction-formats/transaction-types/setregularkey.md index d99cd3e558..cf6c0586dd 100644 --- a/content/references/rippled-api/transaction-formats/transaction-types/setregularkey.md +++ b/content/references/rippled-api/transaction-formats/transaction-types/setregularkey.md @@ -23,7 +23,9 @@ You can protect your account by assigning a regular key pair to it and using it | Field | JSON Type | [Internal Type][] | Description | |:-------------|:----------|:------------------|:------------------------------| -| `RegularKey` | String | AccountID | _(Optional)_ A base-58-encoded [Address][] that indicates the regular key pair to be assigned to the account. If omitted, removes any existing regular key pair from the account. | +| `RegularKey` | String | AccountID | _(Optional)_ A base-58-encoded [Address][] that indicates the regular key pair to be assigned to the account. If omitted, removes any existing regular key pair from the account. Must not match the master key pair for the address. | + +**Warning:** Until the [fixMasterKeyAsRegularKey amendment][] :not_enabled: becomes enabled, it is possible to set your regular key to match your master key. If you then disable the master key, your address cannot send transactions signed with the key even though it matches the enabled regular key. As a result, you cannot send any transactions from the address unless you have [multi-signing](multi-signing.html) enabled and use that. With the amendment enabled, such "blocked" accounts can send transactions again. ## See Also From 874cbb5b46c0004082c3e4f3de1defb621c340c6 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 9 Jul 2019 13:14:49 -0700 Subject: [PATCH 13/19] 'Black hole' is two words --- .../concepts/consensus-network/amendments/known-amendments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/concepts/consensus-network/amendments/known-amendments.md b/content/concepts/consensus-network/amendments/known-amendments.md index de2005873b..4a44d65f1c 100644 --- a/content/concepts/consensus-network/amendments/known-amendments.md +++ b/content/concepts/consensus-network/amendments/known-amendments.md @@ -329,7 +329,7 @@ The fix1623 amendment has no effect on [CheckCash transactions][] for a fixed am Fixes a bug where accounts can set their regular key pair to match their master key pair, but cannot send transactions signed by the key if the master key is disabled. -Without this fix, a user can unintentionally "blackhole" their account by setting the regular key to match the master key, then disabling the master key. The network rejects transactions signed with the both-master-and-regular key pair because the code interprets them as being signed with the disabled master key before it recognizes that they are signed by the currently-enabled regular key. +Without this fix, a user can unintentionally "black hole" their account by setting the regular key to match the master key, then disabling the master key. The network rejects transactions signed with the both-master-and-regular key pair because the code interprets them as being signed with the disabled master key before it recognizes that they are signed by the currently-enabled regular key. With this amendment enabled, a SetRegularKey transaction cannot set the regular key to match the master key; such a transaction results in the transaction code `temBAD_REGKEY`. Additionally, this amendment changes the signature verification code so that accounts which _already_ have their regular key set to match their master key can send transactions successfully using the key pair. From 92bf45afa266cc6b275ad3fcfc09afac7cbb9de9 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 11 Jul 2019 01:29:58 -0700 Subject: [PATCH 14/19] rippled 1.3.0 requires Boost 1.70 (as of rc2) --- .../installation/build-run-rippled-macos.md | 6 ++-- .../installation/build-run-rippled-ubuntu.md | 31 +++++++++---------- 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md index 88fb52f9ba..5782517e17 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md @@ -24,9 +24,9 @@ For development purposes Ripple recommends running `rippled` as your own user, n $ brew install git cmake pkg-config protobuf openssl ninja -0. Install Boost 1.67.0 or higher. `rippled` 1.3.0 is compatible with Boost 1.67.0 and higher. The latest version of Boost available in the Homebrew repositories isn't new enough, so you must install Boost manually: +0. Install Boost 1.70.0 or higher. `rippled` 1.3.0 is compatible with Boost 1.70.0 and higher. The latest version of Boost available in the Homebrew repositories isn't new enough, so you must install Boost manually: - 1. Download [Boost 1.67.0](https://dl.bintray.com/boostorg/release/1.67.0/source/boost_1_67_0.tar.bz2). + 1. Download [Boost 1.70.0](https://dl.bintray.com/boostorg/release/1.70.0/source/boost_1_70_0.tar.bz2). 2. Extract it to a folder. Be sure to note the location. @@ -38,7 +38,7 @@ For development purposes Ripple recommends running `rippled` as your own user, n 0. Ensure that your `BOOST_ROOT` environment variable points to the directory created by the Boost installation. To find your Boost install directory, use `brew info boost`. Put this environment variable in your `.bash_profile` file so it's automatically set when you log in. For example: - export BOOST_ROOT=/Users/my_user/boost_1_67_0 + export BOOST_ROOT=/Users/my_user/boost_1_70_0 0. If you updated your `.bash_profile` file in the previous step, be sure to source it. For example: diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md index ff7512cfdc..715e408f6b 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md @@ -44,21 +44,21 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof 5. Compile Boost. - Version 1.3.0 of `rippled` requires Boost version 1.67.0 or higher. Because Boost version 1.67.0 or higher isn't available in the Ubuntu 18.04 (or 16.04) software repositories, you must compile it yourself. + Version 1.3.0 of `rippled` requires Boost version 1.70.0 or higher. Because Boost version 1.70.0 or higher isn't available in the Ubuntu 18.04 (or 16.04) software repositories, you must compile it yourself. - If you have previously built Boost 1.67.0 for `rippled` and configured the `BOOST_ROOT` environment variable, you can skip these steps. + If you have previously built Boost 1.70.0 for `rippled` and configured the `BOOST_ROOT` environment variable, you can skip these steps. - 1. Download Boost 1.67.0. + 1. Download Boost 1.70.0. - wget https://dl.bintray.com/boostorg/release/1.67.0/source/boost_1_67_0.tar.gz + wget https://dl.bintray.com/boostorg/release/1.70.0/source/boost_1_70_0.tar.gz - 2. Extract `boost_1_67_0.tar.gz`. + 2. Extract `boost_1_70_0.tar.gz`. - tar xvzf boost_1_67_0.tar.gz + tar xvzf boost_1_70_0.tar.gz - 3. Change to the new `boost_1_67_0` directory. + 3. Change to the new `boost_1_70_0` directory. - cd boost_1_67_0 + cd boost_1_70_0 4. Prepare the Boost.Build system for use. @@ -70,9 +70,9 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof **Tip:** This example uses 4 processes to build in parallel. The best number of processes to use depends on how many CPU cores your hardware has available. You can use `cat /proc/cpuinfo` to get information about your hardware's processor. - 6. Set the environment variable `BOOST_ROOT` to point to the new `boost_1_67_0` directory. It's best to put this environment variable in your `.profile`, or equivalent, file for your shell so it's automatically set when you log in. Add the following line to the file: + 6. Set the environment variable `BOOST_ROOT` to point to the new `boost_1_70_0` directory. It's best to put this environment variable in your `.profile`, or equivalent, file for your shell so it's automatically set when you log in. Add the following line to the file: - export BOOST_ROOT=/home/my_user/boost_1_67_0 + export BOOST_ROOT=/home/my_user/boost_1_70_0 7. Source your updated `.profile` file. For example: @@ -86,15 +86,14 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof 7. Check the commit log to be sure you're compiling the version you intend to. The most recent commit should be signed by a well-known Ripple developer and should set the version number to the latest released version. For example: - ***TODO: Add the 1.3.0 release commit*** - $ git log -1 - commit 7779dcdda00ea61a976cf5f387bc1f3bb4ebbfdd - Author: Mike Ellery - Date: Tue Feb 12 16:41:03 2019 -0800 + commit caa5c9e2232ff1eee1d0c61907283649e48e6fbc + Author: Nik Bougalis + Date: Tue Jul 9 13:56:37 2019 -0700 + + Set version to 1.3.0 - Set version to 1.2.0 8. If you previously built, or (more importantly) tried and failed to build `rippled`, you should delete the `my_build/` directory (or whatever you named it) to start clean before moving on to the next step. Otherwise, you may get unexpected behavior, like a `rippled` executable that crashes due to a segmentation fault (segfault). From 4a0f94f4504e80dc6f50585f00e89866ce34a0e9 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Wed, 17 Jul 2019 17:24:54 -0700 Subject: [PATCH 15/19] RocksDB not supported for history sharding on 1.3 - Updated troubleshooting with example error - Removed stale RocksDB-on-shards error from troubleshooting - Updating configuration tutorial to mention that NuDB & SSD are required for shards --- .../configure-history-sharding.md | 14 +++++++---- .../troubleshooting/server-wont-start.md | 23 ++++++++++++------- 2 files changed, 25 insertions(+), 12 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md b/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md index 93e470a38b..5687dd8920 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md @@ -11,9 +11,9 @@ To configure your `rippled` to store shards of ledger history, complete the foll Before you configure your `rippled` server to store history shards, you must decide how much disk space to allocate to the history shard store. This also affects how much history you keep in the default ledger store. You should consider the following when deciding what size to configure your shard store: - The ledger store (defined by the `[node_db]` stanza) is separate from the history shard store. The ledger store is required for all servers and _must_ contain a range of recent history, defined by how many ledgers to keep available in the `online_delete` parameter. (The default configuration stores the most recent 2000 ledgers.) - - If you keep at least 2^15 ledgers (32768) in the ledger store, you can efficiently import chunks of recent history from the ledger store into the shard store. -- The history shard store (defined by the `[shard_db]` stanza) is only required for storing history shards. The configuration stanza should be omitted from servers that do not store history shards. The size of the history shard store is defined in gigabytes in the `max_size_gb` parameter; the server attempts to use as much of this space as possible to store complete shards. -- A shard consists of 2^14 ledgers (16384) and occupies approximately 200 MB to 4 GB based on the age of the shard. Older shards are smaller because there was less activity in the XRP Ledger at the time. + - If you keep at least 215 ledgers (32768) in the ledger store, you can efficiently import chunks of recent history from the ledger store into the shard store. +- The history shard store (defined by the `[shard_db]` stanza) is only required for storing history shards. The configuration stanza should be omitted from servers that do not store history shards. The size of the history shard store is defined in gigabytes in the `max_size_gb` parameter; the server attempts to use as much of this space as possible to store complete shards. The history shard store _MUST_ be stored on a solid-state disk or similar fast media. Traditional spinning hard disks are insufficient. +- A shard consists of 214 ledgers (16384) and occupies approximately 200 MB to 4 GB based on the age of the shard. Older shards are smaller because there was less activity in the XRP Ledger at the time. - The history shard store and the ledger store _must_ be stored at different file paths. You can configure the ledger store and history store to be on different disks or partitions if desired. - It is possible but redundant to hold full ledger history in both the ledger store and the history shard store. - The time to acquire a shard, number of file handles needed by the `rippled` server, and memory cache usage is directly affected by the size of the shard. @@ -33,7 +33,7 @@ path=/var/lib/rippled/db/shards/nudb max_size_gb=50 ``` -**Tip:** Ripple recommends using NuDB for the shard store (`type=NuDB`). NuDB uses fewer file handles per shard than RocksDB. RocksDB uses memory that scales with the size of data it stores, which may require excessive memory overhead. However, NuDB is designed to be used with SSD drives and does not work with rotational disks. +The `type` field **must** be NuDB. [New in: rippled 1.3.0][] **Caution:** If you enable history sharding, then later change the database type of your shard store, you must also change the path or delete the existing data from the configured path. If `rippled` detects the wrong type of data in the shard store path, it may [fail to start](server-wont-start.html). @@ -52,3 +52,9 @@ After your server syncs to the network, it automatically starts downloading hist This folder should contain a numbered folder for each shard your server has. At any given time, up to one folder may contain a `control.txt` file, indicating it is incomplete. + + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md b/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md index de5b945120..16e5d93443 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md @@ -94,7 +94,7 @@ Terminating thread rippled: main: unhandled St13runtime_error 'Can not create "/ Aborted (core dumped) ``` -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. +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. Possible solutions: @@ -179,17 +179,24 @@ Terminating thread rippled: main: unhandled St13runtime_error 'shard path missin If your config includes a `[shard_db]` stanza, it must contain a `path` field, which points to a directory where `rippled` can write the data for the shard store. This error means the `path` field is missing or located in the wrong place. Check for extra whitespace or typos in your config file, and compare against the [Shard Configuration Example](configure-history-sharding.html#2-edit-rippledcfg). +## Unsupported shard store type: RocksDB -## ShardStore unable to open/create RocksDB +RocksDB is no longer supported as a backend for [history sharding](history-sharding.html). If you have an existing configuration that defines a RocksDB shard store, the server fails to start. [New in: rippled 1.3.0][] -If you enable [history sharding](history-sharding.html), then later change the configuration to use RocksDB instead of NuDB, the server may try to read the existing NuDB data as RocksDB data and fail to start. In this case, the server writes an error such as the following: +In this case, the process dies shortly after the log startup command, with a message such as the following appearing earlier in the output log: ```text -ShardStore:ERR shard 504 error: Unable to open/create RocksDB: Invalid argument: /var/lib/rippled/db/shards/504: does not exist (create_if_missing is false) +ShardStore:ERR Unsupported shard store type: RocksDB ``` -To fix this problem, do one of the following: -- Move or delete the existing shard data from the configured folder -- Change where the shard store is located on disk by changing the `path` of the `[shard_db]` stanza in the `rippled.cfg` file. -- Change the shard store back to using NuDB. +To fix this problem, do one of the following, then restart the server: + +- Change your shard store to use NuDB instead. +- Disable history sharding. + + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} From d5108871c42302917f7d506f06bcad459b7297be Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 18 Jul 2019 11:45:34 -0700 Subject: [PATCH 16/19] 130 shard updates: edits per reviews --- .../configuration/configure-history-sharding.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md b/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md index 5687dd8920..4dda04022c 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md @@ -10,11 +10,11 @@ To configure your `rippled` to store shards of ledger history, complete the foll Before you configure your `rippled` server to store history shards, you must decide how much disk space to allocate to the history shard store. This also affects how much history you keep in the default ledger store. You should consider the following when deciding what size to configure your shard store: -- The ledger store (defined by the `[node_db]` stanza) is separate from the history shard store. The ledger store is required for all servers and _must_ contain a range of recent history, defined by how many ledgers to keep available in the `online_delete` parameter. (The default configuration stores the most recent 2000 ledgers.) +- The ledger store (defined by the `[node_db]` stanza) is separate from the history shard store. The ledger store is required for all servers, and always contains a range of recent history, defined by how many ledgers to keep available in the `online_delete` parameter. (The default configuration stores the most recent 2000 ledgers.) - If you keep at least 215 ledgers (32768) in the ledger store, you can efficiently import chunks of recent history from the ledger store into the shard store. - The history shard store (defined by the `[shard_db]` stanza) is only required for storing history shards. The configuration stanza should be omitted from servers that do not store history shards. The size of the history shard store is defined in gigabytes in the `max_size_gb` parameter; the server attempts to use as much of this space as possible to store complete shards. The history shard store _MUST_ be stored on a solid-state disk or similar fast media. Traditional spinning hard disks are insufficient. - A shard consists of 214 ledgers (16384) and occupies approximately 200 MB to 4 GB based on the age of the shard. Older shards are smaller because there was less activity in the XRP Ledger at the time. -- The history shard store and the ledger store _must_ be stored at different file paths. You can configure the ledger store and history store to be on different disks or partitions if desired. +- The history shard store and the ledger store _MUST_ be stored at different file paths. You can configure the ledger store and history store to be on different disks or partitions if desired. - It is possible but redundant to hold full ledger history in both the ledger store and the history shard store. - The time to acquire a shard, number of file handles needed by the `rippled` server, and memory cache usage is directly affected by the size of the shard. @@ -33,9 +33,9 @@ path=/var/lib/rippled/db/shards/nudb max_size_gb=50 ``` -The `type` field **must** be NuDB. [New in: rippled 1.3.0][] +The `type` field can be omitted. If present, it _MUST_ be `NuDB`. [New in: rippled 1.3.0][] -**Caution:** If you enable history sharding, then later change the database type of your shard store, you must also change the path or delete the existing data from the configured path. If `rippled` detects the wrong type of data in the shard store path, it may [fail to start](server-wont-start.html). +**Caution:** If `rippled` detects the wrong type of data in the shard store path, it may [fail to start](server-wont-start.html). You should use a new folder for the shard store. If you previously used a RocksDB shard store (`rippled` 1.2.x and lower), use a different path or delete the RocksDB shard data. For more information, reference the `[shard_db]` example in the [rippled.cfg configuration example](https://github.com/ripple/rippled/blob/master/cfg/rippled-example.cfg). @@ -51,7 +51,7 @@ After your server syncs to the network, it automatically starts downloading hist This folder should contain a numbered folder for each shard your server has. At any given time, up to one folder may contain a `control.txt` file, indicating it is incomplete. - + From 9f2749a59c7d4142a29d9bf66ca96e73fd8670aa Mon Sep 17 00:00:00 2001 From: Alloy Networks <45832257+alloyxrp@users.noreply.github.com> Date: Thu, 25 Jul 2019 15:35:07 +0300 Subject: [PATCH 17/19] Missing install keyword `apt -y apt-transport-https ca-certificates wget gnupg` changed to `apt -y install apt-transport-https ca-certificates wget gnupg` --- .../installation/install-rippled-on-ubuntu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md index 8a51168cc4..ebadc0f24c 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md @@ -18,7 +18,7 @@ Before you install `rippled`, you must meet the [System Requirements](system-req 2. Install utilities: - $ sudo apt -y apt-transport-https ca-certificates wget gnupg + $ sudo apt -y install apt-transport-https ca-certificates wget gnupg 3. Add Ripple's package-signing GPG key to your list of trusted keys: From 7287c3d70b4aa430a042565bcdfb0d2e32491ebf Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 25 Jul 2019 15:37:07 -0700 Subject: [PATCH 18/19] 1.3.1 supersedes 1.3.0 --- content/_snippets/rippled_versions.md | 2 +- .../amendments/known-amendments.md | 2 +- .../configuration/configure-history-sharding.md | 2 +- .../installation/build-run-rippled-macos.md | 2 +- .../installation/build-run-rippled-ubuntu.md | 13 +++++++------ .../install-rippled-on-centos-rhel-with-yum.md | 2 +- .../installation/install-rippled-on-ubuntu.md | 2 +- ...ns.md => rippled-1-3-migration-instructions.md} | 14 +++++++------- .../update-rippled-manually-on-ubuntu.md | 4 ++-- .../troubleshooting/server-wont-start.md | 2 +- dactyl-config.yml | 6 +++--- 11 files changed, 26 insertions(+), 25 deletions(-) rename content/tutorials/manage-the-rippled-server/installation/{rippled-1-3-0-migration-instructions.md => rippled-1-3-migration-instructions.md} (67%) diff --git a/content/_snippets/rippled_versions.md b/content/_snippets/rippled_versions.md index df33471f68..62978ea570 100644 --- a/content/_snippets/rippled_versions.md +++ b/content/_snippets/rippled_versions.md @@ -35,4 +35,4 @@ [New in: rippled 1.1.0]: https://github.com/ripple/rippled/releases/tag/1.1.0 "BADGE_BLUE" [New in: rippled 1.2.0]: https://github.com/ripple/rippled/releases/tag/1.2.0 "BADGE_BLUE" [New in: rippled 1.2.1]: https://github.com/ripple/rippled/releases/tag/1.2.1 "BADGE_BLUE" -[New in: rippled 1.3.0]: https://github.com/ripple/rippled/releases/tag/1.3.0 "BADGE_BLUE" +[New in: rippled 1.3.1]: https://github.com/ripple/rippled/releases/tag/1.3.1 "BADGE_BLUE" diff --git a/content/concepts/consensus-network/amendments/known-amendments.md b/content/concepts/consensus-network/amendments/known-amendments.md index 4a44d65f1c..1b2b2635f9 100644 --- a/content/concepts/consensus-network/amendments/known-amendments.md +++ b/content/concepts/consensus-network/amendments/known-amendments.md @@ -9,7 +9,7 @@ The following is a comprehensive list of all known amendments and their status o | [OwnerPaysFee][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | | [SHAMapV2][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | | [Tickets][] | TBD | [In Development: TBD]( "BADGE_LIGHTGREY") | -| [fixMasterKeyAsRegularKey][] | v1.3.0 | [Planned: TBD]( "BADGE_LIGHTGREY") | +| [fixMasterKeyAsRegularKey][] | v1.3.1 | [Planned: TBD]( "BADGE_LIGHTGREY") | | [Checks][] | v0.90.0 | [Planned: TBD]( "BADGE_LIGHTGREY") | | [FlowCross][] | v0.70.0 | [Planned: TBD]( "BADGE_LIGHTGREY") | | [MultiSignReserve][] | v1.2.0 | [Enabled: 2019-04-17](https://xrpcharts.ripple.com/#/transactions/C421E1D08EFD78E6B8D06B085F52A34A681D0B51AE62A018527E1B8F54C108FB "BADGE_GREEN") | diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md b/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md index 4dda04022c..93b29da8d1 100644 --- a/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-history-sharding.md @@ -33,7 +33,7 @@ path=/var/lib/rippled/db/shards/nudb max_size_gb=50 ``` -The `type` field can be omitted. If present, it _MUST_ be `NuDB`. [New in: rippled 1.3.0][] +The `type` field can be omitted. If present, it _MUST_ be `NuDB`. [New in: rippled 1.3.1][] **Caution:** If `rippled` detects the wrong type of data in the shard store path, it may [fail to start](server-wont-start.html). You should use a new folder for the shard store. If you previously used a RocksDB shard store (`rippled` 1.2.x and lower), use a different path or delete the RocksDB shard data. diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md index 5782517e17..a6d411b396 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-macos.md @@ -24,7 +24,7 @@ For development purposes Ripple recommends running `rippled` as your own user, n $ brew install git cmake pkg-config protobuf openssl ninja -0. Install Boost 1.70.0 or higher. `rippled` 1.3.0 is compatible with Boost 1.70.0 and higher. The latest version of Boost available in the Homebrew repositories isn't new enough, so you must install Boost manually: +0. Install Boost 1.70.0 or higher. `rippled` 1.3.1 is compatible with Boost 1.70.0 and higher. The latest version of Boost available in the Homebrew repositories isn't new enough, so you must install Boost manually: 1. Download [Boost 1.70.0](https://dl.bintray.com/boostorg/release/1.70.0/source/boost_1_70_0.tar.bz2). diff --git a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md index 715e408f6b..4c2947f07a 100644 --- a/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/build-run-rippled-ubuntu.md @@ -31,7 +31,7 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof 4. Install CMake. - Version 1.3.0 of `rippled` requires CMake 3.9.0 or higher. For the purposes of this tutorial, we used CMake 3.13.3, which was the latest version available at the time of writing. + Version 1.3.1 of `rippled` requires CMake 3.9.0 or higher. For the purposes of this tutorial, we used CMake 3.13.3, which was the latest version available at the time of writing. If you have previously installed CMake 3.9.0 or higher, you can skip these steps. @@ -44,7 +44,7 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof 5. Compile Boost. - Version 1.3.0 of `rippled` requires Boost version 1.70.0 or higher. Because Boost version 1.70.0 or higher isn't available in the Ubuntu 18.04 (or 16.04) software repositories, you must compile it yourself. + Version 1.3.1 of `rippled` requires Boost version 1.70.0 or higher. Because Boost version 1.70.0 or higher isn't available in the Ubuntu 18.04 (or 16.04) software repositories, you must compile it yourself. If you have previously built Boost 1.70.0 for `rippled` and configured the `BOOST_ROOT` environment variable, you can skip these steps. @@ -88,11 +88,12 @@ These instructions use Ubuntu's APT (Advanced Packaging Tool) to install the sof $ git log -1 - commit caa5c9e2232ff1eee1d0c61907283649e48e6fbc - Author: Nik Bougalis - Date: Tue Jul 9 13:56:37 2019 -0700 + commit e1adbd7ddd5dfa9f2a9791aa3c0fcc1fdb4e8236 + Author: Manoj doshi + Date: Wed Jul 24 15:21:56 2019 -0700 + + Set version to 1.3.1 - Set version to 1.3.0 8. If you previously built, or (more importantly) tried and failed to build `rippled`, you should delete the `my_build/` directory (or whatever you named it) to start clean before moving on to the next step. Otherwise, you may get unexpected behavior, like a `rippled` executable that crashes due to a segmentation fault (segfault). diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md index 98a668fce6..0b7de9b4f2 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md @@ -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 config files (`rippled.cfg` and `validators.txt`). This update procedure leaves your existing config files in place. + Version 1.3.1 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: diff --git a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md index 8a51168cc4..1d40110454 100644 --- a/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/install-rippled-on-ubuntu.md @@ -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.1][New in: rippled 1.3.1] These instructions install a binary that has been compiled by Ripple. diff --git a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.md similarity index 67% rename from content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md rename to content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.md index a70fa18ec3..b7c98b0421 100644 --- a/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md +++ b/content/tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.md @@ -1,6 +1,6 @@ -# rippled v1.3.0 Migration Instructions +# rippled v1.3.x 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 migration process 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 or later. This migration process is necessary because the `rippled` install process has changed as of version 1.3. This document provides migration steps for upgrading on supported platforms: @@ -22,7 +22,7 @@ Ripple's official RPM repository and instructions for using it have changed. If $ sudo rpm -e ripple-repo - The `rippled-repo` package is **DEPRECATED** as of `rippled` version 1.3.0. The package has been updated one last time for 1.3.0. In the future, any changes to the repositories will require manual changes to your repos file. + The `rippled-repo` package is now **DEPRECATED**. The package has been updated one last time for version 1.3.1. In the future, any changes to the repositories will require manual changes to the `ripple.repo` file. 3. Add Ripple's new yum repository: @@ -40,7 +40,7 @@ Ripple's official RPM repository and instructions for using it have changed. If $ sudo yum install rippled - 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. + Version 1.3.1 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: @@ -56,9 +56,9 @@ Ripple's official RPM repository and instructions for using it have changed. If ## Migration on Ubuntu Linux -Prior to version 1.3.0, the supported way to install `rippled` on Ubuntu Linux was using Alien to install the RPM package. Starting with `rippled` v1.3.0, Ripple provides a native package for Ubuntu and Debian Linux, which is the recommended way of installing it. If you already have the RPM package installed, complete the [installation steps](install-rippled-on-ubuntu.html) to upgrade the package and switch over to the native APT (`.deb`) package. +Prior to version 1.3, the supported way to install `rippled` on Ubuntu Linux was using Alien to install the RPM package. Starting with `rippled` v1.3.1, Ripple provides a native package for Ubuntu and Debian Linux, which is the recommended way of installing it. If you already have the RPM package installed, complete the [installation steps](install-rippled-on-ubuntu.html) to upgrade the package and switch over to the native APT (`.deb`) package. -If you have made any changes to your config files (`/opt/ripple/etc/rippled.cfg` and `/opt/ripple/etc/validators.txt`), `apt` may prompt you during installation asking if you want to overwrite your config files with the newest versions from the packages. Version 1.3.0 does not require any changes to the config file, so you can safely keep your existing config files unchanged. +If you have made any changes to your config files (`/opt/ripple/etc/rippled.cfg` and `/opt/ripple/etc/validators.txt`), `apt` may prompt you during installation asking if you want to overwrite your config files with the newest versions from the packages. Version 1.3 does not require any changes to the config file, so you can safely keep your existing config files unchanged. After installing the new package, if you no longer need Alien for any other packages, you may optionally uninstall it and its dependencies using the following steps: @@ -73,4 +73,4 @@ After installing the new package, if you no longer need Alien for any other pack ### Automatic Updates -The `rippled` v1.3.0 package includes an updated auto-update script that works on Ubuntu and Debian Linux. For more information, see [Update `rippled` Automatically on Linux](update-rippled-automatically-on-linux.html). +The `rippled` v1.3 package includes an updated auto-update script that works on Ubuntu and Debian Linux. For more information, see [Update `rippled` Automatically on Linux](update-rippled-automatically-on-linux.html). diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md index 8147624ea3..c9d21a80a3 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md @@ -2,9 +2,9 @@ This page describes how to update manually to the latest release of `rippled` on Ubuntu Linux. These instructions assume you have already [installed `rippled` using the native package](install-rippled-on-ubuntu.html). Ripple recommends setting up [automatic updates](update-rippled-automatically-on-linux.html) instead, where possible. -**Caution:** To upgrade from `rippled` 1.2.x to 1.3.0 or higher on Ubuntu Linux, you should follow the [1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html). The following instructions assume you have already installed the native APT package provided with versions 1.3.0 and up. +**Caution:** To upgrade from `rippled` 1.2.x to 1.3.1 or higher on Ubuntu Linux, you should follow the [1.3.1 migration instructions](rippled-1-3-0-migration-instructions.html). The following instructions assume you have already installed the native APT package provided with versions 1.3.1 and up. -**Tip:** To perform these steps all at once, you can run the `/opt/ripple/bin/update-rippled.sh` script, which is included with the `rippled` package and is compatible with Ubuntu and Debian starting with `rippled` version 1.3.0. +**Tip:** To perform these steps all at once, you can run the `/opt/ripple/bin/update-rippled.sh` script, which is included with the `rippled` package and is compatible with Ubuntu and Debian starting with `rippled` version 1.3.1. To update manually, complete the following steps: diff --git a/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md b/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md index 16e5d93443..fe913dd254 100644 --- a/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md +++ b/content/tutorials/manage-the-rippled-server/troubleshooting/server-wont-start.md @@ -181,7 +181,7 @@ If your config includes a `[shard_db]` stanza, it must contain a `path` field, w ## Unsupported shard store type: RocksDB -RocksDB is no longer supported as a backend for [history sharding](history-sharding.html). If you have an existing configuration that defines a RocksDB shard store, the server fails to start. [New in: rippled 1.3.0][] +RocksDB is no longer supported as a backend for [history sharding](history-sharding.html). If you have an existing configuration that defines a RocksDB shard store, the server fails to start. [New in: rippled 1.3.1][] In this case, the process dies shortly after the log startup command, with a message such as the following appearing earlier in the output log: diff --git a/dactyl-config.yml b/dactyl-config.yml index 3fcd1f465d..03b411d799 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -1109,13 +1109,13 @@ pages: targets: - local - - md: tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md - html: rippled-1-3-0-migration-instructions.html + - md: tutorials/manage-the-rippled-server/installation/rippled-1-3-migration-instructions.md + html: rippled-1-3-migration-instructions.html funnel: Docs doc_type: Tutorials category: Manage the rippled Server subcategory: Installation - blurb: Use these instructions to upgrade rippled packages from 1.2.x or below to 1.3.0 or higher. + blurb: Use these instructions to upgrade rippled packages from 1.2.x or below to 1.3.x or higher. targets: - local From d1f69305c288c986b24e49083d25df7bf3b9b3c6 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 25 Jul 2019 15:46:12 -0700 Subject: [PATCH 19/19] Fix broken link to '1.3.0' migration instructions --- .../installation/update-rippled-manually-on-ubuntu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md index c9d21a80a3..d192050889 100644 --- a/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md +++ b/content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md @@ -2,7 +2,7 @@ This page describes how to update manually to the latest release of `rippled` on Ubuntu Linux. These instructions assume you have already [installed `rippled` using the native package](install-rippled-on-ubuntu.html). Ripple recommends setting up [automatic updates](update-rippled-automatically-on-linux.html) instead, where possible. -**Caution:** To upgrade from `rippled` 1.2.x to 1.3.1 or higher on Ubuntu Linux, you should follow the [1.3.1 migration instructions](rippled-1-3-0-migration-instructions.html). The following instructions assume you have already installed the native APT package provided with versions 1.3.1 and up. +**Caution:** To upgrade from `rippled` 1.2.x to 1.3.1 or higher on Ubuntu Linux, you should follow the [1.3.1 migration instructions](rippled-1-3-migration-instructions.html). The following instructions assume you have already installed the native APT package provided with versions 1.3.1 and up. **Tip:** To perform these steps all at once, you can run the `/opt/ripple/bin/update-rippled.sh` script, which is included with the `rippled` package and is compatible with Ubuntu and Debian starting with `rippled` version 1.3.1.