update documentation with info about RPC server

This commit is contained in:
Maxime Van Hees
2025-09-10 11:59:31 +02:00
parent 271c6cb0ae
commit 764fcb68fa
2 changed files with 101 additions and 0 deletions

View File

@@ -24,6 +24,12 @@ cargo build --release
./target/release/herodb --dir /path/to/db --port 6379
```
## RPC Server
HeroDB includes an optional JSON-RPC 2.0 management server for database administration tasks. Enable it with the `--enable-rpc` flag and specify the port with `--rpc-port` (default: 8080).
For a complete list of available RPC commands and usage examples, see [RPC_COMMANDS.md](RPC_COMMANDS.md).
### Options
- `--dir`: Database directory (required)
@@ -31,6 +37,8 @@ cargo build --release
- `--debug`: Enable debug logging
- `--encrypt`: Enable database encryption
- `--encryption-key`: Master encryption key for encrypted databases
- `--enable-rpc`: Enable RPC management server
- `--rpc-port`: RPC server port (default: 8080)
### Examples