Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Thumbs.db

# Local data directories (RocksDB, archive segments, etc.)
data/
segments/

# Local code-review artifacts
reviews/
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 5 additions & 7 deletions pensieve-local/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down