ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-28 07:35:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
CJ Cobb
2021-06-16 20:31:25 -04:00
committed by GitHub
parent e81cd009c2
commit 3acefe89a2
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -6,13 +6,18 @@ clio is designed to store historical ledger and transaction data in a more space
clio offers the full rippled API (this is still in development at the time of writing).
clio does not connect to the peer to peer network. clio extracts data from a specified rippled node. Running clio requires access to a rippled node
from which data can be extracted. clio can operate in read-only mode in the absence of a rippled node, where clio can answer RPC requests for the data it already has.
from which data can be extracted. The rippled node does not need to be running on the same machine as clio.
clio can operate in read-only mode in the absence of a rippled node, where clio can answer RPC requests for the data already in the database.
clio is designed with scalability and availability as a first principle. Data is stored in either Postgres or Cassandra,
and multiple clio servers can share access to the same dataset. The different clio servers do not know about each other or talk to each other.
Any synchronization happens via the data model at the database level.
clio servers can be added or removed in a matter of seconds in order to scale up or down.
The database itself can be scaled up or down as well.
clio is designed with scalability and availability as a first principle.
Data is stored in either Postgres or Cassandra,
and multiple clio servers can share access to the same dataset.
The different clio servers that are using the same dataset do not know about each other or talk to each other.
At any given time, there is only one writer, and any synchronization happens via the data model at the database level.
If the writer for a given dataset fails for any reason, one of the other clio nodes will become the writer.
This process is automatic.
The database itself can be scaled up or down as well, vertically or horizontally.
## Building
clio is built with cmake. clio requires c++20, and boost 1.75.0 (for boost json).
clio is built with cmake. clio requires c++20, and boost 1.75.0 (for boost json). clio includes rippled as a submodule.
Before building, run `git submodule update --init --recursive`