mirror of https://github.com/XRPLF/clio.git synced 2026-04-29 15:37:53 +00:00

Files

Ayaz Salikhov 7c55529c90 chore: Capitalize Dockerfile to add support of tools (#2045 )

For example, there is not syntax highlighting in GitHub, because file is
named `dockerfile` (and not Dockerfile), for example:
https://github.com/XRPLF/clio/blob/release/2.4.0/docker/ci/dockerfile

I also grep'ed dockerfile in repo and fixed some other places

2025-04-28 16:05:37 +01:00

Dockerfile

chore: Capitalize Dockerfile to add support of tools (#2045 )

2025-04-28 16:05:37 +01:00

README.md

style: Add prettier pre-commit hook (#2031 )

2025-04-25 16:24:45 +01:00

README.md

Clio official docker image

Clio is an XRP Ledger API server optimized for RPC calls over WebSocket or JSON-RPC. It stores validated historical ledger and transaction data in a space efficient format.

This image contains clio_server binary allowing users to run Clio easily.

Clio configuration file

Please note that while Clio requires a configuration file, this image doesn't include any default config. Your configuration file should be mounted under the path /opt/clio/etc/config.json. Clio repository provides an example of the configuration file.

Config file recommendations:

Set log_to_console to false if you want to avoid logs being written to stdout.
Set log_directory to /opt/clio/log to store logs in a volume.

Usage

The following command can be used to run Clio in docker (assuming server's port is 51233 in your config):

docker run -d -v <path to your config.json>:/opt/clio/etc/config.json -v <path to store logs>:/opt/clio/log -p 51233:51233 rippleci/clio