You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/infrastructure/installation/install-clio-on-ubuntu.md
+44-33Lines changed: 44 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,11 @@ labels:
10
10
11
11
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.
12
12
13
-
These instructions install a binary that has been compiled by Ripple. For instructions on how to build Clio from source, see the [Clio source code repository](https://github.com/XRPLF/clio).
13
+
These instructions install an Ubuntu package that has been compiled and published by Ripple. You can also:
14
+
15
+
- Download binaries, including for nightly and preview builds, from the [Clio releases page on GitHub](https://github.com/XRPLF/clio/releases/). (Expand the **Assets** section and choose the appropriate version for your OS.)
16
+
-[Build Clio from source](https://github.com/XRPLF/clio/blob/develop/docs/build-clio.md).
17
+
- Use a [Clio Docker Image](https://hub.docker.com/r/rippleci/clio).
14
18
15
19
16
20
## Prerequisites
@@ -19,9 +23,9 @@ Before you install Clio, you must meet the following requirements.
19
23
20
24
- Ensure that your system meets the [system requirements](system-requirements.md).
21
25
22
-
**Note:** Clio has the same system requirements as the `rippled` server, except Clio needs less disk space to store the same amount of ledger history.
23
-
24
-
- You need compatible versions of CMake and Boost. Clio requires C++20 and Boost 1.75.0 or higher.
26
+
{% admonition type="info" name="Note" %}
27
+
Clio has the same system requirements as the `rippled` server, except Clio needs less disk space to store the same amount of ledger history.
28
+
{% /admonition %}
25
29
26
30
- Access to a Cassandra cluster that is running locally or remote. You can choose to install and configure a Cassandra cluster manually by following the [Cassandra installation instructions](https://cassandra.apache.org/doc/latest/cassandra/getting_started/installing.html), or run Cassandra on a Docker container using one of the following commands.
27
31
@@ -49,7 +53,9 @@ Before you install Clio, you must meet the following requirements.
49
53
sudo apt -y update
50
54
```
51
55
52
-
**Tip:** If you have already installed an up-to-date version of `rippled` on the same machine, you can skip the following steps for adding Ripple's package repository and signing key, which are the same as in the `rippled` install process. Resume from step 5, "Fetch the Ripple repository."
56
+
{% admonition type="success" name="Tip" %}
57
+
If you have already installed an up-to-date version of `rippled` on the same machine, you can skip the following steps for adding Ripple's package repository and signing key, which are the same as in the `rippled` install process. Resume from step 6, "Fetch the Ripple repository."
58
+
{% /admonition %}
53
59
54
60
2. Install utilities:
55
61
@@ -84,7 +90,7 @@ Before you install Clio, you must meet the following requirements.
84
90
85
91
In particular, make sure that the fingerprint matches. (In the above example, the fingerprint is on the third line, starting with `C001`.)
86
92
87
-
4. Add the appropriate Ripple repository for your operating system version:
93
+
5. Add the appropriate Ripple repository for your operating system version:
@@ -93,29 +99,24 @@ Before you install Clio, you must meet the following requirements.
93
99
94
100
The above example is appropriate for **Ubuntu 20.04 Focal Fossa**.
95
101
96
-
5. Fetch the Ripple repository.
102
+
If you want access to development or pre-release versions, use one of the following instead of `stable`:
103
+
104
+
- `unstable` - Pre-release builds such as betas or release candidates
105
+
- `nightly` - Nightly development builds based on the [`develop` branch](https://github.com/XRPLF/Clio/tree/develop))
106
+
107
+
6. Fetch the Ripple repository.
97
108
98
109
```
99
110
sudo apt -y update
100
111
```
101
112
102
-
6. Install the Clio software package. There are two options:
103
-
104
-
- To run `rippled` on the same machine, install the `clio` package, which sets up both servers:
105
-
106
-
```
107
-
sudo apt -y install clio
108
-
```
109
-
110
-
- To run Clio on a separate machine from `rippled`, install the `clio-server` package, which sets up Clio only:
111
-
112
-
```
113
-
sudo apt -y install clio-server
114
-
```
115
-
116
-
7. If you are running `rippled` on a separate machine, modify your Clio config file to point to it. You can skip this step if you used the `clio` package to install both on the same machine.
113
+
7. Install the Clio software package.
117
114
115
+
```
116
+
sudo apt -y install clio
117
+
```
118
118
119
+
8. Modify your config files so that Clio can connect to your `rippled` server(s).
119
120
120
121
1. Edit the Clio server's config file to modify the connection information for the `rippled` server. The package installs this file at `/opt/clio/etc/config.json`.
121
122
@@ -124,25 +125,29 @@ Before you install Clio, you must meet the following requirements.
124
125
[
125
126
{
126
127
"ip":"127.0.0.1",
127
-
"ws_port":"6006",
128
+
"ws_port":"6005",
128
129
"grpc_port":"50051"
129
130
}
130
131
]
131
132
```
132
133
133
-
This includes:
134
+
Each entry in the `etl_sources` JSON array should contain the following fields:
134
135
135
-
- The IP of `rippled` server.
136
-
- The port where `rippled` accepts unencrypted WebSocket connections.
137
-
- The port where `rippled` accepts gRPC requests.
136
+
| Field | Type | Description |
137
+
|-------------|--------|-------------|
138
+
| `ip` | String | The IP address of the `rippled` server. |
139
+
| `ws_port` | String | The port where `rippled` accepts unencrypted (non-admin) WebSocket connections. The Clio server forwards some types of API requests to this port. |
140
+
| `grpc_port` | String | The port where `rippled` accepts gRPC requests. |
138
141
139
-
**Note** You can use multiple `rippled` servers as a data source by add more entries to the `etl_sources` section. If you do, Clio load balances requests across all the servers in the list, and can keep up with the network as long as at least one of the `rippled` servers is synced.
142
+
{% admonition type="info" name="Note" %}
143
+
You can use multiple `rippled` servers as a data source by adding more entries to the `etl_sources` section. If you do, Clio load balances requests across all the servers in the list, and can keep up with the network as long as at least one of the `rippled` servers is synced.
144
+
{% /admonition %}
140
145
141
-
The [example config file](https://github.com/XRPLF/clio/blob/develop/example-config.json) accesses the `rippled` server running on the local loopback network (127.0.0.1), with the WebSocket (WS) on port 6006 and gRPC on port 50051.
146
+
The [example config file](https://github.com/XRPLF/clio/blob/develop/docs/examples/config/example-config.json) accesses the `rippled` server running on the local loopback network (127.0.0.1), with the WebSocket (WS) on port 6005 and gRPC on port 50051.
142
147
143
148
2. Update the `rippled` server's config file to allow the Clio server to connect to it. The package installs this file at `/etc/opt/ripple/rippled.cfg`.
144
149
145
-
* Open a port to accept unencrypted WebSocket connections.
150
+
* Open a port to accept unencrypted, non-admin WebSocket connections.
146
151
147
152
```
148
153
[port_ws_public]
@@ -151,6 +156,10 @@ Before you install Clio, you must meet the following requirements.
151
156
protocol = ws
152
157
```
153
158
159
+
{% admonition type="warning" name="Caution" %}
160
+
Make sure your network firewall is configured not to forward outside requests on this port to your `rippled` server unless you intend to serve API requests to the general public.
161
+
{% /admonition %}
162
+
154
163
* Open a port to handle gRPC requests and specify the IP(s) of Clio server(s) in the `secure_gateway` entry.
155
164
156
165
```
@@ -160,15 +169,17 @@ Before you install Clio, you must meet the following requirements.
160
169
secure_gateway = 127.0.0.1
161
170
```
162
171
163
-
**Tip:** If you are not running Clio on the same machine as `rippled`, change the `secure_gateway` in the example stanza to use the IP address of the Clio server.
172
+
{% admonition type="warning" name="Caution" %}
173
+
If you are not running Clio on the same machine as `rippled`, change the `secure_gateway` in the example stanza to use the IP address of the Clio server.
0 commit comments