diff --git a/.gitignore b/.gitignore index b72af20..9a51264 100644 --- a/.gitignore +++ b/.gitignore @@ -23,6 +23,7 @@ Thumbs.db # Local data directories (RocksDB, archive segments, etc.) data/ +segments/ # Local code-review artifacts reviews/ diff --git a/README.md b/README.md index 97145f9..7c9230b 100644 --- a/README.md +++ b/README.md @@ -171,6 +171,15 @@ Import events from length-delimited protobuf files. Supports local files or S3 w | `--temp-dir` | system | Temp directory for S3 downloads | | `--metrics-port` | `9091` | Prometheus metrics port | +## Prerequisites + +- **Rust** ≥ 1.90 (edition 2024) — `rustup update stable` +- **protoc** (Protocol Buffers compiler) — required by the `pensieve-core` build script + - Debian/Ubuntu: `sudo apt-get install protobuf-compiler` + - macOS: `brew install protobuf` +- **just** — task runner for all dev commands (`cargo install just`) +- **Docker + Docker Compose** — for local infrastructure (ClickHouse, Prometheus, Grafana) + ## Quick Start ```bash diff --git a/justfile b/justfile index b16a83d..ea53a29 100644 --- a/justfile +++ b/justfile @@ -124,6 +124,10 @@ doc-open: # Start local dev services (ClickHouse, etc.) dev-up: + # Ensure relay-stats.db exists as a file before Docker mounts it, + # otherwise Docker creates it as a root-owned directory. + mkdir -p data + touch data/relay-stats.db docker compose -f pensieve-local/docker-compose.yml up -d # Stop local dev services diff --git a/pensieve-local/README.md b/pensieve-local/README.md index 0804e7c..1faf5cf 100644 --- a/pensieve-local/README.md +++ b/pensieve-local/README.md @@ -10,17 +10,15 @@ Local Docker environment for developing and testing Pensieve. ## Quick Start ```bash -# From this directory -cd pensieve-local - -# Start all services -docker compose up -d +# From the repo root — ensures data/relay-stats.db exists as a file before +# Docker mounts it (otherwise Docker creates it as a root-owned directory) +just dev-up # Check status -docker compose ps +cd pensieve-local && docker compose ps # View logs -docker compose logs -f +just dev-logs ``` ## Services