From e610cf0a0d05019e11fd7dc9846ae801c35d388e Mon Sep 17 00:00:00 2001
From: kvazar-network <kvazar-network@project>
Date: Mon, 31 Mar 2025 15:26:47 +0300
Subject: [PATCH] add kevacoind configuration examples

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5d54ceb..85a4029 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,7 @@
-# KVAZAR Index Crawler
+# KVAZAR Crawler
+
+[Kevacoin](https://github.com/kvazar-network/kevacoin) blockchain crawler
+with full-text index storage in shared [Manticore](https://manticoresearch.com/) database (based on [Sphinx](https://sphinxsearch.com/)).
 
 ## Compatible
 
@@ -19,4 +22,48 @@
   * drop index: `php src/index.php drop`
   * optimize index: `php src/index.php optimize`
 
-_To prevent data lose on server failures, change default [binlog flush strategy](https://manual.manticoresearch.com/Logging/Binary_logging#Binary-flushing-strategies) to `binlog_flush = 1`_
\ No newline at end of file
+_To prevent data lose on server failures, change default [binlog flush strategy](https://manual.manticoresearch.com/Logging/Binary_logging#Binary-flushing-strategies) to `binlog_flush = 1`_
+
+### kevacoind
+
+Remote or local `kevacoind` connection required as the data source for this crawler.
+
+##### Requirements
+
+* RAM: 1.5G+
+* Disk: 2G+ (Kevacoin blockchain size in 2025)
+
+##### kevacoin.conf
+
+Before continue with examples, create new system user: `useradd -m kevacoin` and copy `kevacoind` compiled into its folder.
+
+To accept RPC connections, create `kevacoin.conf`:
+
+``` /home/kevacoin/.kevacoin/kevacoin.conf
+#/home/kevacoin/.kevacoin/kevacoin.conf
+rpcuser=USERNAME
+rpcpassword=PASSWORD
+```
+* make sure `config.json` corresponds `rpcuser` and `rpcpassword` values!
+
+##### systemd
+
+``` /etc/systemd/system/kevacoin.service
+#/etc/systemd/system/kevacoin.service
+[Unit]
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Type=simple
+User=kevacoin
+Group=kevacoin
+ExecStart=/home/kevacoin/kevacoind -server
+
+[Install]
+WantedBy=multi-user.target
+```
+
+* `systemctl daemon-reload` - apply `systemd` changes
+* `systemctl enable kevacoin` - enable on system startup
+* `systemctl start kevacoin` - launch `kevacoind`
\ No newline at end of file