Skip to content

Update installation supported OSes #3190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 22, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ top_nav_grouping: 人気ページ

そしてAPIコールを効率的に処理し、P2Pモードで動作している`rippled`サーバの負荷を軽減することができます。

[{% inline-svg file="/docs/img/reporting-mode-basic-architecture.svg" /%}](/docs/img/reporting-mode-basic-architecture.svg "図 1: レポートモードでの`rippled`の動作")

`rippled`のレポートモードでは2種類のデータストアを使用します。

* トランザクションのメタデータ、アカウントの状態、レジャーのヘッダーを含む`rippled`のプライマリ永続データストア。プライマリ永続データストアとしてNuDB(ソースに付属)または[Cassandra](https://cassandra.apache.org/)を使用できます。Cassandraを使用する場合、複数のレポートモードサーバが単一のCassandraインスタンスまたはクラスター内のデータへのアクセスを共有できます。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ labels:

Linuxでは、`rippled`が1回限りの`cron`構成を使用して最新バージョンに自動的にアップグレードされるように設定できます。可能であれば自動更新を有効にしておくことが推奨されます。

以下の手順では、`rippled`が[`yum`リポジトリから(CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.md)、または[`apt`(Ubuntu/Debian)を使用して](install-rippled-on-ubuntu.md)インストールされていることを前提としています。
以下の手順では、`rippled`が[`yum`リポジトリから(CentOS/RedHat)](install-rippled-on-rhel.md)、または[`apt`(Ubuntu/Debian)を使用して](install-rippled-on-ubuntu.md)インストールされていることを前提としています。

自動更新を設定するには、以下の手順に従います。

1. `/opt/ripple/etc/update-rippled-cron`が存在することを確認します。存在しない場合は、([CentOS/Red Hat](update-rippled-manually-on-centos-rhel.md)または[Ubuntu/Debian](update-rippled-manually-on-ubuntu.md)を)手動で更新します。
1. `/opt/ripple/etc/update-rippled-cron`が存在することを確認します。存在しない場合は、([CentOS/Red Hat](update-rippled-manually-on-rhel.md)または[Ubuntu/Debian](update-rippled-manually-on-ubuntu.md)を)手動で更新します。

2. `cron.d`フォルダーに、`/opt/ripple/etc/update-rippled-cron`構成ファイルへのsymlinkを作成します。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ labels:

このページでは、CentOSまたはRed Hat Enterprise Linuxで最新リリースの`rippled`に手動で更新する手順を説明します。可能であれば手動更新ではなく[自動更新](update-rippled-automatically-on-linux.md)を設定することが推奨されます。

以下の手順は、[`rippled`がすでに`yum`リポジトリからインストール](install-rippled-on-centos-rhel-with-yum.md)されていることを前提としています。
以下の手順は、[`rippled`がすでに`yum`リポジトリからインストール](install-rippled-on-rhel.md)されていることを前提としています。

{% admonition type="success" name="ヒント" %}これらの手順をすべて一度に実行するには、`rippled`パッケージに含まれている`/opt/ripple/bin/update-rippled.sh`スクリプトを実行します。このスクリプトは`sudo`ユーザとして実行する必要があります。{% /admonition %}

Expand Down
1 change: 0 additions & 1 deletion docs/img/reporting-mode-basic-architecture.svg

This file was deleted.

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions docs/infrastructure/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ seo:
---
# Installation

Install and update XRP Ledger servers including the core server, rippled, and API server, Clio.

Install and update the core XRP Ledger server (`rippled`) or the API server (Clio).

{% child-pages /%}
6 changes: 3 additions & 3 deletions docs/infrastructure/installation/install-clio-on-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ labels:
---
# Install Clio on Ubuntu Linux

This page describes the recommended instructions for installing the latest stable version of Clio on **Ubuntu Linux 20.04 or higher** using the [`apt`](https://ubuntu.com/server/docs) utility.
This page describes the recommended instructions for installing the latest stable version of Clio on **Ubuntu Linux 22.04 or higher** using the [`apt`](https://ubuntu.com/server/docs) utility.

These instructions install an Ubuntu package that has been compiled and published by Ripple. You can also:

Expand Down Expand Up @@ -93,11 +93,11 @@ Before you install Clio, you must meet the following requirements.
5. Add the appropriate Ripple repository for your operating system version:

```
echo "deb [signed-by=/usr/local/share/keyrings/ripple-key.gpg] https://repos.ripple.com/repos/rippled-deb focal stable" | \
echo "deb [signed-by=/usr/local/share/keyrings/ripple-key.gpg] https://repos.ripple.com/repos/rippled-deb noble stable" | \
sudo tee -a /etc/apt/sources.list.d/ripple.list
```

The above example is appropriate for **Ubuntu 20.04 Focal Fossa**.
The above example is appropriate for **Ubuntu 24.04 Noble Numbat**.

If you want access to development or pre-release versions, use one of the following instead of `stable`:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
---
html: install-rippled-on-centos-rhel-with-yum.html
parent: install-rippled.html
seo:
description: Install a precompiled rippled binary on CentOS or Red Hat Enterprise Linux.
description: Install a precompiled rippled binary on Red Hat Enterprise Linux.
labels:
- Core Server
---
# Install on CentOS/Red Hat with yum
# Install on Red Hat Enterprise Linux

This page describes the recommended instructions for installing the latest stable version of `rippled` on **CentOS 7** or **Red Hat Enterprise Linux 7**, using Ripple's [yum](https://en.wikipedia.org/wiki/Yellowdog_Updater,_Modified) repository.

These instructions install a binary that has been compiled by Ripple.
This page describes the recommended instructions for installing the latest stable version of `rippled` on **Red Hat Enterprise Linux**, using a binary that has been compiled and published by Ripple as an `rpm` package.

Currently, **Red Hat Enterprise Linux (RHEL) 9.6 is supported on x86_64 processors**. You may also be able to adapt these instructions to similar Linux distributions including CentOS or Rocky Linux, but other configurations are not officially supported.

## Prerequisites

Expand Down
15 changes: 4 additions & 11 deletions docs/infrastructure/installation/install-rippled-on-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ labels:
---
# Install on Ubuntu or Debian Linux

This page describes the recommended instructions for installing the latest stable version of `rippled` on **Ubuntu Linux 18.04 or higher** or **Debian 10 or higher**, using the [`apt`](https://ubuntu.com/server/docs) utility.
This page describes the recommended instructions for installing the latest stable version of `rippled` on **Ubuntu Linux**, using a binary that has been compiled and published by Ripple as a `deb` package.

These instructions install a binary that has been compiled by Ripple.
Currently, **Ubuntu 22.04 and Ubuntu 24.04 on x86_64 processors** have received the highest level of support and testing. Packages are also available for **Debian Linux 12 Bookworm**. You may be able to adapt these instructions to other Linux distributions that also use the `apt` package manager, but other configurations are not officially supported.


## Prerequisites
Expand Down Expand Up @@ -40,7 +40,6 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
sudo gpg --dearmor -o /etc/apt/keyrings/ripple.gpg
```


4. Check the fingerprint of the newly-added key:

```
Expand All @@ -56,22 +55,19 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
sub rsa3072 2019-02-14 [E] [expires: 2026-02-17]
```


In particular, make sure that the fingerprint matches. (In the above example, the fingerprint is on the second line, starting with `C001`.)

5. Add the appropriate Ripple repository for your operating system version:

```
echo "deb [signed-by=/etc/apt/keyrings/ripple.gpg] https://repos.ripple.com/repos/rippled-deb focal stable" | \
echo "deb [signed-by=/etc/apt/keyrings/ripple.gpg] https://repos.ripple.com/repos/rippled-deb noble stable" | \
sudo tee -a /etc/apt/sources.list.d/ripple.list
```

The above example is appropriate for **Ubuntu 20.04 Focal Fossa**. For other operating systems, replace the word `focal` with one of the following:
The above example is appropriate for **Ubuntu 24.04 Noble Numbat**. For other operating systems, replace the word `noble` with one of the following:

- `buster` for **Debian 10 Buster**
- `bullseye` for **Debian 11 Bullseye**
- `bookworm` for **Debian 12 Bookworm**
- `bionic` for **Ubuntu 18.04 Bionic Beaver**
- `jammy` for **Ubuntu 22.04 Jammy Jellyfish**
- `noble` for **Ubuntu 24.04 Noble Numbat**

Expand All @@ -88,7 +84,6 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
sudo apt -y update && sudo apt -y install rippled
```


7. Check the status of the `rippled` service:

```
Expand All @@ -101,7 +96,6 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
sudo systemctl start rippled.service
```


8. Optional: allow `rippled` to bind to privileged ports.

This allows you to serve incoming API requests on port 80 or 443. (If you want to do so, you must also update the config file's port settings.)
Expand All @@ -110,7 +104,6 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
sudo setcap 'cap_net_bind_service=+ep' /opt/ripple/bin/rippled
```


9. Optional: configure core dumps

By default Ubuntu is not configured to produce core files useful for debugging crashes.
Expand Down
129 changes: 0 additions & 129 deletions docs/infrastructure/installation/rippled-1-3-migration-instructions.md

This file was deleted.

9 changes: 5 additions & 4 deletions docs/infrastructure/installation/system-requirements.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
html: system-requirements.html
parent: install-rippled.html
seo:
description: Hardware and software requirements for running rippled.
description: Hardware and software requirements for running rippled or Clio.
labels:
- Core Server
---
# System Requirements

The following system requirements apply to both the core XRP Ledger server, `rippled`, and the Clio server for API access.

## Recommended Specifications

For reliable performance in production environments, it is recommended to run an XRP Ledger (`rippled`) server on bare metal with the following characteristics or better:
For reliable performance in production environments, it is recommended to run a server on bare metal with the following characteristics or better:

- Operating System: Ubuntu (LTS), Red Hat Enterprise Linux (latest release), or a compatible Linux distribution.
- CPU: 3+ GHz 64-bit x86_64 processor with 8+ cores.
Expand All @@ -28,6 +28,7 @@ For testing purposes, you can run an XRP Ledger server on commodity hardware wit

- Operating System: macOS, Windows (64-bit), or most Linux distributions (Red Hat, Ubuntu, and Debian supported).
- CPU: 64-bit x86_64, 4+ cores.
- For development purposes, is also possible to compile `rippled` for some Apple Silicon or ARM processors. See the [Build instructions](https://github.com/XRPLF/rippled/blob/develop/BUILD.md) for guidance. However, architectures other than x86_64 are not officially supported and are not recommended for production.
- Disk: SSD / NVMe (10,000 IOPS sustained - not burst or peak - or better). Minimum 50 GB for the database partition. Do not use Amazon Elastic Block Store (AWS EBS) because its latency is too high to sync reliably.
- RAM: 16 GB+.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
html: update-rippled-automatically-on-linux.html
parent: install-rippled.html
seo:
description: Set up automatic updates for rippled on Linux.
labels:
Expand All @@ -9,21 +7,21 @@ labels:
---
# 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.
On Linux, you can set up `rippled` to automatically upgrade to the latest version with a one-time `cron` configuration.

These instructions assume you have already installed `rippled` [from the `yum` repository (CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.md) or [using `apt` (Ubuntu/Debian)](install-rippled-on-ubuntu.md).
These instructions assume you have already installed `rippled` from a package on [Red Hat Enterprise Linux](install-rippled-on-rhel.md), [Ubuntu Linux, or Debian Linux](install-rippled-on-ubuntu.md).

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.md) or [Ubuntu/Debian](update-rippled-manually-on-ubuntu.md)).
1. Check that `/opt/ripple/etc/update-rippled-cron` exists. If it does not, update manually ([Red Hat](update-rippled-manually-on-rhel.md) or [Ubuntu/Debian](update-rippled-manually-on-ubuntu.md)).

2. Create a symlink in your `cron.d` folder to the `/opt/ripple/etc/update-rippled-cron` config file:

```
sudo ln -s /opt/ripple/etc/update-rippled-cron /etc/cron.d/
```

This configuration runs a script to update the installed `rippled` package within an hour of each new release. To avoid network instability from too many servers updating at the same time, this script does not automatically restart the server, so it continues to run the old version until it restarts. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.8.1" %}Updated in: rippled 1.8.1{% /badge %}
This configuration runs a script to update the installed `rippled` package within an hour of each new release. To avoid network instability from too many servers updating at the same time, this script does not automatically restart the server, so it continues to run the old version until it restarts.

3. **Whenever a new release comes out,** you must manually restart the `rippled` service to switch to the updated software.

Expand Down
Loading