mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-28 23:55:49 +00:00
rippled 1.3.0 install instructions (DRAFT)
This commit is contained in:
mDuo13
@@ -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
|
||||
|
||||
@@ -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
|
||||
@@ -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)
|
||||
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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).
|
||||
|
||||
@@ -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.)
|
||||
|
||||
Reference in New Issue
Block a user