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