example-config.json

/*
 * This is an example configuration file. Please do not use without modifying to suit your needs.
 */
{
  "database": {
    "type": "cassandra",
    "cassandra": {
      "contact_points": "127.0.0.1",
      "port": 9042,
      "keyspace": "clio",
      "replication_factor": 1,
      "table_prefix": "",
      "max_write_requests_outstanding": 25000,
      "max_read_requests_outstanding": 30000,
      "threads": 8,
      //
      // Advanced options. USE AT OWN RISK:
      // ---
      "core_connections_per_host": 1, // Defaults to 1
      "write_batch_size": 20 // Defaults to 20
      //
      // Below options will use defaults from cassandra driver if left unspecified.
      // See https://docs.datastax.com/en/developer/cpp-driver/2.17/api/struct.CassCluster/ for details.
      //
      // "queue_size_io": 2
      //
      // ---
    }
  },
  "allow_no_etl": false, // Allow Clio to run without valid ETL source, otherwise Clio will stop if ETL check fails
  "etl_sources": [
    {
      "ip": "127.0.0.1",
      "ws_port": "6006",
      "grpc_port": "50051"
    }
  ],
  "forwarding": {
    "cache_timeout": 0.25, // in seconds, could be 0, which means no cache
    "request_timeout": 10.0 // time for Clio to wait for rippled to reply on a forwarded request (default is 10 seconds)
  },
  "rpc": {
    "cache_timeout": 0.5 // in seconds, could be 0, which means no cache for rpc
  },
  "dos_guard": {
    // Comma-separated list of IPs to exclude from rate limiting
    "whitelist": ["127.0.0.1"],
    //
    // The below values are the default values and are only specified here
    // for documentation purposes. The rate limiter currently limits
    // connections and bandwidth per IP. The rate limiter looks at the raw
    // IP of a client connection, and so requests routed through a load
    // balancer will all have the same IP and be treated as a single client.
    //
    "max_fetches": 1000000, // Max bytes per IP per sweep interval
    "max_connections": 20, // Max connections per IP
    "max_requests": 20, // Max connections per IP per sweep interval
    "sweep_interval": 1 // Time in seconds before resetting max_fetches and max_requests
  },
  "server": {
    "ip": "0.0.0.0",
    "port": 51233,
    // Max number of requests to queue up before rejecting further requests.
    // Defaults to 1000 (use 0 to make the queue unbound).
    "max_queue_size": 500,
    // If request contains header with authorization, Clio will check if it matches the prefix 'Password ' + this value's sha256 hash
    // If matches, the request will be considered as admin request
    "admin_password": "xrp",
    // If local_admin is true, Clio will consider requests come from 127.0.0.1 as admin requests
    // It's true by default unless admin_password is set,'local_admin' : true and 'admin_password' can not be set at the same time
    "local_admin": false,
    "processing_policy": "parallel", // Could be "sequent" or "parallel".
    // For sequent policy request from one client connection will be processed one by one and the next one will not be read before
    // the previous one is processed. For parallel policy Clio will take all requests and process them in parallel and
    // send a reply for each request whenever it is ready.
    "parallel_requests_limit": 10, // Optional parameter, used only if "processing_strategy" is "parallel". It limits the number of requests for one client connection processed in parallel. Infinite if not specified.
    // Max number of responses to queue up before sent successfully. If a client's waiting queue is too long, the server will close the connection.
    "ws_max_sending_queue_size": 1500,
    "__ng_web_server": false, // Use ng web server. This is a temporary setting which will be deleted after switching to ng web server
    "proxy": {
      "ips": [],
      "tokens": []
    }
  },
  // Time in seconds for graceful shutdown. Defaults to 10 seconds. Not fully implemented yet.
  "graceful_period": 10.0,
  "log": {
    // Overrides log level on a per logging channel.
    // Defaults to global "log.level" for each unspecified channel.
    "channels": [
      {
        "channel": "Backend",
        "level": "fatal"
      },
      {
        "channel": "WebServer",
        "level": "info"
      },
      {
        "channel": "Subscriptions",
        "level": "info"
      },
      {
        "channel": "RPC",
        "level": "error"
      },
      {
        "channel": "ETL",
        "level": "debug"
      },
      {
        "channel": "Performance",
        "level": "trace"
      }
    ],
    // The general logging level of Clio. This level is applied to all log channels that do not have an explicitly defined logging level.
    "level": "info",
    // Log format using spdlog format patterns (this is the default format)
    "format": "%Y-%m-%d %H:%M:%S.%f %^%3!l:%n%$ - %v",
    // Whether spdlog is asynchronous or not.
    "is_async": true,
    // Enables or disables logging to the console.
    "enable_console": true,
    // Clio logs to file in the specified directory only if "log.directory" is set
    // "directory": "./clio_log",
    // The log rotation size in megabytes. When the log file reaches this particular size, a new log file starts.
    "rotation_size": 2048,
    // The maximum number of log files in the directory.
    "directory_max_files": 25,
    // Log tags style to use
    "tag_style": "uint"
  },
  "cache": {
    // Configure this to use either "num_diffs", "num_cursors_from_diff", or "num_cursors_from_account". By default, Clio uses "num_diffs".
    "num_diffs": 32, // Generate the cursors from the latest ledger diff, then use the cursors to partition the ledger to load concurrently. The cursors number is affected by the busyness of the network.
    // "num_cursors_from_diff": 3200, // Read the cursors from the diff table until we have enough cursors to partition the ledger to load concurrently.
    // "num_cursors_from_account": 3200, // Read the cursors from the account table until we have enough cursors to partition the ledger to load concurrently.
    "num_markers": 48, // The number of markers is the number of coroutines to load the cache concurrently.
    "page_fetch_size": 512, // The number of rows to load for each page.
    "load": "async", // "sync" to load cache synchronously  or "async" to load cache asynchronously or "none"/"no" to turn off the cache.
    "file": {
      "path": "./cache.bin",
      "max_sequence_age": 5000
    }
  },
  "prometheus": {
    "enabled": true,
    "compress_reply": true
  },
  "extractor_threads": 8,
  "read_only": false,
  // "start_sequence": [integer] the ledger index to start from,
  // "finish_sequence": [integer] the ledger index to finish at,
  // "ssl_cert_file" : "/full/path/to/cert.file",
  // "ssl_key_file" : "/full/path/to/key.file"
  "api_version": {
    "min": 1, // Minimum API version supported (could be 1 or 2)
    "max": 2, // Maximum API version supported (could be 1 or 2, but >= min)
    "default": 1 // Clio behaves the same as rippled by default
  }
}